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

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 Chat deployment that the chat request was initiated from.
Availability.ids: An array of object IDs for which to verify availability.
Availability.needEstimatedWaitTime: Indicates whether the estimatedWaitTime property should be filled. Specify a value of 1 to request the estimated wait time.

Request body

None

Response body

Availability response