GET api/v1/reports/messages/{messageId}/reads

Retrieves all the reads the secure/long message has received for a given message.

Request Information

URI Parameters

Name	Description	Type	Additional information
messageId	Unique identifier of the message.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

A list of message details that have been read.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Reports.SMS.MessageRead[]

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Reports.SMS.MessageRead[]	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": [
      {
        "ContactID": "sample string 1",
        "ReceiverDestination": "sample string 2",
        "MessageId": "sample string 3",
        "Location": "sample string 4",
        "DateRead": "2024-11-21T10:24:07.4534676+00:00",
        "DestinationName": "sample string 6",
        "SentVia": "sample string 7"
      },
      {
        "ContactID": "sample string 1",
        "ReceiverDestination": "sample string 2",
        "MessageId": "sample string 3",
        "Location": "sample string 4",
        "DateRead": "2024-11-21T10:24:07.4534676+00:00",
        "DestinationName": "sample string 6",
        "SentVia": "sample string 7"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfMessageRead 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>
      <MessageRead>
        <ContactID>sample string 1</ContactID>
        <ReceiverDestination>sample string 2</ReceiverDestination>
        <MessageId>sample string 3</MessageId>
        <Location>sample string 4</Location>
        <DateRead>2024-11-21T10:24:07.4534676+00:00</DateRead>
        <DestinationName>sample string 6</DestinationName>
        <SentVia>sample string 7</SentVia>
      </MessageRead>
      <MessageRead>
        <ContactID>sample string 1</ContactID>
        <ReceiverDestination>sample string 2</ReceiverDestination>
        <MessageId>sample string 3</MessageId>
        <Location>sample string 4</Location>
        <DateRead>2024-11-21T10:24:07.4534676+00:00</DateRead>
        <DestinationName>sample string 6</DestinationName>
        <SentVia>sample string 7</SentVia>
      </MessageRead>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfMessageRead>