Delivery Reports

The REST API uses message statuses and error codes in delivery reports, which refer to the state of the batch and can be fetched or sent as a callback.

To enable delivery report, navigate to Settings => Webhook on the Customer Dashboard and enter the callback URL. Once set, all delivery reports would be delivered to the URL.

Delivery report statuses

The status field describes which state a particular message is in.

The following statuses are available when using the SMS REST API:

Status	Type	Description
Queued	Intermediate	Message is queued within REST API system and will be dispatched according to the rate of the account.
Dispatched	Intermediate	Message has been dispatched and accepted for delivery by the SMSC.
Rejected	Final	Message was rejected by the SMSC.
Delivered	Final	Message has been delivered.
Failed	Final	Message failed to be delivered
Expired	Final	Message expired after several failed attempts to deliver message to the recipient. Expiry time differs per operator, set to a minimum of 12 hours.
Unknown	Final	Message was delivered to the SMSC but no Delivery Receipt has been received or a Delivery Receipt that couldn't be interpreted was received.

Delivery report payload

Once the delivery report is received from the network operator, it will be forwarded to your callback URL, which is retrieved from your profile. If your callback URL is not set, please ensure it is configured to start receiving delivery reports (DLRs).

POST https://127.0.0.1:8080/v1/clientdlr

This is the endpoint that would receive the DLR, and the "Body" below shows the parameters that would be sent to the endpoint.

Body

Name	Type	Description
sms_id	string	Unique SMS ID
ref	string	Unique reference ID
msisdn	string	Mobile number of recipient
submit_date	datetime	Time the request was submitted
done_date	datetime	Time the request was completed
status	string	Status of request
sub	string	Sub code. This is always 001
dlvrd	string	Delivery code. If delivered, code is 001. Undelivered has a code of 000
id_smsc	string	Unique SMSC ID
error_code	string	Error code of request. If no error, code will be 000

Upon receiving the DLR, an acknowledgement is expected.

Response

200

{
  "status": 200
}

400

{
  "error": "Invalid request"
}