Message status

Retrieve detailed status

Similar to the summaryStatus attribute, using the links provided in the message response, you can make a new API request to retrieve the detailedStatus URL.

GET https://api.<region>.whispir.com/messages/069BF68E5E0FE99B/messagestatus?view=detailed&apikey=

As this is a GET request you don’t have to provide any message body.

You can easily use this information to receive a far more detailed status breakdown for each recipient:

  • The name of the recipient
  • The channel type (SMS, email, voice, web)
  • The sent timestamp for each channel
  • The received timestamp for each channel
  • The acknowledged timestamp for each channel
  • The undeliverable timestamp (only present when the channel is undeliverable)
  • The overall status for this recipient (PENDING, SENT, DELIVRD, READ, FAILED)
  • The information text describing how this message has progressed.

Once you have processed the status information, the next likely piece of information you’ll be looking for is the content of the responses (if any). See Message responses for details on how to retrieve this information.

  • JSON
  • XML

Retrieve detailed status

This snippet will retrieve the detailed status for a message:

{{codeStart}}

{

"method": "GET",

"rel": "detailedStatus",

"uri": "https://api.<region>.whispir.com/messages/069BF68E5E0FE99B/messagestatus?view=detailed&apikey=498nadsasdff09fewdsafjaa90f"

}

{{codeEnd}}

Sample detailed status response

{{codeStart}}

{

"messageStatuses" : [ {

"name" : "John Smith",

"info" : "Out bound SMS text message sent OK.",

"link" : [ {

"uri" : "https://api.<region>.whispir.com/messages/069BF68E5E0FE99B/messagestatus?apikey=498nadsasdff09fewdsafjaa90f&view=detailed",

"rel" : "self",

"method" : "GET"

} ],

"status" : [ {

"type" : "email",

"status" : "",

"destination" : ""

}, {

"type" : "sms",

"status" : "READ",

"destination" : "+1000000000",

"sentTimestamp" : "1460070991",

"receivedTimestamp" : "1460070991",

"acknowlegedTimestamp" : "1460070991"

}, {

"type" : "voice",

"status" : "",

"destination" : ""

},{

"name" : "Fred Smith",

"info" : "Out bound SMS text message sent OK.",

"link" : [ {

"uri" : "https://api.<region>.whispir.com/messages/069BF68E5E0FE99B/messagestatus?apikey=498nadsasdff09fewdsafjaa90f&view=detailed",

"rel" : "self",

"method" : "GET"

} ],

"status" : [ {

"type" : "email",

"status" : "",

"destination" : ""

}, {

"type" : "sms",

"status" : "READ",

"destination" : "+1000000000",

"sentTimestamp" : "1460070991",

"receivedTimestamp" : "1460070991",

"acknowlegedTimestamp" : "1460070991"

}, {

"type" : "voice",

"status" : "",

"destination" : ""

} ],

"status" : "1 to 2 of 2",

"link" : [ ]

}

{{codeEnd}}