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.
Name | Type | Description | |
---|---|---|---|
messageKey | string | Required | Unique 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. |
Status | Name | Type | Description |
---|---|---|---|
200 | Request is accepted. Review example response. | ||
requestId | string | The unique identifier of this request. | |
eventCategoryType | string | TransactionalSendEvents 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. | |
timestamp | string | Time the event occured in Central Standard Time (no daylight savings) | |
compositeId | string | Marketing Cloud-specific processing identifier that can be referenced for support. | |
messageKey | string | Unique identifier to track message send status. | |
contactKey | string | Unique identifier for a subscriber in Marketing Cloud. | |
to | string | Channel 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.
Response | Reason |
---|---|
200 OK | Success. Review example responses. |
400 Bad Request | Invalid request |
401 Unauthorized | Failed to pass authorization. |
500 Server Error | Internal error |