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

Name	Description	Type	Additional information
contactId	The encrypted SMS to be displayed.	string	Required
Id		string	None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.SMS.MessageView

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.SMS.MessageView	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": {
      "Contact": "sample string 1",
      "DateTimeExpiry": "2024-11-21T08:49:34.0945573+00:00",
      "DateTimeSent": "2024-11-21T08:49:34.0945573+00:00",
      "Disclaimer": "sample string 2",
      "Flagger": true,
      "From": "sample string 4",
      "LogoURL": "sample string 5",
      "Message": "sample string 6",
      "MessageId": "sample string 7",
      "ReadsRemaining": "sample string 8",
      "Responses": [
        {
          "MessageID": "bf07588d-7b39-435e-97e3-06a45c7e4937",
          "From": "sample string 2",
          "DateInsert": "2024-11-21T08:49:34.0950877+00:00",
          "Response": "sample string 4",
          "DateRead": "2024-11-21T08:49:34.0950877+00:00",
          "SenderSent": true
        },
        {
          "MessageID": "bf07588d-7b39-435e-97e3-06a45c7e4937",
          "From": "sample string 2",
          "DateInsert": "2024-11-21T08:49:34.0950877+00:00",
          "Response": "sample string 4",
          "DateRead": "2024-11-21T08:49:34.0950877+00:00",
          "SenderSent": true
        }
      ],
      "ResponseEnabled": true,
      "ResponseLimitReached": true,
      "To": "sample string 11"
    }
  }
}

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>
      <Contact>sample string 1</Contact>
      <DateTimeExpiry>2024-11-21T08:49:34.0945573+00:00</DateTimeExpiry>
      <DateTimeSent>2024-11-21T08:49:34.0945573+00:00</DateTimeSent>
      <Disclaimer>sample string 2</Disclaimer>
      <Flagger>true</Flagger>
      <From>sample string 4</From>
      <LogoURL>sample string 5</LogoURL>
      <Message>sample string 6</Message>
      <MessageId>sample string 7</MessageId>
      <ReadsRemaining>sample string 8</ReadsRemaining>
      <Responses>
        <MessageResponse>
          <MessageID>bf07588d-7b39-435e-97e3-06a45c7e4937</MessageID>
          <From>sample string 2</From>
          <DateInsert>2024-11-21T08:49:34.0950877+00:00</DateInsert>
          <Response>sample string 4</Response>
          <DateRead>2024-11-21T08:49:34.0950877+00:00</DateRead>
          <SenderSent>true</SenderSent>
        </MessageResponse>
        <MessageResponse>
          <MessageID>bf07588d-7b39-435e-97e3-06a45c7e4937</MessageID>
          <From>sample string 2</From>
          <DateInsert>2024-11-21T08:49:34.0950877+00:00</DateInsert>
          <Response>sample string 4</Response>
          <DateRead>2024-11-21T08:49:34.0950877+00:00</DateRead>
          <SenderSent>true</SenderSent>
        </MessageResponse>
      </Responses>
      <ResponseEnabled>true</ResponseEnabled>
      <ResponseLimitReached>true</ResponseLimitReached>
      <To>sample string 11</To>
    </Detail>
  </ResponseData>
</ResponseOfMessageView>