• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Get Active Chat

Get Active Chat returns the properties of an active chat session.

URI

http[s]://<host>:<port>/clientweb/api/v1/chats/active?tenantUrl=<tenantUrl>

HTTP Method

GET

Authentication

Authorization: MOBILE-API-140-327-PLAIN appId="<Unique app identifier>", clientId="<Unique client ID>"

Parameters

tenantUrl – Specifies the tenant if the request was not sent to the tenant’s domain

Returns

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

Example

{ "chat_id":”<chat ID>”, “state”:”<queued|connected|ivr>”, “ewt”:<EWT for chat in queued state>, “phone_number”:”<phone number for callback>” }

Errors

401 – Unauthorized

404 – Not found

< Previous | Next >< Previous | Next >