SMS Gateway
Delivery Reports
Delivery Report Receiving Interface using HTTP
Overview
The MX Telecom SMS Server allows SMS Delivery Reports to be received using HTTP. This page details the format of the HTTP requests which are send by the MX Telecom SMS Server to allow the receipt of SMS delivery Reports by external software systems.
If messages are sent with delivery reports enabled (and the networks concerned support reports) then delivery reports will be added to the online billing system automatically.
Contents
- Receiving a delivery report using HTTP
- Message format
- Response to the server
- Security considerations
Receiving a delivery report using HTTP
If a sending account has an HTTP (or HTTPS) URL associated with it then the MX Telecom SMS Server will push SMS delivery reports back to the application.
Message format
The paramaters are similar to the HTTP SMS Receiving interface; however certain additional fields are available, and some are used differently.
| Parameter | Description |
|---|---|
| smsfrom | The number that was used as smsto in the message that triggered the report. |
| smsdate | The timestamp of the delivery report. Format: yyyy-MM-dd HH:mm:ss. |
| smsmsg | Defined below. |
| reason | Detailed delivery report reason code; see below. |
| *note | The note passed with the original MT (only present if a note was provided). |
| smsto | Should be ignored. |
| shortcode | Should be ignored. |
Note that optional parameters are marked with a *
The smsmsg field will be of the format:
REPORT <SMS ID> <STATUS>
<SMS ID> is a positive 64 bit integer used to uniquely identify an SMS message as it passes through the SMS Gateway. This ID is assigned when the message is first submitted to the SMS Gateway, and the HTTP response returned for the request includes this ID. <STATUS> is the delivery report type code. These codes are explained here.
The detailed reason code is passed as a decimal number, for example "1610612736". Before it can be used, this code should be converted to hexadecimal - 0x60000000. This value can then be interpreted as explained here.
For example:
https://server.com/drpt.cgi?Response to the server
The customer's server should respond with an HTTP 200 response with a non-empty body. This response must be given in a timely manner (sub 10 seconds) currently we do not abandon a request (waiting for the HTTP response) until 60 seconds have passed but this might be reduced in future.
Security considerations
To ensure the authenticity of the HTTP requests you should only accept requests from the following MX Telecom IP addresses:
- 83.166.68.0/23 (ie 68.0 -> 69.255)
The HTTP endpoint can be an HTTPS (SSL) URL to protect the data whilst in transit.
