GET api/v1/reports/messages/{messageId}/responses?filter.User={filter.User}&filter.Status={filter.Status}&filter.StartDate={filter.StartDate}&filter.EndDate={filter.EndDate}&filter.Range={filter.Range}&filter.Destination={filter.Destination}&filter.Reference={filter.Reference}&paging.Page={paging.Page}&paging.NoOfRecords={paging.NoOfRecords}&sort.Field={sort.Field}&sort.AscendingDescending={sort.AscendingDescending}
Retrieves all the recipients that have responded to the message. It will also display whether there are any unread responses.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
messageId |
The ID of the message. |
globally unique identifier |
Required |
User |
By user who responded to the response from the recipient. |
globally unique identifier |
None. |
Status |
By responses that have been read or unread or both. |
StatusResponse |
None. |
StartDate |
The date for the records to start from. The format is the following:[YYYY-MM-DDTHH:MM:SSZ] |
date |
None. |
EndDate |
The date for the records to finish. The format is the following:[YYYY-MM-DDTHH:MM:SSZ] |
date |
None. |
Range |
Date ranges to search records for. |
DateRange |
None. |
Destination |
To search for a particular Short Code |
string |
None. |
Reference |
To search for a Reference |
string |
None. |
Page |
The Page number for the report. |
integer |
Required |
NoOfRecords |
The number of records to return per page. |
integer |
Required |
Field |
The field to sort the records by. |
SortField |
None. |
AscendingDescending |
Determines whether to sort the records in ascending or descending order. |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
ResponseOfListOfMessageResponseSummaryName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfListOfMessageResponseSummary |
None. |
Response Formats
application/json, text/json
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": [ { "From": "sample string 1", "ID": "d3136567-0d81-4abb-b946-380289c4a7c6", "LatestMessageReceived": "2024-09-07T14:20:10.9606285+00:00", "MessageID": "b1cec366-4345-476d-82a9-af4dc5f79ae6", "NoOfResponses": 4, "UnreadResponses": true, "Recipient": "sample string 6" }, { "From": "sample string 1", "ID": "d3136567-0d81-4abb-b946-380289c4a7c6", "LatestMessageReceived": "2024-09-07T14:20:10.9606285+00:00", "MessageID": "b1cec366-4345-476d-82a9-af4dc5f79ae6", "NoOfResponses": 4, "UnreadResponses": true, "Recipient": "sample string 6" } ] } }
application/xml, text/xml
<ResponseOfListOfMessageResponseSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <MessageResponseSummary> <From>sample string 1</From> <ID>d3136567-0d81-4abb-b946-380289c4a7c6</ID> <LatestMessageReceived>2024-09-07T14:20:10.9606285+00:00</LatestMessageReceived> <MessageID>b1cec366-4345-476d-82a9-af4dc5f79ae6</MessageID> <NoOfResponses>4</NoOfResponses> <UnreadResponses>true</UnreadResponses> <Recipient>sample string 6</Recipient> </MessageResponseSummary> <MessageResponseSummary> <From>sample string 1</From> <ID>d3136567-0d81-4abb-b946-380289c4a7c6</ID> <LatestMessageReceived>2024-09-07T14:20:10.9606285+00:00</LatestMessageReceived> <MessageID>b1cec366-4345-476d-82a9-af4dc5f79ae6</MessageID> <NoOfResponses>4</NoOfResponses> <UnreadResponses>true</UnreadResponses> <Recipient>sample string 6</Recipient> </MessageResponseSummary> </Detail> </ResponseData> </ResponseOfListOfMessageResponseSummary>