Delivery Receipts (DLR's) - Message Notifications
The InteractSMS Gateway API contacts clients after a broadcast for delivery receipt notifications via HTTP POST. Clients must provide a URL for these notifications, with support for up to TLS 1.2.
Parameter Name | Value Example | Comment |
SMS-Type | Notification | Will always equal “Text”. |
SMS-NotifyID | 321354 | This is a Notification ID defined by the user for message tracking. |
SMS-Success | True | True or False, indicating if the message was successfully received by the end-user. |
SMS-To | 353871111111 | The destination mobile number. Mobile numbers are recommended to be supplied in GSM format. |
SMS-From | 353877777777 | The Senders header that appears on the top of the SMS on the recipient’s handset. |
SMS-Verify | 9db038748b3088971 d913616c13e769b | Encrypted authentication. MD5 value, made up of (NotifyID + SMS-Success + Password) |
SMS-TotalToSend | 1 | No of message to send |
SMS-TotalSent | 1 | Number of messages successfully sent |
SMS-TotalFailed | 0 | Number of failed messages |
SMS-TimeStamp | 2024-01-10 14:17:44 | A date-time string in the format yyyy-mm-dd hh:mm:ss (e.g. 2024-11-01 14:03:59), which represents the time that the delivery receipt arrives to the SMS Gateway. |
Notes:
- SMS-Success: If Total messages Sent = Total messages To Send and Total number of failed deliveries = 0, then this parameter is TRUE. Otherwise, it is FALSE.
- Example 1: Total Sent = 2, Total To Send = 2, Total Failed = 0, result is TRUE
- Example 2: Total Sent = 1, Total To Send = 2, Total Failed = 1, result is FALSE
By configuring these parameters, clients can effectively receive delivery receipt notifications via the InteractSMS Gateway API.
Example: Delivery Receipts - Message Notifications
SMS-Type=Notification
SMS-NotifyID=321354
SMS-Success=True
SMS-To=353871111111
SMS-From=353877777777
SMS-Verify=9db038748b3088971d913616c13e769b
SMS-TotalToSend=1
SMS-TotalSent=1
SMS-TotalFailed=0
SMS-TimeStamp=2024-01-10 14:17:44
NOTE: You will be required to URL encode the HTTP Request as some characters may cause Issues.
Delivery Receipt Flow: