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

​
Payload

​
Fields

​
string
Final delivery state — success or failed.
​
string
When the delivery status was finalised, formatted YYYY-MM-DD HH:mm:ss.
​
string
The platform’s message identifier — the same value returned as messageid on the submission response.
​
string
The specific outcome. 000 is delivered; everything else is a failure reason. See Error codes.
​
string
The outcome class — DELIVRD, UNDELIV, REJECTD, or EXPIRED. Coarser than ERRORCODE and useful for reporting buckets.
​
string
Recipient mobile number, with country code.

​
Your reference fields

Whichever reference fields you sent on the original submission come back here unchanged — the two mechanisms are independent, so a message sent with both returns both. If you sent none, none appear.
​
string
The clientsmsid from your submission.
​
string
The first custom reference from your submission. custref2 through custref5 follow the same pattern. See Reference IDs.

​
Reading the receipt

Branch on ERRORCODE for anything that drives logic — retries, suppression lists, diagnostics. Use ERRORDESP for reporting buckets and STATUS only for a delivered/not-delivered split.
This receipt carries no sender, template, or message content — only the outcome and your own references. Store what you need against MSGID at submission time, or carry it in custref1–custref5.
The callback is the only programmatic source of delivery status for international traffic. There is no status-lookup endpoint to poll as a fallback — the equivalent of Message Status exists for India but not here. If your endpoint is unreachable when a receipt is sent, recover the outcome from the portal reports rather than from an API.