Documentation

Send SMS via HTTP (MT) Example

The following shows a URL example for sending an SMS MT message. Please note you must URL encode the MESSAGE_TEXT parameter and VALUE must be set to 0 for a free message:

Method: GET /srs/api/sendsms?
USER_NAME=<account_id>&PASSWORD=<api_key>&ORIGINATOR=<SHORT CODE>&RECIPIENT=<MSISDN>&PR
OVIDER=<Network Provider>&KEYWORD=<Keyword>&MESSAGE_TEXT=Hello%20There!&VALUE=0

The following shows a response example for successfully sending a SMS MT message:

**HTTP 200**

MT-aabbccddeeff00112233445566778899

The following shows a response example for failure when sending SMS MT message:

511
Username or Password incorrect

Be aware for Premium SMS the cost must be set or the Short code's default value will be charged.

Send Silent OBS Billing Message via HTTP (MT) Example

The following shows a URL example for a Silent Billing MT message. This may not be available due to network regulations(MTN hand their own billing requests):

Method: GET /srs/api/sendsms?
USER_NAME=<account_id>&PASSWORD=<api_key>&ORIGINATOR=<SHORT CODE>&RECIPIENT=<MSISDN>&PR
OVIDER=<Network Provider>&VALUE=<Amount>&KEYWORD=<Keyword>&MESSAGE_TEXT=SILENT%20BILLING%20MESSAGE

The following shows a response example for successfully sending a Silent Billing MT message:

**HTTP 200**

MT-aabbccddeeff00112233445566778899

The following shows a response example for failure when sending a Silent Billing MT message:

511
Username or Password incorrect

Unsubscribe VIA MT Unsubscribe Notification

The following shows a URL example for unsubscribing while sending an unsubscription notification:

Method: GET /srs/api/sendsms?USER_NAME=<account_id>
&PASSWORD=<API_Key>&ORIGINATOR=<Short_code>&RECIPIENT=<MSISDN>&PROVIDER=<network>
&MESSAGE_TEXT=<URL_encoded_message>&KEYWORD=<product_id>&STARTED=<YYYY-MM-DD HH:MM>+STOP&CLASS=PAUSE

The following shows a response example for successfully sending a SMS MT message:

**HTTP 200**

MT-aabbccddeeff00112233445566778899

The following shows a response example for failure when unsubscribing from a service:

511
Username or Password incorrect

Receive SMS via HTTP (MO) Example

When an SMS MO message arrives at the SMS Gateway, it will send the following request to your application:

Method: GET http://www.yoursite.com.au/SMSfromMobiles?
ORIGINATOR=61412345678&RECIPIENT=1987654&PROVIDER=telstra&MESSAGE_TEXT=Hello%20There&KEYWORD=<KEYWORD>

You need to provide us with the MO destination (URL) before we can provide you with an account credentials.

Receive Delivery Receipt via HTTP (DR) Example

When the SMS Gateway receives an update on the status of a message, it will send the following request to your application:

Method: GET http://www.yoursite.com.au/DeliveryReciept? ORIGINATOR=61412345678&RECIPIENT=1987654&PROVIDER=telstra&VALUE=<value>&MESSAGE_TEXT=Hello%20There&ID=939ec52e333fbf124a87845d3a5d72e1&REFERENCE=ABC123&RESULT=1

If you would like to receive Delivery Receipts, you need to provide us with the Delivery Receipt destination (URL).

Acknowledging the MO and DR is received successfully

Upon receiving the MO / DR notification, your server needs to respond with a HTTP 200, and a body “0” (ZERO)

0

Send A Premium SMS via HTTP (MT) Example

The following shows a URL example for sending an SMS MT message. Please note that the network and Value parameter are included(MTN handle their own billing requests):

Method: GET /srs/api/sendsms?
USER_NAME=<account_id>&PASSWORD=<api_key>&ORIGINATOR=<SHORT CODE>&RECIPIENT=<MSISDN>&PR
OVIDER=<Network Provider>&KEYWORD=<Keyword>&MESSAGE_TEXT=Hello%20There!&VALUE=<AMOUNT>&NETWORK=<NETWORK PROVIDER>

The following shows a response example for successfully sending a Premium SMS MT message:

**HTTP 200**

MT-aabbccddeeff00112233445566778899

The following shows a response example for failure when sending a Premium SMS MT message:

511
Username or Password incorrect

Vodafone/Airtel Ghana Billing

Vodafone Ghana and Airtel have recently changed the flow of their billing. They now handle all billing confirmation; meaning the flow starts when a billing request comes in which will look like the below:

Method: GET <Your DR endpoint>?ORIGINATOR=<Shortcode>&KEYWORD=<Keyword>&MESSAGE_TEXT=MNO+BILLED%3A+SILENT+BILLING+MESSAGE&CHANGED=False&VALUE=<Amount>&RCPT=2021-07-28T02%3A02%3A56.811855
                              &RESULT=1&PROVIDER=vodafonegh&RECEIPTED=2021-07-28T02%3A02%3A56.811855&RECIPIENT=<MSISDN>&ID=<Mobivate sepcific reference ID>&SENT=2021-07-28T02%3A01%3A50

The next step would be to send the content Via a free SMS using the “ Send SMS via HTTP (MT) Example ” above.

Please note the amount has to be set to 0 or Vodafone will reject the message.