From Bright Pattern Documentation
Contents
- Introduction
- API Methods
- General Information
- Check Availability
- Expected Parameters
- Request Chat
- Request SMS Chat Session
- Get Active Chat
- Send Events
- Get Chat History
- 1 Get New Chat Events
- Upload File
- Get File
- Get Agent Profile Photo
- API Events
Mobile/Web API Specification
Get New Chat Events
| Description | Returns new chat events for the current session. If there are no new events, the server can keep the request active during 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). |
| URL | http[s]://<host>:<port>/clientweb/api/v1/chats/{chatId}/events?tenantUrl=<tenantUrl> |
| Method | GET |
| Returns | 200 – Array of chat events (content type: application/json). Example:
{ "events":[<array of chat events>] } |
| Errors | 400 – Bad request
401 – Unauthorized 404 – Not found |