Get New Chat Events

get

https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/{chatId}/events

This method returns new chat events for the current session. If there are no new events, the server can keep the request active during a timeout (i.e., for about 5–15 seconds). If the client sends another request to get new events while the previous request is kept active, the server will respond with error 400 (Bad request).

Returns

Code	Description
200	Array of chat events (content type: application/json)

Errors

Code	Description
403	Forbidden
404	Not Found
429	Too many requests

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

chatId

string

required

The current chat session ID. The value of this variable is returned in the body of a successful invocation of the "Request Chat" method.

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