Live Agent REST API Developer Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 54

Download
Open PDF In Browser	View PDF

Live Agent REST API Developer
Guide
Version 39.0, Spring ’17

@salesforcedocs
Last updated: March 16, 2017

as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.

CONTENTS
Chapter 1: Understanding Live Agent REST Resources . . . . . . . . . . . . . . . . . . . . . . . . . 1
Chapter 2: Making Requests with Your Live Agent API Endpoint . . . . . . . . . . . . . . . . . . 2
Chapter 3: Request Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 4: Your Message Long Polling Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 5: Live Agent REST API Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Create a Live Agent Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
SessionId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Create a Chat Visitor Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
ChasitorInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
ResyncSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
ChasitorResyncState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Monitor Chat Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ChasitorNotTyping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ChasitorSneakPeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ChasitorTyping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ChatEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ChatMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
CustomEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
MultiNoun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Customize the Chat Visitors’ Experience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Breadcrumb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
VisitorId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 6: Request Bodies for Live Agent REST API . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Chapter 7: Response Bodies for Live Agent REST API . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 8: Live Agent REST API Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Chapter 9: Status Codes and Error Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

CHAPTER 1

Understanding Live Agent REST Resources

Take Live Agent to native mobile apps with the Live Agent REST API.
You don’t have to rely on Visualforce to develop customized chat windows. With the REST resources
in this guide, you can extend the functionality of chat windows beyond simple HTML and JavaScript
environments that merge seamlessly into your company’s own applications. For example, you can
build custom windows within your company’s iOS, Android, or other web applications.

EDITIONS
Available in: Salesforce
Classic
Live Agent is available in:
Performance Editions and
in Developer Edition orgs
that were created after June
14, 2012
Live Agent is available in:
Unlimited Edition with the
Service Cloud
Live Agent is available for an
additional cost in: Enterprise
and Unlimited Editions

CHAPTER 2 Making Requests with Your Live Agent API
Endpoint
To make requests to the Live Agent server, you must use your Live Agent API endpoint.
Your Live Agent API endpoint is a unique URL that lets you access data from your organization’s Live Agent sessions.
To find your organization’s Live Agent API endpoint, from Setup, enter “Live Agent Settings” in the Quick Find box, then select Live
Agent Settings.
Replace the hostname variable with your API endpoint in the URL for each new request.

CHAPTER 3 Request Headers
Each Live Agent REST API resource requires one or more headers to make a request.
Not all resources require all of the available request headers. Each resource indicates which headers are required to make a request.
The following headers are available:
Header Syntax

Description

X-LIVEAGENT-API-VERSION

The Salesforce API version for the request.

X-LIVEAGENT-AFFINITY

The system-generated ID used to identify the Live Agent session on the Live Agent
servers. This affinity token is included in the response body of the SessionId request.

X-LIVEAGENT-SESSION-KEY

The unique ID associated with your Live Agent session.
Note: Your session key shouldn’t be shared or sent over insecure channels, as it
allows access to potentially sensitive chat information.

X-LIVEAGENT-SEQUENCE

The sequence of messages you have sent to the Live Agent server to help the Live Agent
server avoid processing duplicate messages. This number should be increased by one
with every new request.

CHAPTER 4 Your Message Long Polling Loop
Message long polling notifies you of events that occur on the Live Agent server for your Live Agent session.
When you start a request, all pending messages will be immediately delivered to your session. If there are no pending messages, the
connection to the server will remain open. The connection will return messages continuously as they are received on the server.
If your session expires, you will receive a 200 (“OK”) response code and a resource that contains an array of the remaining messages. If
no messages were received, you will receive a 204 (“No Content”) response code.
When you receive a 200 (“OK”) or 204 (“No Content”) response code, immediately perform another Messages request to continue
to retrieve messages that are registered on the Live Agent server.
Warning: If you don’t make another Messages request to continue the messaging loop, your session will end after a system
timeout on the Live Agent server.
If you don’t receive a response within the number of seconds indicated by the clientPollTimeout property in your SessionId
request, your network connection to the server is likely experiencing an error, so you should terminate the request.
To initiate a long polling loop, perform a Messages request.
SEE ALSO:
Messages
SessionId
Status Codes and Error Responses

CHAPTER 5 Live Agent REST API Resources
To perform a POST or GET request, create and send an HTTP request with the appropriate parameters or request body.
The Live Agent REST API requests let you begin new chat sessions between agents and chat visitors and monitor the chat activity that
occurs.
IN THIS SECTION:
Create a Live Agent Session
To create a new Live Agent session, you must call the SessionId request.
Create a Chat Visitor Session
To create or reestablish a chat visitor session using the Live Agent REST API, you must make certain requests.
Monitor Chat Activity
Live Agent requests indicate when certain activities occurred during a chat session.
Customize the Chat Visitors’ Experience
With the Live Agent visitor REST API resources, you can establish your chat visitors’ experience with Live Agent in custom mobile
applications.

Create a Live Agent Session
To create a new Live Agent session, you must call the SessionId request.
IN THIS SECTION:
SessionId
Establishes a new Live Agent session. The SessionId request is required as the first request to create every new Live Agent
session.

SessionId
Establishes a new Live Agent session. The SessionId request is required as the first request to create every new Live Agent session.

Syntax
URI
https://hostname/chat/rest/System/SessionId

Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
GET

Live Agent REST API Resources

Create a Chat Visitor Session

Request headers
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-API-VERSION

Request body
None
Request parameters
None
Response Body
SessionId response

