Availability

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

This resource is available in API versions 29.0 and later.

URI 

https://HOSTNAME/chat/rest/Visitor/Availability

Where HOSTNAME is a variable.

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

Overview
Getting Started with the Chat REST API
Request Headers
Your Message Long Polling Loop
Using Estimated Wait Time Instead of Queue Position for a Chat Session (Beta)
Chat REST API Resources
Create a Chat Session
Create a Chat Visitor Session
Monitor Chat Activity
Customize the Chat Visitors’ Experience
Settings
Availability
Breadcrumb
VisitorId
SensitiveDataRuleTriggered for Agents
SensitiveDataRuleTriggered for Chasitors
Request Bodies for Chat REST API
Response Bodies for Chat REST API
Chat REST API Data Types
Status Codes and Error Responses