Live Agent REST API Developer Guide

Understanding Live Agent REST Resources
Making Requests with Your Live Agent API Endpoint
Request Headers
Your Message Long Polling Loop
Live Agent REST API Resources
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
PDF

Newer Version Available

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

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.

Your session key shouldn’t be shared or sent over insecure channels, as it allows access to potentially sensitive chat information.

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