SEE ALSO:
Your Message Long Polling Loop

Create a Chat Visitor Session
To create or reestablish a chat visitor session using the Live Agent REST API, you must make certain requests.
IN THIS SECTION:
ChasitorInit
Initiates a new chat visitor session. The ChasitorInit request is always required as the first POST request in a new chat session.
ResyncSession
Reestablishes a customer’s chat session on a new server if the session is interrupted and the original server is unavailable.
ChasitorResyncState
Reestablishes the chat visitor’s state, including the details of the chat, after a ResyncSession request is completed.

ChasitorInit
Initiates a new chat visitor session. The ChasitorInit request is always required as the first POST request in a new chat session.

Syntax
URI
https://hostname/chat/rest/Chasitor/ChasitorInit

Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
POST
Request headers
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY

Live Agent REST API Resources

ResyncSession

X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE

Request parameters
None
Query parameters
None
Request body
ChasitorInit request

Response body
None

ResyncSession
Reestablishes a customer’s chat session on a new server if the session is interrupted and the original server is unavailable.
This request should only be made if you receive a 503 response status code, indicating that the affinity token has changed for your Live
Agent session. When you receive a 503 response status code, you must cancel any existing inbound or outbound requests.
The data in outbound requests will be temporarily stored and resent once the session is reestablished. Upon receiving the response for
the ResyncSession request, you can start polling for messages if the isValid response property is true.
The first response will be a ChasitorSessionData message containing the data from the previous session that will be restored
once the session is reestablished. After receiving that message, you can proceed to send the existing messages that were cancelled
upon receiving the 503 response status code.

Syntax
URI
https://hostname/chat/rest/System/ResyncSession

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
Name

Type

Description

SessionId

String

The chat session ID from the SessionId request.

Live Agent REST API Resources

ChasitorResyncState

Query parameters
None
Request body
None
Response body
ResyncSession response

SEE ALSO:
Status Codes and Error Responses
ChasitorSessionData
ChasitorResyncState
Status Codes and Error Responses

ChasitorResyncState
Reestablishes the chat visitor’s state, including the details of the chat, after a ResyncSession request is completed.

Syntax
URI
https://hostname/chat/rest/Chasitor/ChasitorResyncState

Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
POST
Request headers
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY

Request parameters
None
Query parameters
None
Request body
ChasitorResyncState request

Response body
None
SEE ALSO:
ResyncSession

Live Agent REST API Resources

Monitor Chat Activity

Monitor Chat Activity
Live Agent requests indicate when certain activities occurred during a chat session.
IN THIS SECTION:
ChasitorNotTyping
Indicates that the chat visitor is not typing in the chat window.
ChasitorSneakPeek
Provides a chat visitor’s message that was viewable through Sneak Peek.
ChasitorTyping
Indicates that a chat visitor is typing a message in the chat window.
ChatEnd
Indicates that a chat visitor has ended the chat.
ChatMessage
Returns the body of the chat message sent by the chat visitor.
CustomEvent
Indicates a custom event was sent from the chat visitor during the chat.
Messages
Returns all messages that were sent between agents and chat visitors during a chat session.
MultiNoun
Batches multiple POST requests together if you’re sending multiple messages at the same time.

ChasitorNotTyping
Indicates that the chat visitor is not typing in the chat window.

Syntax
URI
https://hostname/chat/rest/Chasitor/ChasitorNotTyping

Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
POST
Request headers
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE

Live Agent REST API Resources

ChasitorSneakPeek

Request parameters
None
Query parameters
None
Request body
None
Response body
None

ChasitorSneakPeek
Provides a chat visitor’s message that was viewable through Sneak Peek.

Syntax
URI
https://hostname/chat/rest/Chasitor/ChasitorSneakPeek

Request parameters
None
Query parameters
None
Request body
ChasitorSneakPeek request

Response body
None

ChasitorTyping
Indicates that a chat visitor is typing a message in the chat window.

Live Agent REST API Resources

ChatEnd

Syntax
URI
https://hostname/chat/rest/Chasitor/ChasitorTyping

Request parameters
None
Query parameters
None
Request body
None
Response body
None

ChatEnd
Indicates that a chat visitor has ended the chat.

Syntax
URI
https://hostname/chat/rest/Chasitor/ChatEnd

Live Agent REST API Resources

ChatMessage

Request parameters
None
Query parameters
None
Request body
ChatEndReason—Include the ChatEndReason parameter in the request body of your request to specify the reason that
the chat ended. This parameter is required. For example: {reason: “client”}.

Response properties
attachedRecords—Includes attached record IDs. You can use this Visualforce component to display the attached record IDs
in the post-chat page:
.

ChatMessage
Returns the body of the chat message sent by the chat visitor.

Syntax
URI
https://hostname/chat/rest/Chasitor/ChatMessage

Request parameters
None
Query parameters
None
Request body
ChatMessage request

Response body
None

CustomEvent
Indicates a custom event was sent from the chat visitor during the chat.

Live Agent REST API Resources

Messages

Syntax
URI
https://hostname/chat/rest/Chasitor/CustomEvent

Request parameters
None
Query parameters
None
Request body
CustomEvent request

Response body
None

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

Live Agent REST API Resources

Messages

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

