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

NameDescriptionTypeAdditional 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

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.SMS.MessageResponse
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.SMS.MessageResponse

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": "0f69ab53-7e83-4f76-ae71-08ff52712d51",
        "From": "sample string 2",
        "DateInsert": "2018-12-17T03:44:30.8631897+00:00",
        "Response": "sample string 4",
        "DateRead": "2018-12-17T03:44:30.8631897+00:00",
        "SenderSent": true
      },
      {
        "MessageID": "0f69ab53-7e83-4f76-ae71-08ff52712d51",
        "From": "sample string 2",
        "DateInsert": "2018-12-17T03:44:30.8631897+00:00",
        "Response": "sample string 4",
        "DateRead": "2018-12-17T03:44:30.8631897+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>0f69ab53-7e83-4f76-ae71-08ff52712d51</MessageID>
        <From>sample string 2</From>
        <DateInsert>2018-12-17T03:44:30.8631897+00:00</DateInsert>
        <Response>sample string 4</Response>
        <DateRead>2018-12-17T03:44:30.8631897+00:00</DateRead>
        <SenderSent>true</SenderSent>
      </MessageResponse>
      <MessageResponse>
        <MessageID>0f69ab53-7e83-4f76-ae71-08ff52712d51</MessageID>
        <From>sample string 2</From>
        <DateInsert>2018-12-17T03:44:30.8631897+00:00</DateInsert>
        <Response>sample string 4</Response>
        <DateRead>2018-12-17T03:44:30.8631897+00:00</DateRead>
        <SenderSent>true</SenderSent>
      </MessageResponse>
    </Detail>
  </ResponseData>
</ResponseOfListOfMessageResponse>