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

Retrieves the secure/long message for the given message. This includes all the recipients, notifications, responses and reads.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
messageId

Unique identifier for the message.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

A list of notfications and read messages.

ResponseOfMessageDetail
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfMessageDetail

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": {
      "AccountID": "68ff14d1-e909-46b2-985f-ff56133025ad",
      "DisplayName": "sample string 2",
      "ContactNumber": "sample string 3",
      "ContactEmail": "sample string 4",
      "MessageID": "7a89a3f5-1e2c-4ede-8bd1-0e394d99c749",
      "CountContactsSms": 6,
      "CountContactsEmails": 7,
      "CountNumberOfReads": 8,
      "MessageContent": "sample string 9",
      "DateSent": "2017-11-17T17:30:35.8872207Z",
      "Reference": "sample string 12"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfMessageDetail 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>
      <AccountID>68ff14d1-e909-46b2-985f-ff56133025ad</AccountID>
      <DisplayName>sample string 2</DisplayName>
      <ContactNumber>sample string 3</ContactNumber>
      <ContactEmail>sample string 4</ContactEmail>
      <MessageID>7a89a3f5-1e2c-4ede-8bd1-0e394d99c749</MessageID>
      <CountContactsSms>6</CountContactsSms>
      <CountContactsEmails>7</CountContactsEmails>
      <CountNumberOfReads>8</CountNumberOfReads>
      <MessageContent>sample string 9</MessageContent>
      <DateSent>2017-11-17T17:30:35.8872207Z</DateSent>
      <Status>sample string 11</Status>
      <Reference>sample string 12</Reference>
      <ResponseLimit>13</ResponseLimit>
    </Detail>
  </ResponseData>
</ResponseOfMessageDetail>