Chat REST API Messages Response Objects

The Messages request returns an array of objects that represent all the events that occurred during an agent’s chat with a chat customer.

This request can return several subtypes with unique response bodies, depending on the events that occurred within the chat.

Here is an example of the structure of a Messages response array:

1{
2    "messages":{
3        "type":"array",
4        "description":"The messages sent over the course of a chat.",
5        "items":{
6            "name":"Message",
7            "type":"object",
8            "properties": {
9                "type": {
10                    "type":"string",
11                    "description":"The type of message that was received.",
12                    "required":true,
13                    "version":29.0
14            },
15            "message": {
16                "type":"object",
17                "description":"A placeholder object for the message that was received.
18                 Can return any of the responses available for the Messages request.",
19                "required":true,
20                "version":29.0
21            }
22        }
23    },
24    "required":true,
25    "version":29.0
26},
27"sequence":{
28    "type":"integer",
29    "description":"The sequence of the message as it was received over 
30     the course of a chat.",
31    "required":true,
32    "version":29.0
33    }
34}

AgentDisconnect

Indicates that the agent has been disconnected from the chat.
AgentNotTyping

Indicates that the agent is not typing a message to the chat visitor.
AgentTyping

Indicates that the agent is typing a message to the chat visitor.
ChasitorSessionData

Returns the current chat session data for the chat visitor. This request is used to restore the session data for a chat visitor’s chat session after a ReconnectSessionrequest is sent.
ChatEnded

Indicates that the chat has ended.
ChatEstablished

Indicates that an agent has accepted a chat request and is engaged in a chat with a visitor.
ChatMessage

Indicates a new chat message has been sent from an agent to a chat visitor.
ChatRequestFail

Indicates that the chat request was not successful.
ChatRequestSuccess

Indicates that the chat request was successful and routed to available agents.
ChatTransferred

Indicates the chat was transferred from one agent to another.
CustomEvent

Indicates a custom event was sent from an agent to a chat visitor during a chat.
NewVisitorBreadcrumb

Indicates the URL of the Web page the chat visitor is currently viewing.
QueueUpdate

Indicates the new position of the chat visitor in the chat queue when the visitor’s position in the queue changes.
SensitiveDataRules

Lists the sensitive data rules.