5G Video Notifications

 

Pre-requisites

Prior to interacting with any of the Alef APIs for the Video Notification Product, the developer must have completed the following:

  • Creation of an Alef Developer Portal Account
  • Subscription to the Alef Video Notification Product
  • Configuration of the Alef Video Notification Product

If there is any confusion as to how to complete these tasks. Please refer to the following document for instruction, https://developer.alefedge.com/get-started/create-edge-native-services/user-guide/ . If these three things have been completed, interaction with Alef Video Notification APIs can begin. If there is any question as to how to update these scripts, please view the 5G Video Notification API Usage Document found here, https://developer.alefedge.com/reference-docs/edgenet-developer-portal/service-usage-docs/api-usage-5g-video-notifications/.

Onboard Content

Request

curl -X 'POST' 'https://<domain>/rmn-api/api/v1/rmn/agencies/campaignsOps?partner_name=<partner_name>' -H 'accept: application/json' -H 'api_key: XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX' -H 'Content-Type: multipart/form-data' -F 'campaignStartDate=2021-04-20T12:50:00' -F 'callToActionUrl=' -F 'is360=true' -F 'callToActionDuration=small' -F 'preferenceData=' -F 'smsText=' -F 'brandUrl=https://www.wikipedia.org/' -F 'campaignTitle=www' -F 'campaignDescription=www' -F 'thumbnail=@/home/test/Downloads/test.jpeg;type=image/jpeg' -F 'callToActionFrequency=2' -F 'callToActionButtonText=eee' -F 'defaultTabPreference=' -F 'videoDuration=' -F 'is_campaign_approve=' -F 'contentType=Video' -F 'isAutoRedirect=true' -F 'chatUrl=https://www.wikipedia.org/' -F 'timeZone=5.5' -F 'content=@/home/test/Downloads/test.mp4;type=video/mp4' -F 'token=' -F 'numberOfSms=2' -F 'campaignEndDate=2021-05-19T16:40:00' -F 'campaignName=fintestdt' -F 'channelType=SMS' -F 'isLastSlot=true'

Response

{
   "message": "Campaign onboarding successful. Please check status of campaign dryrun"
}

Get All Content

Request

curl --location --request GET 'https://<domain>/rmn-api/api/v1/rmn/agencies/campaignsOps?partner_name=<partner_name>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'api_key: XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX' \
--data-raw ''

Response

[
   {
       "campaign_name": "dryrun",
       "status": "Scheduled",
       "approval_status": "true",
       "start_timestamp": "2021-02-27T07:35:00.000Z",
       "end_timestamp": "2021-03-31T07:35:00.000Z"
   }
]

Get Campaign Status

Request

curl --location --request GET 'https://<domain>/rmn-api/api/v1/rmn/agencies/campaigns/status/<campaign_name>?partner_name=<partner_name>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'api_key: XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX' \
--data-raw ''

Response

{
   "campaign_name": "dryrun",
   "status": "Scheduled",
   "approval_status": "true"
}

Get Campaign Charts

Request

curl --location --request GET 'https://<domain>/rmn-api/api/v1/rmn/agencies/campaignChart?partner_name=<partner_name>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'api_key: XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX' \
--data-raw ''

Response

[
   {
       "campaign_name": "dryrun",
       "video_id": "mb",
       "status": "Scheduled",
       "start_timestamp": "2021-02-27T07:35:00.000Z",
       "end_timestamp": "2021-03-31T07:35:00.000Z",
       "renewButton": true,
       "url": "https://<domain>/v1/content?url=e95897528ae5e3d602a078698c1e8babc4d749fed243aa9af335e4f37e5838f918d370fd845f1c2c50540ece14afe33f"
   }
]

How useful was this post?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?