Table of Contents

SMS MT Notification API

You are here:
< All API Documentations

1. Principles

Bizao provides you with a free SMS-Bundle to let you notify your end user using the SMS API.
To notify the end_user, youfirst need to generate the user’s bizao-token and bizao-alias
using one of three authentication mechanims described previously.

1. 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 sender-address 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 :

HeaderDescription/Content
X-OAPI-Application-Idalways use: BIZAO
X-OAPI-Contact-Idalways use: b2b-bizao-97b5878
X-OAPI-Resource-Typealways use: SMS_OSM
bizao-aliasBIZAO_ALIAS generated using one of the authentication
method above (ise2 in this current version of
authentication)
bizao-tokenBIZAO_TOKEN generated using one of the
authentication method above. (OrangeApiToken in this
current version of authentication)
X-Orange-MCOOxx (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
AuthorizationYOUR_ACCESS_TOKEN

The body of your query will contain the parameters below :

ParameterDescriptionUsage
addressRecipient user ID is a key in the header
which contains the end user alias to use.
Authorized values are:
o acr:X-Orange-ISE2 for the header
X-Orange-ISE2
Mandatory, unique
messageString, must be URL-escaped as per RFC
1738 and not longer than 160 characters.
Mandatory
senderAddress (*)String, see Mandatory
SenderNameString, Uniquely identifies this created SMS
request. This will be useful in communication
String, failures while sending the request. By
using the same clientCorrelator when
retrying the request WSO2.TELCO HUB avoids
sending the same SMS again
Mandatory
clientCorrelatorString, Uniquely identifies this created SMS
request. This will be useful in communication
String, failures while sending the request. By
using the same clientCorrelator when
retrying the request WSO2.TELCO HUB avoids
sending the same SMS again.
Mandatory
receiptRequestnotifyURL: Strnig, The URL to which you would
like a notification of delivery sent. The format
of this notification is shown below. If
notifications are required the notifyURL
parameter will be sent within the
receiptRequest element
Optional
callbackDatacallbackData: Will be passed back in this
notification. 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 notifyURL parameter within the
receiptRequest element
Optional

Note : For more detail you can see the swagger file: “BIZAO-SMS_V1_swagger.yaml”.

SMS Notification query sample :

curl --location --request POST
'https://api.bizao.com/smsmessaging/v1/outbound/tel%3A%2B2210000/requests' \
--header 'authorization: Bearer Your_Access_Token' \
--header 'bizao-alias: Bizao_Alias' \
--header 'bizao-token: Bizao_Token' \
--header 'content-type: application/json' \
--header 'x-oapi-application-id: BIZAO' \
--header 'x-oapi-contact-id: b2b-bizao' \
--header 'x-oapi-resource-type: SMS_OSM' \
--header 'x-orange-mco: OSN' \
--header 'Cookie: SERVERID=s1' \
--data-raw '{
"outboundSMSMessageRequest": {
"address": ["acr:X-Orange-ISE2"],
"senderAddress": "tel:+2210000",
"outboundSMSTextMessage": {
"message": " Votre abonnement a réussi."
},
"senderName": "BIZAO"
}
}'

Note : for each new SMS-Query you have to provide a new “clientCorrelator” value SMS
Notification succefull response

{
"outboundSMSMessageRequest": {
"address": [
"acr:X-Orange-ISE2"
],
"senderAddress": "tel:+2210000",
"senderName": "BIZAO",
"receiptRequest": {
"notifyURL": "http://application.example.com/notifications/DeliveryInfoNotification",
"callbackData": "some-data-useful-to-the-requester"
},
"outboundSMSTextMessage": {
"message": " Votre abonnement a réussi. "
},
"clientCorrelator": "MyCorrealtorID ",
"resourceURL": "https://gateway1a.mife.sla-
mobile.com.my:8243/smsmessaging/outbound/tel%3A%2B2210000/requests/1529584291923SM8202/
deliveryInfos"
}
}

3. Recap of API-SMS parameter value by authorized country

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

CountryMCOsenderAddress
Ivory-
Coast
OCItel:+2250000
RDCongoODCtel:+2430000
CameroonOCMtel:+2370000
SenegalOSNtel:+2210000
TunisiaOTNtel:+2160000
Burkina
faso
OBFTel:+2260000

4. Notification error codes

Error CodeException TextVariablesHTTP Code and
status
SVC0280Message too long.
Maximum length is
%1 characters
%1 – number of characters
allowed in a message
400 Bad request
900908Resource forbiddennone403 Forbidden

5. SMS API internal error codes

internalOutput mapping
Error codeDescriptionError codeError variables
PDK_SMSW_0001Internal errorSVC0001%1: PDK_SMSW_0001
PDK_SMSW_0002Integration errorSVC0001%1: PDK_SMSW_0002
PDK_SMSW_0003Unavailable countrySVC0004%1: senderAddress value
PDK_SMSW_0004Duplicate client correlatorSVC0005%1: clientCorrelator value
%2: TBD
PDK_SMSW_0005Missing input valueSVC0002%1: missing value
PDK_SMSW_0006Invalid sender addressSVC0004%1: senderAddress value
PDK_SMSW_0007Invalid recipient addressSVC0004%1: address value
PDK_SMSW_0008Message too longSVC0280%1: max message length
PDK_SMSW_0009Invalid input valueSVC0002%1: invalid value
PDK_SMSW_0011BE-API is unresponsiveSVC0001%1: PDK_SMSW_0011
PDK_SMSW_0013SDP GOS is unresponsiveSVC0001%1: PDK_SMSW_0013
PDK_SMSW_1000BE-API internal errorSVC0001%1: PDK_SMSW_1000
PDK_SMSW_1001Resource consumption
failure: not authorized [%1]
POL0001%1: Not enough credit
PDK_SMSW_1002Resource consumption failure:
invalid parameter
POL0001%1: No contract found for
the given country /
service / contact
PDK_SMSW_1003Resource consumption
failure: not authorized [%1]
POL0001%1: Expired contract
PDK_SMSW_1004Resource consumption
failure: unknown transaction
ID
SVC0001%1: PDK_SMSW_1004
PDK_SMSW_3000SDP GOS internal errorSVC0001%1: PDK_SMSW_3000
PDK_SMSW_3001SDP GOS SLA errorSVC0001%1: PDK_SMSW_3001