GET API/V40/Interactive/Messages?PageNumber={PageNumber}&DescendingOrder={DescendingOrder}&PageLength={PageLength}&SessionToken={SessionToken}

Retrieve messages

Request Information

URI Parameters

Name	Description	Type	Additional information
PageNumber	Defaults to 1	integer
DescendingOrder	Defaults to false	boolean
PageLength	This is nullable - if it's omitted, all messages are returned (honouring the original API)	integer
SessionToken	The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.	string	Required

Body Parameters

None.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
SessionToken	The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.	string
ResponsesIncluded	A list of response messages names contained in this composite message, for easy pre-parsing.	string
Responses	A list of response messages contained in this composite message.	Collection of Object GetMessagesResponse
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "i-7CDz_-3IgKAAAAAAAAAAAAAAA.sGbRn1ORE6nlDQtnB-KFxeiFJ5nZiJ6D1dSSruagj6Q",
  "responsesIncluded": "getMessagesResponse",
  "responses": [
    {
      "getMessagesResponse": {
        "content": {
          "messages": [
            {
              "createDate": "2024-11-06T08:43:18.0595851+00:00",
              "code": "sample string 2",
              "isRead": true,
              "serviceCenterName": "sample string 4",
              "messageType": "sample string 5",
              "content": "sample string 6",
              "firstName": "sample string 7",
              "lastName": "sample string 8",
              "languageCode": "sample string 9",
              "isTranslated": true,
              "conversationId": 11
            },
            {
              "createDate": "2024-11-06T08:43:18.0595851+00:00",
              "code": "sample string 2",
              "isRead": true,
              "serviceCenterName": "sample string 4",
              "messageType": "sample string 5",
              "content": "sample string 6",
              "firstName": "sample string 7",
              "lastName": "sample string 8",
              "languageCode": "sample string 9",
              "isTranslated": true,
              "conversationId": 11
            }
          ]
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}