Skip to main content
When a message reaches its final state, OneXtel posts a delivery receipt (DLR) to the callback URL registered against your API key. Register your callback URL under Configuration → Add New Callback — see Callback configuration.
This receipt uses camelCase field names. SMS sent to international destinations through the SMS List API produces a different, UPPERCASE receipt — see the international DLR.

Payload

The full set of parameters currently supported for SMS.

Identity and routing

string
Unique message identifier. Use it to correlate the receipt with the message you sent.
string
The API key the message was sent with.
string
Recipient mobile number.
string
Sender ID the message was sent from.
string
DLT template ID the message was sent against.

Outcome

string
Final delivery state — for example DELIVERED.
string
Outcome code. 000 is delivered; anything else is a failure reason. See SMS error codes.
string
Human-readable description of errorCode.
string
Delivery receipt code.
dlrCode and errorCode are separate fields carrying different values — a delivered message shows dlrCode: "001" alongside errorCode: "000". Branch your logic on errorCode, which is the field the error code table documents. The relationship between the two is not documented; treat dlrCode as informational until it is.

Content

string
The message text as sent. Template variables appear in their substituted form.
object
The custom references you set on the original send, echoed back unchanged — custref1 containing CustomReference1 and CustomReference2. This is the simplest way to carry your own order or campaign identifiers through to the receipt.

Timestamps

string
When the message was submitted, formatted YYMMDDHHmmss.
string
When the message reached its final state, formatted YYMMDDHHmmss.
integer
Submission timestamp in epoch milliseconds.
integer
Timestamp in epoch milliseconds at which the receipt was received.
submitDate and doneDate give you delivery latency directly — in the example above the message was submitted at ...122200 and completed at ...122201, one second later. Tracking the spread across a campaign surfaces routing problems earlier than the delivery rate does.