Check Availability

get

https://mytenant.cx.onecloud.com/clientweb/api/v2/availability

This method returns the availability status of the configured hours of operation of the associated Messaging/Chat scenario entry. Optionally, Estimated Wait time (EWT) (in seconds) may be returned but could be missing if the server does not have enough data to estimate the EWT value. Note that the API does not check if there are any agents actually logged in.

Status Meanings

Status Name	Description
available	The requested service is available.
notAvailable	The office providing the requested service is currently closed.

Returns

Code	Description
200	Success: Returns the scenario entry’s current status / EWT (optionally)

Errors

Code	Description
403	Forbidden
503	Service Unavailable

Query Params

tenantUrl

string

Identifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).

Headers

Authorization

string

appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. clientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to "WebChat", HTTP cookies will be used for client identification.

User-Agent

string

Response

defaultdefault