Get Active Chat

get

https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/active

This method returns the properties of an active chat session. 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.

Returns

Code	Description
200	Chat session properties (content type: application/json)

Errors

Code	Description
403	Forbidden
404	Not found

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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