GET /messaging/v1/sms/messages/{messageKey}

Overview

Gets the send status for a message. Because this route is rate-limited, use it for infrequent verification of a messageKey. To collect send status at scale, subscribe to transactional send events using the Event Notification Service.

URL Parameters

NameTypeDescription
messageKeystringRequiredUnique identifier to track message send status. You must provide it in singleton requests using the recipient attribute. Can be up to 100 characters, and there are no restricted characters. To provide message key in batch requests, use the recipients array attribute. If you don’t provide the message key for recipients, it’s generated in the response.

Usage

Example Request

Example Response: Sent Status

The message is sent to the outbound SMS service for delivery.

Example Response: Queued Status

The message is queued for processing and assigned a sent or notSent status after processing. The message remains in SMSQueued status when the definitionKey is inactive.

Example Response: NotSent Status

The message isn’t sent because of a processing error described in the info object.

HTTP Responses

ResponseReason
200 OKSuccess. Review example responses.
400 Bad RequestInvalid request
401 UnauthorizedFailed to pass authorization.
500 Server ErrorInternal error