Skip to main content
SMS webhooks notify the final delivery status of each message. Each event sets the value of the status field. The examples below use the account webhook envelope; the campaign envelope carries the same fields at the root level.

Events and resulting status

sms.failed maps to the undelivered status. It is a network failure that happened after the send was accepted: since billing closes at acceptance, the message has already been charged.

data fields (account webhook)

string
required
Message ID. Lets you correlate the event with the original send.
string
required
Destination number in E.164 format.
string
required
Resulting status: delivered, undelivered or expired.
string | null
required
Normalized error code in case of failure, or null when there is no error. See the error codes table.
number
required
Number of SMS segments (parts).
string
required
Time of the event in ISO 8601 (UTC).

Examples by event

Error codes

When there is a failure, the errorCode field carries a normalized value. The possible values are listed below.
On success (sms.delivered) or expiration (sms.expired) events, the errorCode field comes as null.