Newer Version Available

This content describes an older version of this product. View Latest

Messages

Returns all messages that were sent between agents and chat visitors during a chat session.

For a complete list of responses for the Messages resource, see Live Agent REST API Messages Response Objects.

Syntax

URI
https://hostname/chat/rest/System/Messages
Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
GET
Request headers
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
Request parameters
None
Query parameters
ack—The ack query parameter is a sequencing mechanism that allows you to poll for messages on the Live Agent server. The first time you make the Messages request, the ack parameter is set to –1; this value increases by 1 with each new Messages request you send. To guarantee that you receive the messages from the server in the correct order, you must update the ack in the next request you make to the value you receive in the preceding response.
Request body
None
Response body
Messages response