IN THIS SECTION:
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.
SEE ALSO:
Your Message Long Polling Loop

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:
{
"messages":{
"type":"array",
"description":"The messages sent over the course of a chat.",
"items":{
"name":"Message",
"type":"object",
"properties": {
"type": {
"type":"string",
"description":"The type of message that was received.",
"required":true,
"version":29.0
},
"message": {
"type":"object",
"description":"A placeholder object for the message that was received.
Can return any of the responses available for the Messages request.",
"required":true,
"version":29.0
}

Live Agent REST API Resources

Messages

}
},
"required":true,
"version":29.0
},
"sequence":{
"type":"integer",
"description":"The sequence of the message as it was received over
the course of a chat.",
"required":true,
"version":29.0
}
}

IN THIS SECTION:
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 ResyncSession request 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.

Live Agent REST API Resources

Messages

AgentDisconnect
Indicates that the agent has been disconnected from the chat.
Note: Though the agent has been disconnected from the chat, the chat session is still active on the server. A new agent may
accept the chat request and continue the chat.

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
None
Response properties
None

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
None
Response properties
None

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
None
Response properties
None

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 ResyncSession request is sent.
The ChasitorSessionData request is the first message sent after a ResyncSession request is delivered.

Live Agent REST API Resources

Messages

Note: No messages should be sent after a 503 status code is encountered until this message is processed.

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
ChasitorSessionData response

SEE ALSO:
ResyncSession
Status Codes and Error Responses
Status Codes and Error Responses

ChatEnded
Indicates that the chat has ended.

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Request Body
ChatEndReason—Include the ChatEndReason parameter in the request body of your request to specify the reason that
the chat ended. For example: {reason: “client”}.

Response body
None
Response properties
None

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
ChatEstablished response

SEE ALSO:
ChatEstablished

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
ChatTransferred response

Live Agent REST API Resources

MultiNoun

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
CustomEvent response

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
NewVisitorBreadcrumb response

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

Syntax
Available since release
This resource is available in API versions 29.0 and later.
Response body
QueueUpdate response

MultiNoun
Batches multiple POST requests together if you’re sending multiple messages at the same time.

Syntax
URI
https://hostname/chat/rest/System/MultiNoun

Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
POST

Live Agent REST API Resources

Customize the Chat Visitors’ Experience

Request headers
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE

Request parameters
None
Query parameters
None
Request body
MultiNoun request

Response body
None

Customize the Chat Visitors’ Experience
With the Live Agent visitor REST API resources, you can establish your chat visitors’ experience with Live Agent in custom mobile
applications.
IN THIS SECTION:
Settings
Retrieves all settings information about the Live Agent deployment that’s associated with your chat session. The Settings request
is required as the first request to establish a chat visitor’s session.
Availability
Indicates whether a chat button is available to receive new chat requests.
Breadcrumb
Sets a breadcrumb value to the URL of the Web page that the chat visitor is viewing as the visitor chats with an agent. The agent
can then see the value of the breadcrumb to determine the page the chat visitor is viewing.
VisitorId
Generates a unique ID to track a chat visitor when they initiate a chat request and tracks the visitor’s activities as the visitor navigates
from one Web page to another.

Settings
Retrieves all settings information about the Live Agent deployment that’s associated with your chat session. The Settings request
is required as the first request to establish a chat visitor’s session.

Syntax
URI
https://hostname/chat/rest/Visitor/Settings

Live Agent REST API Resources

Availability

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

Request parameters
None
Query parameters
org_id

The ID of the Salesforce organization that’s associated with the Live Agent deployment
deployment_id

The ID of theLive Agent deployment that the chat request was initiated from
Settings.buttonIds

An array of chat button IDs for which to retrieve settings information
Settings.updateBreadcrumb

Indicates whether to update the chat visitor’s location with the URL of the Web page that the visitor is viewing
Request body
None
Response body
Settings response on page 37

Availability
Indicates whether a chat button is available to receive new chat requests.

Syntax
URI
https://hostname/chat/rest/Visitor/Availability

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

Request parameters
None

Live Agent REST API Resources

Breadcrumb

Query parameters
org_id

The ID of the Salesforce organization that’s associated with the Live Agent deployment.
deployment_id

The 15-digit ID of the Live Agent deployment that the chat request was initiated from.
Availability.ids

An array of object IDs for which to verify availability.
Request body
None
Response body
Availability response

Breadcrumb
Sets a breadcrumb value to the URL of the Web page that the chat visitor is viewing as the visitor chats with an agent. The agent can
then see the value of the breadcrumb to determine the page the chat visitor is viewing.

Syntax
URI
https://hostname/chat/rest/Visitor/Breadcrumb

Available since release
This resource is available in API versions 29.0 and later.
Formats
JSON
HTTP methods
POST
Request headers
X-LIVEAGENT-API-VERSION

Request parameters
None
Query parameters
None
Request body
Breadcrumb request

Response body
None

VisitorId
Generates a unique ID to track a chat visitor when they initiate a chat request and tracks the visitor’s activities as the visitor navigates
from one Web page to another.

Live Agent REST API Resources

VisitorId

Syntax
URI
https://hostname/chat/rest/Visitor/VisitorId

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

Request parameters
None
Query parameters
org_id

The Salesforce organization ID
deployment_id

The ID of the Live Agent deployment that the chat request was initiated from
Request body
None
Response body
VisitorId response

CHAPTER 6 Request Bodies for Live Agent REST API
To perform a POST or GET request, pass query parameters or create a request body that’s formatted in JSON. Request bodies can contain
one or more other request bodies that are nested inside. Each request body can contain unique request properties.

Breadcrumb
Request properties
Property Name

Type

Description

Available Versions

location

String

The URL of the Web page that the chat 29.0
visitor is viewing.

