Message responses

Detailed responses

Using the links provided in the message response you can make a new API request to retrieve the detailedResponses URL.

The resulting request would look like this:

GET https://api.<region>.whispir.com/messages/069BF68E5E0FE99B/messageresponses?view=detailed&filter=default&apikey=498nadsasdff09fewdsafjaa90f

This request is asking for 3 things:

  • The URL is specifically asking for all of the messageresponses to the message with ID 069BF68E5E0FE99B.
  • The View parameter is specifying that the message responses should be shown in a detailed view.
  • The Filter parameter is specifying that the filter should not use a response rule, it should show the default filter.

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

  • The responseMessage channel describes the messaging channel via which the response has come into the Whispir platform.
  • The responseMessage content describes the actual content of the inbound message.
  • The responseMessage acknowledged shows the date when the response was received by the Whispir platform.
  • JSON
  • XML

Detailed responses

This snippet allows users to retrieve the detailed response report for a message:

{{codeStart}}

{

"method": "GET",

"rel": "detailedResponses",

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

}

{{codeEnd}}

Sample detailed response

This is the detailed response report for a message:

{{codeStart}}

{

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

"messageresponses" : [ {

"from" : {

"name" : "John Smith",

"mri" : "John_Smith.484215.Critical_Incident_Management@Contact.whispir.com",

"mobile" : "+1000000000",

"email" : "jsmith@test.com",

"voice" : "+1000000000"

},

"responseCategory" : "noresponse",

"responseMessage" : {

"content" : "N/A",

"acknowledged" : "N/A",

"channel" : "N/A"

}

},{

"from" : {

"name" : "Fred Smith",

"mri" : "Fred_Smith.341550.Critical_Incident_Management@Contact.whispir.com",

"mobile" : "+1000000000",

"email" : "fsmith@test.com",

"voice" : "+1000000000"

},

"responseCategory" : "notmatched",

"responseMessage" : {

"content" : "OK, got it. Thanks.",

"acknowledged" : "28/09/19 08:48",

"channel" : "SMS"

}

} ],

"link" : [ ]

}

{{codeEnd}}

This shows the application client that there were two intended recipients of the message.

One of the recipients is in the noresponse category, meaning they have not provided a response. The other recipient is in the notmatched category, meaning the response did not match any search criteria.