Home / APIs / Retrieve MessageContact Deliveries

Retrieve MessageContact Deliveries

8232 points
Michael Clark's picture

The Deliveries resource for MessageContact provides the following details for an SMS send initiated through the MessageContact Send operation:

  • If the send completed
  • When the send completed
  • Number of recipients to which the message was delivered after excluding unsubscribed recipients

Resource URL

https://www.exacttargetapis.com/sms/v1/messageContact/{messageId}/deliveries/{tokenId}

URL Parameters:

  • messageId - The API Key of the Message definition found in the MobileConnect interface
  • tokenId - The unique identifier for a request made to send an SMS message using MessageContact Send

Example Request

GET https://www.exacttargetapis.com/sms/v1/messageContact/MzA6Nzg6MA/deliveries/c21NCNSDN2sMMWM2miosdjEHH?access_token=...

Example Response

HTTP/1.1 200 
{
    "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"
        }
    ]
}

Status values:

  • message - The message text sent in the SMS message
  • count - The total 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
    • Finished
    • Error
    • New
    • Queuing
    • Started

If the request included an invalid messageId or tokenId, the appropriate error returns:

HTTP/1.1 400 Bad Request
{
  "errors" : ["Message id cI217sdksi3 is not valid."]
}

Possible Errors

Message Details
Message id {0} is not valid. The messageID value provided in the URL was not in a valid format.
"Token id {0} is not valid." The tokenId value provided in the URL was not in a valid format.
Token id {0} is not valid for this client. The tokenId value provided is valid but was created for another client.
TokenId {0} is not 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.

API Console

Product Group: