Skip to navigation
Compatibility REST APIMessagesWebhooks

SMS status callback

View as MarkdownOpen in Claude

Payload sent by SignalWire to your SMS Status Callback URL when the status of an SMS/MMS message changes.

Configure this callback using the StatusCallback parameter when sending an outgoing message.

SignalWire sends the parameters as a form-encoded (application/x-www-form-urlencoded) POST body, not as JSON. When the callback method is GET, they are sent as query parameters instead.

There are 8 possible message statuses:

StatusDescription
queuedThe API request was processed and the message is waiting to be sent.
sendingThe message is being transmitted to the nearest upstream carrier.
sentThe nearest upstream carrier has accepted the message.
deliveredThe nearest upstream carrier confirmed receipt of the message.
undeliveredSignalWire received notice from the upstream carrier that the message was not delivered.
failedSignalWire could not send the message. There is no charge for failed messages.
receivingSignalWire has received and is currently processing an inbound message.
receivedThe inbound message has been received by a number in your account.

SignalWire only marks a message as delivered when it receives a Delivery Receipt (DLR) from the receiving carrier confirming entry into the end carrier’s network. sent means the message left SignalWire and reached the downstream peer. Some carriers send delayed DLRs; others send none at all. MMS messages never receive DLRs, so they will only ever reach sent status.

Status callbacks are advisory, best-effort notifications — delivery can be delayed or fail silently, so don’t gate time-critical actions on receiving one. See Status callback reliability.

Payload

The payload of this webhook request is an object.
MessageStatusenumRequired

The current status of the message at the time of the callback. One of: queued, sending, sent, delivered, undelivered, failed, receiving, received.

MessageSidstringRequired
The unique ID of this message.
SmsSidstringRequired

The unique ID of this message. Always the same value as MessageSid.

AccountSidstringRequired
The unique ID of the project this message is associated with.
ApiVersionstringRequired
The version of the SignalWire API.
FromstringRequired
The From number of the message.
TostringRequired
The To number of the message.
BodystringRequired
The body of the message.
NumMediaintegerRequired
The number of media files that were included with the message.
NumSegmentsintegerRequired

The number of segments that make up the entire message. If the body exceeds 160 GSM-7 characters or 70 UCS-2 characters, it is automatically split into smaller segments that are annotated for reconstruction on the recipient handset.

ErrorCodestringOptional
If the message has failed or is undelivered, the error code may provide more information about what went wrong.
MediaContentType0stringOptional

The content type of the first media file, such as image/png. Present only when NumMedia is greater than 0. Each additional file adds a numbered parameter: MediaContentType1, MediaContentType2, and so on.

MediaUrl0stringOptional

The URL of the first media file. Present only when NumMedia is greater than 0. Each additional file adds a numbered parameter: MediaUrl1, MediaUrl2, and so on, matching MediaContentType{N}.

Response

200
Webhook received