1. Home
  2. Docs
  3. SMS Notification API
  4. Principles & Description

Principles & Description

Principles

Bizao provide you a free SMS-Bundle to let you notify your end user using our SMS Notification API. To notify the end-user, you need first to generate the user bizao-token and bizao-alias (see athentication methods section).

Description

To notify your end-user by SMS you will use:

  • Bizao-URI: smsmessaging/v1/outbound/tel%3A%2Bxxxxx/requests where tel%3A%2Bxxxxx is your senderAddress value in url encode format.
    • Sample: tel%3A%2B2250000”
  • Bizao-Host: api.bizao.com

The query will contain the Headers set to the specified value below:

Header Description/Content
x-oapi-application-id always  use: BIZAO
x-oapi-contact-id always  use: b2b-bizao-97b5878
x-oapi-resource-type always  use:  SMS_OSM
bizao-alias BIZAO_ALIAS generated using one of the authentication method above
bizao-token BIZAO_TOKEN generated using one of the authentication method above
x-orange-mco Oxx (where xx is an alpha2 country code. You can use this site to got this code: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
authorization YOUR_ACCESS_TOKEN

The body of your query will contain the parameters below:

Parameter Usage Description
address MandatoryAlways use: acr:X-Orange-ISE2
message MandatoryString, must be URL-escaped as per RFC 1738.
senderAddress Mandatory String, please see the table below “API-SMS parameter values by authorized country”. In the URL, it must be URL encoded
SenderName Mandatory Firendly name displayed on end user device (11 characters maximum)
clientCorrelator Mandatory String, must be unique. It identifies this request. This will be useful in case of communication failure while sending the request. By using the same clientCorrelator when retrying the request, Bizao will avoid sending the same SMS again.
receiptRequestOptional String, the notification url to which you need to receive the delivery confirmation. The format of this notification is shown below. If notifications are required the notification url parameter will be sent within the receiptRequest element. Please note that this feature is currently not available. It will be operational in the next version of the API.
callbackData Optional This data will be passed back in this notification url. It’s used to identify the message the receipt relates to (or any other useful data, such as a function name). This is only valid if notifications are required – sent with the notification url parameter within the receiptRequest element.

Note:For more detail you can see swagger file: "BIZAO-SMS_V1_swagger.yaml"

SMS Notification query sample:

curl -X POST \
https://api.bizao.com/smsmessaging/v1/outbound/tel%3A%2B2250000/requests \
-H 'authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'bizao-token: BIZAO_TOKEN' \
-H 'x-oapi-application-id: BIZAO' \
-H 'x-oapi-contact-id: b2b-bizao-97b5878' \
-H 'x-oapi-resource-type: SMS_OSM' \
-H 'bizao-alias: BIZAO_ALIAS' \
-H 'x-orange-mco: OCI' \
-d '{
"outboundSMSMessageRequest": {
"address": ["acr:X-Orange-ISE2"],
"senderAddress": "tel:+2250000",
"outboundSMSTextMessage": {
"message": "Welcome SMS"
},
"clientCorrelator": "MyCorrealtorID",
"receiptRequest": {
"notifyURL": "http://application.example.com/notifications/DeliveryInfoNotification",
"callbackData": "some-data-useful-to-the-requester"
},
"senderName": "nameToDisplay"
}
}

SMS Notification successful response:

{
"outboundSMSMessageRequest": {
"address": [
"acr:X-Orange-ISE2"
],
"senderAddress": "tel:+2250000",
"senderName": "nameToDisplay",
"receiptRequest": {
"notifyURL": "http://application.example.com/notifications/DeliveryInfoNotification",
"callbackData": "some-data-useful-to-the-requester"
},
"outboundSMSTextMessage": {
"message": "Welcome SMS"
},
"clientCorrelator": "MyCorrelatorID ",
"resourceURL": "https://gateway1a.mife.sla-mobile.com.my:8243/smsmessaging/outbound/tel%3A%2B2250000/requests/1529584291923SM8202/deliveryInfos"
}
}

Note:

for each new SMS-Query you have to provide a new “clientCorrelator” value

API-SMS parameter values by authorized country

Below a recap of specific API-SMS parameter value by authorised country:

Country MCO senderAddress
Ivory-Coast OCI tel:+2250000
RDCongo  ODC tel:+2430000
Cameroon OCM tel:+2370000
Senegal OSN tel:+2210000
Tunisia OTN tel:+2160000
Was this article helpful to you? Yes 2 No

How can we help?