From Bright Pattern Documentation
Contents
- Introduction
- API Methods
- General Information
- Check Availability
- Expected Parameters
- Request Chat
- Request SMS Chat Session
- 1 Get Active Chat
- Send Events
- Get Chat History
- Get New Chat Events
- Upload File
- Get File
- Get Agent Profile Photo
- API Events
Mobile/Web API Specification
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>”, } |
Errors
401 – Unauthorized
404 – Not found