Live Agent REST API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

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:

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}