Request body
"location":{
"type":"string",
"description":"The current location or URL of the visitor",
"required":true,
"version":29.0
}

ChasitorInit
Request properties
Property Name

Type

Description

organizationId

String

The chat visitor’s Salesforce organization 29.0
ID.

deploymentId

String

The ID of the deployment from which
the chat originated.

29.0

buttonId

String

The ID of the button from which the
chat originated.

29.0

sessionId

String

The chat visitor’s Live Agent session ID. 29.0

userAgent

String

The chat visitor’s browser user agent.

29.0

language

String

The chat visitor’s spoken language.

29.0

The resolution of the chat visitor’s
computer screen.

29.0

screenResolution String

Available Versions

Request Bodies for Live Agent REST API

Property Name

Type

Description

Available Versions

visitorName

String

The chat visitor’s custom name.

29.0

prechatDetails

Array of CustomDetail
objects

The pre-chat information that was
provided by the chat visitor.

29.0

prechatEntities

Array of Entity objects

The records to create when a chat
visitor begins a chat.

29.0

buttonOverrides

Array of Strings

The button override rules that indicate 29.0
how a chat request will be rerouted.

receiveQueueUpdates Boolean

Indicates whether the chat visitor will 29.0
receive queue position updates (true)
or not (false).

Boolean

Indicates whether the chat request was 29.0
made properly through a POST request
(true) or not (false).

isPost

Request body
{
organizationId: "00DD0000000JVXs",
deploymentId: "572D000000000J6",
buttonId: "573D000000000OC",
agentId: "005B0000000F3b2",
doFallback: true,
sessionId: "5503f854-0203-4324-8ed5-f793a367426f",
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36",
language: "en-US",
screenResolution: "2560x1440",
visitorName: "Jon A.",
prechatDetails: [
{
label: "E-mail Address",
value: "jon@example.com",
entityMaps: [
{
entityName: "Contact",
fieldName: "Email",
isFastFillable: false,
isAutoQueryable: true,
isExactMatchable: true
}
],
transcriptFields: [
"c__EmailAddress"
],
displayToAgent: true
}
],

Request Bodies for Live Agent REST API

prechatEntities: [],
buttonOverrides: [
"573D000000000OD"
],
receiveQueueUpdates: true,
isPost: true
}

ChasitorResyncState
Request properties
Property Name

Type

Description

Available Versions

organizationId

String

The chat visitor’s Salesforce organization 29.0
ID.

Request body
{
organizationId: "00DD0000000JVXs"
}

ChasitorSneakPeek
Request properties
Property Name

Type

Description

Available Versions

position

integer

The position of the Sneak Peek update in the chat.

29.0

text

String

The text that the chat visitor is typing in the text input 29.0
area of the chat window.

Request body
{
position: 3,
text: "Hi there."
}

Request Bodies for Live Agent REST API

ChatMessage
Request properties
Property Name

Type

Description

Available Versions

text

String

The text of the chat visitor’s message to the agent.

29.0

Request body
{
text: "I have a question about my account."
}

CustomEvent
Request properties
Property Name

Type

Description

Available Versions

type

String

The type of custom event that occurred, used for adding the event 29.0
listener on the agent’s side.

data

String

Data that’s relevant to the event that was sent to the agent.

29.0

Request body
{
type: "PromptForCreditCard",
data: "Visa"
}

MultiNoun
Request properties
Name

Type

Description

Available Versions

nouns

Array of

An array of noun objects and their properties that are batched 29.0

NounWrapper in the MultiNoun request.

objects

Request body
{
nouns: [
{

Request Bodies for Live Agent REST API

prefix: "Chasitor",
noun: "ChatMessage",
object: {
text: "Goodbye"
}
},
{
prefix: "Chasitor",
noun: "ChatEnd",
object: {}
}
]
}

CHAPTER 7 Response Bodies for Live Agent REST API
A request to a Live Agent REST API resource returns a response code. The successful execution of a resource request can also return a
response body in JSON format.

Availability
Response Properties
Property Name

Type

Description

Available Versions

results

Array of Result objects

A list of Salesforce IDs that
29.0
correspond to agents and chat
buttons and their respective
availability to receive new chat
requests.

Response body
{
"results":{
"type":"array",
"description":"List of ids and their availability",
"items":{
"name":"result",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The id of the entity",
"required":true,
"version":29.0
},
"isAvailable":{
"type":"boolean",
"description":"Whether or not the entity is available for chat",
"required":true,
"version":29.0
}
}
},
"required":true,
"version":29.0
}
}

Response Bodies for Live Agent REST API

ChasitorSessionData
Response Properties
Property Name

Type

Description

queuePosition

integer

The position of the chat visitor 29.0
in the chat queue.

geoLocation

GeoLocation object

The chat visitor's location,
based on the IP address from
which the request originated.

url

String

The URL that the chat visitor is 29.0
visiting.

oref

String

The original URL that the chat
request came from.

29.0

postChatUrl

String

The URL to which to redirect
the chat visitor after the chat
has ended.

29.0

sneakPeekEnabled

Boolean

Whether Sneak Peek is enabled 29.0
for the agent who accepts the
chat.

chatMessages

Array of TranscriptEntry The chat message structure
29.0
that’s synchronized across the
objects
agent.js and chasitor.js files.

