SMS Delivery Reports (DLRs)

Configuration

Set the parameter whendelivered while calling POST /sms to https://yourapp.io/elks/dlrs (or wherever your webhook code is). We'll make an HTTP POST (application/x-www-form-urlencoded) request to this URL when the state of the SMS changes. This happens when we receive confirmation from the carriers that the message was either delivered or failed.

You may use Basic Auth by "https://username:password@yourserver.com" url format. You may allso include any extra information as query parameters like "https://yourserver.com/dlr?exmplekey=examplevalue", you may use this if you have your own SMS id for example or need to add a auth-key.

Request

POST https://yourapp.io/elks/dlrs

Request parameters

Parameter Description
id The unique id of the message in our systems.
status Either ”delivered” or ”failed”.
delivered The delivery time in UTC. Only included if status is set to delivered.

Response structure

Your webhook code must respond with a HTTP status in the range 200-204. If not, the API will consider the request failed and keep trying for up to 24 hours. The response body is ignored.