POST Agents/Chat/GetChatMessages

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Chat/GetChatMessages

Get all or some of the messages in a chat session

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Chat/GetChatMessages?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ChatSessionId, After

Property Name Type Description
ChatSessionId Integer
After Integer

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ChatMessageId int32 The primary key (auto-incremented)
ChatSessionId int32 The reference to the associated chat session.
Type string The type of the message.
Message string The message.
Author string The author of the message.
ReadByCustomer int32 Whether the message has been read by the customer or not.
SpecialType string Enum indicating if it is a special message, such as an URL redirection, etc.
SpecialParam string Special parameter for the special_type.
WhenPosted date-time When the message was posted (UTC timestamp).

Sample request

POST /api/v1/Agents/Chat/GetChatMessages
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ChatSessionId": 565,
  "After": 7
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "ChatMessageId": 1001,
    "ChatSessionId": 2347,
    "Type": "ToCustomer",
    "Message": "Hello! How can I help you today?",
    "Author": "Sarah Johnson",
    "ReadByCustomer": 1,
    "SpecialType": "None",
    "SpecialParam": "",
    "WhenPosted": "2024-12-15T09:23:15+01:00"
  },
  {
    "ChatMessageId": 1002,
    "ChatSessionId": 2347,
    "Type": "ToUser",
    "Message": "Hi, I need help with my recent order",
    "Author": "John Smith",
    "ReadByCustomer": 0,
    "SpecialType": "None",
    "SpecialParam": "",
    "WhenPosted": "2024-12-15T09:23:42+01:00"
  },
  {
    "ChatMessageId": 1003,
    "ChatSessionId": 2347,
    "Type": "ToCustomer",
    "Message": "Of course! Can you provide your order number?",
    "Author": "Sarah Johnson",
    "ReadByCustomer": 1,
    "SpecialType": "None",
    "SpecialParam": "",
    "WhenPosted": "2024-12-15T09:24:03+01:00"
  }
]