GET /sms/v1/messageContact/{messageId}/deliveries/{tokenId}

Retrieves the overall delivery status of a message to a contact and the standard SMS status codes and descriptions. Standard SMS status codes are universal regardless of where messages are sent. This API returns status codes in the order received from carriers. It's possible for Marketing Cloud Engagement to receive codes after the delivered or undelivered status has been returned. Infer the final message status from the status code with the highest numerical value.

NameTypeDescription
messageIdStringRequired. The message ID provided for the messageContact.
tokenIdStringRequired. The token ID for the messageContact.

This sample request shows how to retrieve the status of an SMS send.

The API returns an HTTP 200 response that includes information about the specified send.

The response includes this information about the send:

message

The message text sent in the SMS message

count

The total number of mobile numbers included in the send request minus the number of unsubscribed recipients

createdDate

Date when the MessageContact send was submitted, returned in Central Standard Time (CST)

createdDate

Date when the send completed, returned in CST

status

The status of the send. Possible values:

  • Finished
  • Error
  • New
  • Queuing
  • Started

If the request includes an invalid messageId or tokenId, the API returns an HTTP 400 response that describes the error.

MessageDetails
Message id {0} isn't valid.The messageID value provided in the URL wasn't in a valid format.
"Token id {0} isn't valid."The tokenId value provided in the URL wasn't in a valid format.
Token id {0} isn't valid for this client.The tokenId value provided is valid but was created for another client.
TokenId {0} isn't valid for MessageId {1}.The tokenId value provided is valid for your account but not for the MessageId provided.
An unexpected error occurred, please contact Customer Support with reference id {0}.If this unexpected error is presented when making a call, please take note of the reference id value returned in the error and contact ExactTarget Global Support for more information.