GET api/v1/sms/messages/authenticated/{Id}?contactId={contactId}

This method decrypts the encoded string and fetches the secure message details for the contact. This method is called after the recipient has authenticated with an identity provider.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

The encrypted SMS to be displayed.

 string

Required
Id

string

None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfMessageView
NameDescriptionTypeAdditional information
Error

Error

None.
ResponseData

ResponseDataOfMessageView

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": "73fe6163-2cc4-4cf8-9601-8bb13cee1bce",
      "Contact": "sample string 2",
      "DateTimeExpiry": "2024-11-21T10:25:46.6265934+00:00",
      "DateTimeSent": "2024-11-21T10:25:46.6265934+00:00",
      "Disclaimer": "sample string 3",
      "Flagger": true,
      "From": "sample string 5",
      "LanguageID": "e1329a05-af06-40b7-a10e-07b7b6b91525",
      "LogoName": "sample string 7",
      "LogoURL": "sample string 8",
      "Message": "sample string 9",
      "MessageId": "b4fef3b9-6608-4808-b994-4aa4712947e3",
      "ReadsRemaining": "sample string 11",
      "Reference": "sample string 12",
      "Responses": [
        {
          "MessageID": "21251ea5-540d-4307-9c92-ebe49acc1c6b",
          "From": "sample string 2",
          "DateInsert": "2024-11-21T10:25:46.6265934+00:00",
          "Response": "sample string 4",
          "DateRead": "2024-11-21T10:25:46.6265934+00:00",
          "SenderSent": true
        },
        {
          "MessageID": "21251ea5-540d-4307-9c92-ebe49acc1c6b",
          "From": "sample string 2",
          "DateInsert": "2024-11-21T10:25:46.6265934+00:00",
          "Response": "sample string 4",
          "DateRead": "2024-11-21T10:25:46.6265934+00:00",
          "SenderSent": true
        }
      ],
      "ResponseEnabled": true,
      "ResponseLimitReached": true,
      "To": "sample string 15"
    }
  }
}

application/xml, text/xml

Sample: 
<ResponseOfMessageView 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>73fe6163-2cc4-4cf8-9601-8bb13cee1bce</AccountID>
      <Contact>sample string 2</Contact>
      <DateTimeExpiry>2024-11-21T10:25:46.6265934+00:00</DateTimeExpiry>
      <DateTimeSent>2024-11-21T10:25:46.6265934+00:00</DateTimeSent>
      <Disclaimer>sample string 3</Disclaimer>
      <Flagger>true</Flagger>
      <From>sample string 5</From>
      <LanguageID>e1329a05-af06-40b7-a10e-07b7b6b91525</LanguageID>
      <LogoName>sample string 7</LogoName>
      <LogoURL>sample string 8</LogoURL>
      <Message>sample string 9</Message>
      <MessageId>b4fef3b9-6608-4808-b994-4aa4712947e3</MessageId>
      <ReadsRemaining>sample string 11</ReadsRemaining>
      <Reference>sample string 12</Reference>
      <Responses>
        <MessageResponse>
          <MessageID>21251ea5-540d-4307-9c92-ebe49acc1c6b</MessageID>
          <From>sample string 2</From>
          <DateInsert>2024-11-21T10:25:46.6265934+00:00</DateInsert>
          <Response>sample string 4</Response>
          <DateRead>2024-11-21T10:25:46.6265934+00:00</DateRead>
          <SenderSent>true</SenderSent>
        </MessageResponse>
        <MessageResponse>
          <MessageID>21251ea5-540d-4307-9c92-ebe49acc1c6b</MessageID>
          <From>sample string 2</From>
          <DateInsert>2024-11-21T10:25:46.6265934+00:00</DateInsert>
          <Response>sample string 4</Response>
          <DateRead>2024-11-21T10:25:46.6265934+00:00</DateRead>
          <SenderSent>true</SenderSent>
        </MessageResponse>
      </Responses>
      <ResponseEnabled>true</ResponseEnabled>
      <ResponseLimitReached>true</ResponseLimitReached>
      <To>sample string 15</To>
    </Detail>
  </ResponseData>
</ResponseOfMessageView>