For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
        • POSTSMS status callback
      • GETList all Messages
      • POSTCreate a Message
      • GETRetrieve a Message
      • POSTUpdate a Message
      • DELDelete a Message
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIMessagesWebhooks

SMS status callback

|View as Markdown|Open in Claude|
Payload
1{
2  "MessageStatus": "delivered",
3  "MessageSid": "b3877c40-da60-4998-90ad-b792e98472ms",
4  "AccountSid": "b3877c40-da60-4998-90ad-b792e98472af",
5  "From": "+15551234567",
6  "To": "+15559876543",
7  "Body": "Hey, your order has shipped!",
8  "NumMedia": 0,
9  "NumSegments": 1
10}
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](/docs/compatibility-api/rest/messages/create-message). There are 8 possible message statuses: | Status | Description | |--------|-------------| | `queued` | The API request was processed and the message is waiting to be sent. | | `sending` | The message is being transmitted to the nearest upstream carrier. | | `sent` | The nearest upstream carrier has accepted the message. | | `delivered` | The nearest upstream carrier confirmed receipt of the message. | | `undelivered` | SignalWire received notice from the upstream carrier that the message was not delivered. | | `failed` | SignalWire could not send the message. There is no charge for failed messages. | | `receiving` | SignalWire has received and is currently processing an inbound message. | | `received` | The inbound message has been received by a number in your account. | <Note> 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. </Note>
Was this page helpful?
Previous

List all Messages

Next
Built with

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.

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.

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.
AccountSidstringRequired
The unique ID of the project this message is associated with.
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.

Response

200
Webhook received