Response body
{
queuePosition: 1,
geoLocation: {
countryCode: "US",
countryName: "United States of America",
region: "CA",
city: "San Francisco",
organization: Salesforce.com,
latitude: 37.793880,
longitude: -122.395114
},
url: "http://yoursite",
oref: "http://www.google.com?q=yoursite",
postChatUrl: "http://yoursite/postchat",
sneakPeekEnabled: true,
chatMessages: [
{
type: "Agent",
name: "Andy L.",
content: "Hello, how can I help you?",

Available Versions

29.0

Response Bodies for Live Agent REST API

timestamp: 1376596367548,
sequence: 1
},
{
type: "Chasitor",
name: "Jon A.",
content: "I have a question for you.",
timestamp: 1376596349132
sequence: 2
}
]
}

ChasitorIdleTimeoutWarningEvent
Response properties
Property Name

Type

Description

idleTimeoutWarningEvent String

Available Versions

Informs the server when a
35.0
warning is triggered or cleared.
Possible values: triggered
and cleared.

ChatEstablished
Response properties
Property Name

Type

Description

name

String

The name of the agent who is 29.0
engaged in the chat.

userId

String

The user ID of the agent who is 29.0
engaged in the chat.

sneakPeekEnabled

Boolean

Whether Sneak Peek is enabled 29.0
for the agent who accepts the
chat.

chasitorIdletimeout

ChasitorIdleTimeoutSettings Gives the settings for chat

visitor idle time-out.

Response body
{
name: "Andy L.",
userId: "f1dda237-57f8-4816-b8e8-59775f1e44c8",

Available Versions

35.0

Response Bodies for Live Agent REST API

sneakPeekEnabled: true
}

ChatMessage
Response properties
Property Name

Type

Description

Available Versions

name

String

The name of the agent who is 29.0
engaged in the chat.

text

String

The text of the chat message 29.0
that the agent sent to the chat
visitor.

Response body
{
name: "Andy L."
text: "Hello, how can I help you?"
}

ChatRequestFail
Response properties
Property Name

Type

Description

Available Versions

reason

String

The reason why the chat
request failed—for example,
no agents were available to
chat or an internal error
occurred.

29.0

postChatUrl

String

The URL of the post-chat page 29.0
to which to redirect the chat
visitor after the chat has ended.

Response body
{
reason: "Unavailable",
postChatUrl: "http://yoursite/postChat"
}

Response Bodies for Live Agent REST API

ChatRequestSuccess
Response properties
Property Name

Type

Description

queuePosition

integer

The position of the chat visitor 29.0
in the chat queue.

geoLocation

GeoLocation object

The chat visitor's location,
based on the IP address from
which the request originated.

url

String

The URL that the chat visitor is 29.0
visiting.

oref

String

The original URL that the chat
request came from.

29.0

postChatUrl

String

The URL to which to redirect
the chat visitor after the chat
has ended.

29.0

customDetails

Array of CustomDetail
objects

The custom details of the
deployment from which the
chat request was initiated.

29.0

visitorId

String

The ID of the chat visitor.

29.0

Response body
"{
queuePosition: 1,
geoLocation: {
countryCode:"US",
countryName: "United States of America",
region: "CA",
city: "San Francisco",
organization: Salesforce.com,
latitude: 37.793880,
longitude: -122.395114
},
url: "http://yoursite",
oref: "http://www.google.com?q=yoursite",
postChatUrl: "http://yoursite/postchat",
customDetails: [
{
label: "E-mail Address",
value: "jon@example.com",
transcriptFields: [
"c__EmailAddress"
],
displayToAgent: true

Available Versions

29.0

Response Bodies for Live Agent REST API

}
],
visitorId: "acd47048-bd80-476e-aa33-741bd5cb05d3"
}"

ChatTransferred
Response properties
Property Name

Type

Description

Available Versions

name

String

The name of the agent to
29.0
whom the chat was transferred.

userId

String

The ID of the chat visitor.

sneakPeekEnabled

Boolean

Whether Sneak Peek is enabled 29.0
for the agent to whom the chat
was transferred.

chasitorIdletimeout

ChasitorIdleTimeoutSettings Gives the settings for chat

29.0

35.0

visitor idle time-out.

Response body
{
name: "Ryan S.",
userId: "edacfa56-b203-43d5-9e1b-678278b61263",
sneakPeekEnabled: false
}

CustomEvent
Response properties
Property Name

Type

Description

type

String

The type of custom event that 29.0
occurred, used for adding the
event listener on the chat
visitor’s side.

data

String

Data that’s relevant to the
29.0
event that was sent to the chat
visitor.

Available Versions

Response Bodies for Live Agent REST API

Response body
{
type: "CreditCardEntered",
data: "5105105105105100"
}

Messages
Response Properties
Property Name

Type

Description

Available Versions

messages

Array of Message objects

The messages that was sent
over the course of a chat.

29.0

sequence

integer

The sequence of the message 29.0
as it was received over the
course of a chat.

Response body
{
messages: [
{
type: "ChatEstablished",
message: {
name: "Andy L.",
userId: "f1dda237-57f8-4816-b8e8-59775f1e44c8",
sneakPeekEnabled: true
}
}
],
sequence: 1
}

NewVisitorBreadcrumb
Response properties
Property Name

Type

Description

location

String

The URL of the Web page that 29.0
the chat visitor is viewing.

Available Versions

Response Bodies for Live Agent REST API

Response body
{
location: "http://yoursite/page2"
}

QueueUpdate
Response properties
Property Name

Type

Description

Available Versions

position

integer

The updated position of the
chat visitor in the chat queue.

29.0

Property Name

Type

Description

Available Versions

