The best way to get immediate notification on the events like SMS delivery or incoming message is to set up callback URLs. We will call this URL immediately after the event occurs and, if the call was unsuccessful, we will retry a few times later. We perform a GET request. If you need to pass a predefined parameter, include it in your URL.


Examples:


With own pre-defined value to pass: http://www.myserver.com/process_dlr.php?myparameter=myvalue
With default params: http://www.myserver.com/process_dlr.php


DLR's (Delivery Receipts)


DLR's or Delivery Receipts, are notifications received from the carriers relating to the success or otherwise of an attempted SMS Delivery. Your DLR Callback URL is the default URL we post incoming DLR's to. You can also set the DLR Callback URL separately for individual messages. This is done using a parameter on the send-sms call.

Here is a list of parameters we include in our callback request:



Parameter



Description


message_idYour message ID
mobileRecipient’s mobile
longcodeThe number the message was sent from.
datetimeDate/time of delivery. UTC.
statusdelivery status (see table below)


Callback Example


http://yoururl.com/?response=message&longcode=614XXXXXXXX&mobile=614XXXXXXXX


We simplify the native carrier codes into a range of 4 responses:


DLR Response



Description


deliveredYour message has been successfully delivered to the recipients handset.
pendingWe have delivered your message to the carrier and they are attempting to deliver it to the recipients handset.
soft-bounceThe message timed out after 72 hrs, either the recipient was out of range, their phone was off for longer than 72 hrs or the message was unable to be delivered due to a network outage or other connectivity issue.
hard-bounceThe number is invalid or disconnected. You can safely delete the number from your list.


Reply Callback URL


The default Reply Callback URL is used to manage incoming SMS. This is the default URL we will post all incoming messages back to. You can set the Reply Callback URL separately for individual messages. This is set as a parameter on the Send-SMS call. If we should not be able to reach your configured http callback endpoint, we will retry the attempt a maximum of 4 times with a increasing delay of 1 minute, 5 minute, 1 hour and finally 24 hours.


Incoming SMS are broadly similar, with 2 subtly different forms:


  • SMS Replies: are messages received 'in response' to an SMS message sent by you. Responses can come in on both the System Shared Number Pool or any Dedicated Virtual Number, and will be posted to the Default URL above if there was no URL set as a parameter in the Send-SMS call.
  • Inbound SMS: are messages that are received originating from a users mobile phone and are not in response to a message sent via Burst. Inbound SMS can only be received on a Dedicated Virtual Number and will only be posted to the Default URL supplied above.


Here is a list of parameters we include in our callback request:


Parameter



Description


message_idYour message ID
mobileSender’s mobile
longcodeThe number message was delivered to
datetime_entryDate/time that message was received. UTC.
responseMessage text
is_optoutOpt-out flag. ‘yes’ or ‘no’


Link Hits Callback URL


The default link hits callback URL is used to notify when a tapth.is/xxxxx URL defined in a message is clicked.


Here is a list of parameters we include in our callback request:


Parameter



Description


list_idYour list ID
message_idYour message ID
mobileSender’s mobile
longcodeThe number message was delivered to
datetimeDate/time that the click was recorded
messageMessage text
is_optoutOpt-out flag. ‘yes’ or ‘no’
link_hitsLink hit count
firstnameFirstname of contact that clicked
lastnameLastname of contact that clicked


Global Opt Out


The Global Opt-Out (GOO) is an account wide function that allows for automated SPAM compliance with a minimum of hassle on your side.


If the GOO is switched ON: All recipients who reply with the word 'STOP' to any of your messages will be automatically added to the GOO list. All outbound messages are checked against the GOO and messages sent to any numbers on this list will be prevented from delivering.


If the GOO is switched OFF: None of the above functionality is enabled, and you are required to manage your own SPAM compliance in full.