From Bright Pattern Documentation
Jump to: navigation, search
(Created new topic from branched topic Documentation:ServicePattern:mobile-web-api-specification:GetActiveChat:5.1)
 
(Updated via BpDeleteTranslateTags script)
 
Line 1: Line 1:
<translate>= Get Active Chat =
+
= Get Active Chat =
 
''Get Active Chat'' returns the properties of an active chat session.
 
''Get Active Chat'' returns the properties of an active chat session.
  
Line 35: Line 35:
  
 
<center>[[mobile-web-api-specification/RequestChat|< Previous]]  |  [[mobile-web-api-specification/SendEvents|Next >]]</center>
 
<center>[[mobile-web-api-specification/RequestChat|< Previous]]  |  [[mobile-web-api-specification/SendEvents|Next >]]</center>
</translate>
 

Latest revision as of 04:32, 29 May 2024

• 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 >