Live Agent REST API Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
Understanding Live Agent REST Resources
Making Requests with Your Live Agent API Endpoint
Request Headers
Your Message Long Polling Loop
ChasitorNotTyping
ChasitorSneakPeek
ChasitorTyping
ChatEnd
ChatMessage
CustomEvent
AgentDisconnect
AgentNotTyping
AgentTyping
ChasitorSessionData
ChatEnded
ChatEstablished
ChatMessage
ChatRequestFail
ChatRequestSuccess
ChatTransferred
CustomEvent
NewVisitorBreadcrumb
QueueUpdate
MultiNoun
Request Bodies for Live Agent REST API
Response Bodies for Live Agent REST API
Live Agent REST API Data Types
Status Codes and Error Responses
Newer Version Available
Live Agent 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.