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.
Settings
Retrieves all settings information about the Chat 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
- 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 the Chat deployment that the chat request was initiated from.
- Settings.buttonIds
- An array of chat button IDs for which to retrieve settings information.
- Settings.needEstimatedWaitTime
- Indicates whether the estimatedWaitTime property should be filled. Specify a value of 1 to request the estimated wait time.
- 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