GET /sms/v1/messageList/{id}/deliveries/{tokenId}

Returns status for a message sent to a group of mobile numbers.

URL Parameters

Usage

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

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
GET /sms/v1/messageList/MESSAGE_ID/deliveries/TOKEN_ID
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

The response contains information about the specified send.

{
  "message": "Test Delivery Receipt",
  "count": 1,
  "createDate": "2013-04-25T15:01:04.147",
  "completeDate": "2013-04-25T15:01:55.197",
  "status": "Finished",
  "tracking": [
    {
      "mobileNumber": "15555555510",
      "statusCode": "20",
      "message": "NA"
    }
  ]
}

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 subtracting the number of unsubscribed recipients

• createdDate

  • : Date when the MessageContact send was submitted, returned in 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.

{
  "errors" : ["Message id cI217sdksi3 is not valid."]
}