Chat REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
SessionId
Establishes a new Chat session. The SessionId
request is required as the first request to create every Chat session.
Syntax
- URI
- https://hostname/chat/rest/System/SessionId/
- https://hostname/chat/rest/System/SessionId/X-LIVEAGENT-SESSION-KEY
- Available since release
- This resource is available in API versions 29.0 and later.
- Formats
- JSON
- HTTP methods
- GET—Creates a session. Don't pass X-LIVEAGENT-SESSION-KEY to the URL.
- DELETE—Deletes the session. Pass X-LIVEAGENT-SESSION-KEY, the session key, to the URL.
- Request headers
- X-LIVEAGENT-AFFINITY
- X-LIVEAGENT-API-VERSION
- Request body
- None
- Request parameters
- None
- Response Body
- SessionId response