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:

• 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.