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

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.

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.
StatusNameTypeDescription
200  Request is accepted. Review example response.
 requestIdstringThe unique identifier of this request.
 eventCategoryTypestringTransactionalSendEvents event type. SMSSent indicates that the SMS was sent to the SMS provider. SMSNotSent indicates that the SMS was not sent and includes the reason. SMSQueued indicates that the SMS has not yet been processed for sending.
 timestampstringTime the event occured in Central Standard Time (no daylight savings)
 compositeIdstringMarketing Cloud-specific processing identifier that can be referenced for support.
 messageKeystringUnique identifier to track message send status.
 contactKeystringUnique identifier for a subscriber in Marketing Cloud.
 tostringChannel address of the recipient. For SMS, it’s the recipient's mobile number.

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

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.

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

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