GET api/v1/reports/messages/{messageId}/responses/{recipient}

Retrieves all the responses that have been received/sent from/to the recipient specified in the request.

Request Information

URI Parameters

Name	Description	Type	Additional information
messageId	The ID of the message.	globally unique identifier	Required
recipient	The number/email address of the recipient of the message.	string	Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfMessageResponse

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfListOfMessageResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "MessageID": "23666b08-5252-4c66-a6f3-41ebe11925b4",
        "From": "sample string 2",
        "DateInsert": "2024-12-22T23:00:52.5014205+00:00",
        "Response": "sample string 4",
        "DateRead": "2024-12-22T23:00:52.5014205+00:00",
        "SenderSent": true
      },
      {
        "MessageID": "23666b08-5252-4c66-a6f3-41ebe11925b4",
        "From": "sample string 2",
        "DateInsert": "2024-12-22T23:00:52.5014205+00:00",
        "Response": "sample string 4",
        "DateRead": "2024-12-22T23:00:52.5014205+00:00",
        "SenderSent": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfMessageResponse 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>
      <MessageResponse>
        <MessageID>23666b08-5252-4c66-a6f3-41ebe11925b4</MessageID>
        <From>sample string 2</From>
        <DateInsert>2024-12-22T23:00:52.5014205+00:00</DateInsert>
        <Response>sample string 4</Response>
        <DateRead>2024-12-22T23:00:52.5014205+00:00</DateRead>
        <SenderSent>true</SenderSent>
      </MessageResponse>
      <MessageResponse>
        <MessageID>23666b08-5252-4c66-a6f3-41ebe11925b4</MessageID>
        <From>sample string 2</From>
        <DateInsert>2024-12-22T23:00:52.5014205+00:00</DateInsert>
        <Response>sample string 4</Response>
        <DateRead>2024-12-22T23:00:52.5014205+00:00</DateRead>
        <SenderSent>true</SenderSent>
      </MessageResponse>
    </Detail>
  </ResponseData>
</ResponseOfListOfMessageResponse>