isValid

Boolean

Indicates whether the session 29.0
is valid (true) or not (false).

key

String

The session key for the new
29.0
session after the old session has
been reestablished.

affinityToken

String

The affinity token for the
session that’s passed in the
header for all future requests.

Response body
{
position: 3
}

ResyncSession
Response properties

Response body
{
isValid: true,
key: "dd19849c-26df-4e21-b4cf-3aada410f35d",
affinityToken: "73061fa0"
}

29.0

Response Bodies for Live Agent REST API

SessionId
Response Properties
Property Name

Type

Description

Available Versions

String

The session ID for the new
session.

29.0

key

String

The session key for the new
session.

29.0

affinityToken

String

The affinity token for the session 29.0
that’s passed in the header for all
future requests.

clientPollTimeout integer

The number of seconds before 29.0
you must make a Messages
request before your Messages
long polling loop times out and
is terminated.

Response body
{
id: "241590f5-2e59-44b5-af89-9cae83bb6947",
key:
"f6c1d699-84c7-473f-b194-abf4bf7cccf8!b65b13c7-f597-4dd2-aa3a-cbe01e69f19c",
affinityToken: "73061fa0"
clientPollTimeout: "30"
}

Settings
Response Properties
Property Name

Type

Description

pingrate

number

The rate at which the visitor must 29.0
ping the server to maintain the
Live Agent visitor session.

contentServerUrl String
buttons

Array of button objects

The URL of the content server.

Available Versions

29.0

A list of chat buttons, along with 29.0
their settings information, that
were specified when you made
the Settings request.

Response Bodies for Live Agent REST API

Response body
{
"pingRate":{
"type":"number",
"description":"The rate at which the visitor should ping the server to
maintain presence",
"required":true,
"version":29.0
},
"contentServerUrl":{
"type":"string",
"description":"The content server URL",
"required":true,
"version":29.0
},
"buttons":{
"type":"array",
"description":"The list of buttons",
"items":{
"name":"button",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The id of the button",
"required":true,
"version":29.0
},
"type":{
"type":"string",
"description":"The type of the button",
"required":true,
"version":29.0,
"enum":["Standard","Invite","ToAgent"]
},
"endpointUrl":{
"type":"string",
"description":"The custom chat window url of the button",
"required":false,
"version":29.0
},
"prechatUrl":{
"type":"string",
"description":"The prechat url of the button",
"required":false,
"version":29.0
},
"language":{
"type":"string",
"description":"The language setting of the button",
"required":false,
"version":29.0
},

Response Bodies for Live Agent REST API

"isAvailable":{
"type":"boolean",
"description":"Whether or not the button is available for chat",
"required":true,
"version":29.0
},
/* Invite related settings */
"inviteImageUrl":{
"type":"string",
"description":"The image of the button",
"required":false,
"version":29.0
},
"inviteImageWidth":{
"type":"number",
"description":"The width of the button image",
"required":false,
"version":29.0
},
"inviteImageHeight":{
"type":"number",
"description":"The height of the button image",
"required":false,
"version":29.0
},
"inviteRenderer":{
"type":"string",
"description":"The animation option of the invite",
"required":false,
"version":29.0,
"enum":["Slide","Fade","Appear","Custom"]
},
"inviteStartPosition":{
"type":"string",
"description":"The start position of the animation",
"required":false,
"version":29.0,
"enum":["TopLeft","TopLeftTop","Top","TopRightTop","TopRight",
"TopRightRight","Right","BottomRightRight","BottomRight",

"BottomRightBottom","Bottom","BottomLeftBottom","BottomLeft",
"BottomLeftLeft","Left","TopLeftLeft"]
},
"inviteEndPosition":{
"type":"string",
"description":"The end position of the animation",
"required":false,
"version":29.0,
"enum":["TopLeft","Top","TopRight","Left","Center","Right","BottomLeft","Bottom","BottomRight"]
},

Response Bodies for Live Agent REST API

"hasInviteAfterAccept":{
"type":"boolean",
"description":"Whether or not invite will trigger after accepting",
"required":false,
"version":29.0
},
"hasInviteAfterReject":{
"type":"boolean",
"description":"Whether or not invite will trigger after rejecting",
"required":false,
"version":29.0
},
"inviteRejectTime":{
"type":"number",
"description":"The auto reject setting of the invite",
"required":false,
"version":29.0
},
"inviteRules":{
"type":"object",
"description":"The rules of the invite",
"required":false,
"version":29.0
}
/* Invite related settings */
}
},
"required":true,
"version":29.0
}
}

SwitchServer
This response is returned for requests to Visitor resources if the Live Agent instance URL is not correct for the Organization ID provided.
Response Properties
Property Name

Type

Description

newUrl

String

The new Live Agent API endpoint 29.0
for your org if your org is moved.
It can be moved due to a planned
org migration or during a Site
Switch to a different instance.

Response body
{

Available Versions

Response Bodies for Live Agent REST API

"messages": [
"type": "SwitchServer"
"message": {
"newUrl": "https://YOUR-INSTANCE.salesforceliveagent.com/chat"
}
]
}

VisitorId
Response Properties
Property Name

Type

Description

Available Versions

sessionId

String

The session ID for the new
session.

29.0

Response body
"sessionId":{
"type":"string",
"description":"The session id of the visitor",
"required":true,
"version":29.0
}

SEE ALSO:
Status Codes and Error Responses

