From Bright Pattern Documentation
< 5.2:Mobile-web-api-specification
Revision as of 04:32, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19 • 5.2 • 5.3 • 5.8

Get Active Chat

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

URL

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

Method

GET

Returns

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

Example

{

"chat_id":”<chat ID>”,

“state”:”<queued|connected|ivr>”,

“ewt”:<estimated wait time for a chat in state queued>,

“phone_number”:”<phone number that will be used for callback>”

}

Errors

401 – Unauthorized

404 – Not found



< Previous | Next >
< Previous | Next >