Get message
Retrieves the current status and data of a message sent through this API, by the message_id returned when it was sent (single send, batch send or the SMS fallback of a WhatsApp/RCS send). Any SMS API Key of the same account can query it; messages of other accounts respond 404. The query counts towards the rate limit of the API Key like any other request.
Authentication
Account authentication key. The App-Key must have the SMS channel enabled; it cannot be used against the endpoints of other channels.
OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.
Path parameters
message_id returned in the 202 response of the send (or in the messages of a batch, or the fallback_id received in the FAILED webhook of a WhatsApp/RCS send with SMS fallback).
Response
The same message_id returned when the message was sent.
Destination number as it was sent: 10 digits for a national mask (without the 52/521 country code, even if the request carried it), E.164 without + for an international mask.
Final text sent, including the short link appended when the send carried a complement.
Current status of the message, same values as the status webhook. QUEUED_PROVIDER while it waits to be sent by the SMS provider; SENT when the provider accepted and sent it; FAILED when the send or the delivery failed. The provider can also reject it as EXPIRED, IN_BLACKLIST, MISSING_PHONE or INVALID_FORMAT. Batch sends can also report a number rejected before sending: INVALID_FORMAT, INVALID_SOURCE or OUTPUT_NOT_FOUND. Every status other than QUEUED_PROVIDER and SENT is terminal.
Operator of the destination number, resolved when the message was sent (considering number portability). Always other for an international mask.
Timestamp when the message was sent to the SMS provider, in UTC. null when it was rejected before sending.
Timestamp of the first failure, in UTC. null when the message has not failed.
Only present when the message belongs to a batch send (POST /v1/sms/batches): the batch_id returned in its 202 response.
Only present when this SMS is the automatic fallback of a WhatsApp or RCS send: message_id of the originating send.