CHAPTER 8 Live Agent REST API Data Types
A request to a Live Agent REST API resource returns a response code. The successful execution of a resource request can also return a
response body in JSON format. Some response bodies return data types that contain their own properties. All property values that refer
to a name of an entity or field are case-sensitive.

Button
Properties
Property Name

Type

Description

Required

Available Versions

String

The ID of the chat
button object.

TRUE

29.0

type

String

The button type. Valid
values are:

TRUE

29.0

• Standard
• Invite
• ToAgent
endpointUrl

String

The URL of the custom FALSE
chat window that’s
assigned to the chat
button.

29.0

prechatUrl

String

The URL of the pre-chat FALSE
form that’s assigned to
the button.

29.0

language

String

The chat button’s
default language.

29.0

isAvailable

Boolean

Specifies whether the TRUE
chat button is available
to receive new chat
requests (true) or not
(false).

29.0

inviteImageUrl

String

The URL to the
automated invitation’s
static image resource.

FALSE

29.0

The width in pixels of
the automated chat
invitation’s image.

FALSE

29.0

(for automated chat
invitations only)
inviteImageWidth number

(for automated chat
invitations only)

FALSE

Live Agent REST API Data Types

Property Name

Type

inviteImageHeight number

(for automated chat
invitations only)
inviteRenderer

String

(for automated chat
invitations only)

Description

Required

Available Versions

The height in pixels of
the automated chat
invitation’s image.

FALSE

29.0

The animation option
that’s assigned to the
automated chat
invitation. Valid values
are:

FALSE

29.0

The position at which FALSE
the automated chat
invitation begins its
animation. Valid values
are:

29.0

• Slide
• Fade
• Appear
• Custom
inviteStartPosition String

(for automated chat
invitations only)

• TopLeft
• TopLeftTop
• Top
• TopRightTop
• TopRight
• TopRightRight
• Right
• BottomRightRight
• BottomRight
• BottomRightBottom
• Bottom
• BottomLeftBottom
• BottomLeft
• BottomLeftLeft
• Left
• TopLeftLeft
inviteEndPosition String

(for automated chat
invitations only)

The position at which FALSE
the automated chat
invitation begins its
animation. Valid values
are:
• TopLeft

29.0

Live Agent REST API Data Types

Property Name

Type

Description

Required

Available Versions

• Top
• TopRight
• Left
• Center
• Right
• BottomLeft
• Bottom
• BottomRight
hasInviteAfterAccept Boolean

Specifies whether the FALSE
automated chat
invitation can be sent
again after the customer
accepted a previous
chat invitation (true)
or not (false).

29.0

Specifies whether the FALSE
automated chat
invitation can be sent
again after the customer
rejected a previous chat
invitation (true) or not
(false).

29.0

The amount of time in FALSE
seconds that the
invitation will appear on
a customer’s screen
before the invitation is
automatically rejected.

29.0

Object

The custom rules that FALSE
govern the behavior of
the automated chat
invitation, as defined in
your custom Apex class.

29.0

Property Name

Type

Description

Available Versions

label

String

The customized label for TRUE
the detail.

(for automated chat
invitations only)

hasInviteAfterReject Boolean

(for automated chat
invitations only)

inviteRejectTime number

(for automated chat
invitations only)

inviteRules (for

automated chat
invitations only)

CustomDetail
Properties

Required

29.0

Live Agent REST API Data Types

Property Name

Type

Description

value

String

The customized value for TRUE
the detail.

29.0

The names of fields to TRUE
which to save the
customer’s details on the
chat transcript.

29.0

Boolean

Specifies whether to
FALSE
display the customized
detail to the agent
(true) or not (false).

29.0

Property Name

Type

Description

Available Versions

entityName

String

The record to search for TRUE
or create.

29.0

showOnCreate

Boolean

Specifies whether to
display the record after
it’s created (true) or
not (false).

FALSE

29.0

linkToEntityName String

The name of the record FALSE
to which to link the
detail.

29.0

linkToEntityField String

The field within the
record to which to link
the detail.

FALSE

29.0

saveToTranscript String

The name of the
FALSE
transcript field to which
to save the record.

29.0

transcriptFields Array of Strings

displayToAgent

Required

Available Versions

Entity
Properties

entityFieldsMaps Array of EntityFieldsMaps The fields to which to

objects

associate the detail on a
record.

Required

TRUE

29.0

Live Agent REST API Data Types

EntityFieldsMaps
Properties
Property Name

Type

Description

Required

Available Versions

fieldName

String

The name of the field to TRUE
which to associate the
detail.

29.0

label

String

The customized label for TRUE
the detail.

29.0

doFind

Boolean

Specifies whether to use TRUE
the field fieldName
to perform a search for
matching records
(true) or not (false).

29.0

isExactMatch

Boolean

Specifies whether to
only search for records
that have fields that
exactly match the field
fieldName (true)
or not (false).

TRUE

29.0

doCreate

Boolean

Specifies whether to
TRUE
create a record based on
the field fieldName
if one doesn’t exist
(true) or not (false).

29.0

Property Name

Type

Description

Available Versions

countryCode

String

The ISO 3166-1 alpha-2 TRUE
country code for the
chat visitor's location.

29.0

countryName

String

The name of the country TRUE
that’s associated with
the chat visitor’s
location.

29.0

region

String

The principal
FALSE
administrative division
associated with the chat

29.0

GeoLocation
Properties

Required

Live Agent REST API Data Types

Property Name

Type

Description

Required

Available Versions

visitor's location—for
example, the state or
province.
city

String

