Skip to navigation

Get SMS message status

View as Markdown
Get a message by ID. Use webhooks for status updates, or retrieve the latest status here after a missed event.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

message_uuidstringRequired

Message identifier starting with msg_. Use the complete value returned by the API or webhook.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Message status.
channelenum
Allowed values:
contentobject
created_atdatetime
delivery_statusenum

unknown means the 72-hour monitoring window ended without a conclusive outcome, not that delivery failed.

Allowed values:
directionenum
Allowed values:
fromstring
message_uuidstring

Message identifier starting with msg_.

sending_statusenum
Latest confirmed sending milestone, independent of recipient delivery.
Allowed values:
tostringformat: "^\+[1-9]\d{1,14}$"
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
500
Internal Server Error
503
Service Unavailable Error