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

Name	Description	Type	Additional 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.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Reports.SMS.MessageDetail

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Reports.SMS.MessageDetail	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": "b910734a-702c-4b7c-8ff8-52c9d2174bb7",
      "DisplayName": "sample string 2",
      "ContactNumber": "sample string 3",
      "ContactEmail": "sample string 4",
      "MessageID": "5bc750d1-8e97-428c-ab9e-21761d672b84",
      "CountContactsSms": 6,
      "CountContactsEmails": 7,
      "CountNumberOfReads": 8,
      "MaxNumberOfReads": 1,
      "MessageContent": "sample string 9",
      "DateSent": "2024-11-21T08:45:05.4502872+00:00",
      "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>b910734a-702c-4b7c-8ff8-52c9d2174bb7</AccountID>
      <DisplayName>sample string 2</DisplayName>
      <ContactNumber>sample string 3</ContactNumber>
      <ContactEmail>sample string 4</ContactEmail>
      <MessageID>5bc750d1-8e97-428c-ab9e-21761d672b84</MessageID>
      <CountContactsSms>6</CountContactsSms>
      <CountContactsEmails>7</CountContactsEmails>
      <CountNumberOfReads>8</CountNumberOfReads>
      <MaxNumberOfReads>1</MaxNumberOfReads>
      <MessageContent>sample string 9</MessageContent>
      <DateSent>2024-11-21T08:45:05.4502872+00:00</DateSent>
      <Status>sample string 11</Status>
      <Reference>sample string 12</Reference>
      <ResponseLimit>13</ResponseLimit>
    </Detail>
  </ResponseData>
</ResponseOfMessageDetail>