The name of the city
FALSE
associated with the chat
visitor’s location.

29.0

organization

String

The name of the
FALSE
organization associated
with the chat visitor’s
location.

29.0

latitude

number

The latitude associated
with the chat visitor’s
location.

FALSE

29.0

longitude

number

The longitude associated FALSE
with the chat visitor’s
location.

29.0

Message
Properties
Property Name

Type

Description

Required

Available Versions

type

String

The type of message that was
received.

TRUE

29.0

message

Object

A placeholder object for the
TRUE
message that was received. Can
return any of the responses that are
available for the Messages
request.

29.0

NounWrapper
Properties
Property Name

Type

Description

Required

Available Versions

prefix

String

The prefix of the resource.

TRUE

29.0

noun

String

The name of the resource.

TRUE

29.0

data

String

The data to post to the resource.

FALSE

29.0

Live Agent REST API Data Types

Result
Properties
Property Name

Type

Description

Required

Available Versions

String

The Salesforce ID of the agent or
chat button.

TRUE

29.0

isAvailable

Boolean

Indicates whether the entity that’s TRUE
associated with the Salesforce ID
id is available to receive new chat
requests (true) or not (false).

29.0

Description

Required

Available Versions

TRUE

29.0

TranscriptEntry
Properties
Property Name

Type

type

Enumeration of type The type of message in the chat
String
transcript. Valid values are:
• Agent: a message from an
agent to a chat visitor
• Chasitor: a message from a
chat visitor to an agent
• OperatorTransferred:
A request to transfer a chat to
another agent

name

String

The name of the person who sent
the chat message.

TRUE

29.0

content

String

The body of the message.

TRUE

29.0

timestamp

number

The date and time when the
message was sent.

TRUE

29.0

sequence

number

The sequence in which the
TRUE
message was received in the chat.

29.0

SEE ALSO:
Status Codes and Error Responses

CHAPTER 9 Status Codes and Error Responses
Each request returns a status code or error response to indicate whether or not the request was successful.
When an error occurs or when a response is successful, the response header contains an HTTP code, and the response body usually
contains:
• The HTTP response code
• The message accompanying the HTTP response code
HTTP response
code

Description

200

“OK” success code.

202

“Accepted” success code, for POST request.

204

“No Content” success code for Message request; you should resend the request as part of the message loop.

400

The request couldn’t be understood, usually because the JSON body contains an error.

403

The request has been refused because the session isn’t valid.

404

The requested resource couldn’t be found. Check the URI for errors.

405

The method specified in the Request-Line isn’t allowed for the resource specified in the URI.

500

An error has occurred within the Live Agent server, so the request couldn’t be completed. Contact Customer
Support.

503

The affinity token has changed. You must make a ResyncSession request to get a new affinity token
and session key, then make a ChasitorSessionData request to reestablish the chat visitor’s data within
the new session.

SEE ALSO:
Your Message Long Polling Loop
ResyncSession
ChasitorSessionData
Response Bodies for Live Agent REST API
Live Agent REST API Data Types
ResyncSession
ChasitorSessionData

INDEX
Resources
AgentDisconnect 16
AgentNotTyping 16
AgentTyping 16
API Endpoint 2
Availability 21
Breadcrumb 22
ChasitorInit 6
ChasitorNotTyping 9
ChasitorResyncState 8
ChasitorSessionData 16
ChasitorSneakPeek 10
ChasitorTyping 10
ChatEnd 11
ChatEnded 17
ChatEstablished 17
ChatMessage 12, 18
ChatRequestFail 18
ChatRequestSuccess 18
ChatTransferred 18
CustomEvent 12, 19
Data Types 42
Long Polling 4
Messages 13–14
MultiNoun 19
NewVisitorBreadcrumb 19
QueueUpdate 19
Request headers 3
Requests 2, 5–6, 9, 20, 24
Responses 29
ResyncSession 7
SessionId 5
Settings 20
VisitorId 22
Responses
Data Types 42
ResyncSession 7

A
AgentDisconnect 16
AgentNotTyping 16
AgentTyping 16
API Endpoint 2
Availability 21

B
Breadcrumb 22

C
ChasitorInit 6
ChasitorNotTyping 9
ChasitorResyncState 8
ChasitorSessionData 16
ChasitorSneakPeek 10
ChasitorTyping 10
ChatEnd 11
ChatEnded 17
ChatEstablished 17
ChatMessage 12, 18
ChatRequestFail 18
ChatRequestSuccess 18
ChatTransferred 18
CustomEvent 12, 19

D
Data Types 42

E
Error responses 49

M
Messages 13
MultiNoun 19

N
NewVisitorBreadcrumb 19

Q
QueueUpdate 19

SessionId 5
Settings 20
Status codes 49

Requests
Headers 3

VisitorId 22

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.4
Linearized                      : Yes
Create Date                     : 2017:03:16 18:20:56Z
Author                          : salesforce.com, inc.
Date Time Generated             : 2017-03-16T11:20:53.161-07:00
Trapped                         : False
DRC                             : 206.14
Modify Date                     : 2017:03:16 18:20:56Z
Format                          : application/pdf
Title                           : Live Agent REST API Developer Guide
Creator                         : salesforce.com, inc.
Producer                        : XEP 4.20 build 20120720
Creator Tool                    : Unknown
Page Count                      : 54
Page Mode                       : UseOutlines

EXIF Metadata provided by EXIF.tools

Live Agent REST API Developer Guide

Navigation menu

Versions of this User Manual:

Views

Navigation