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
- 1 Get Chat History
- Get New Chat Events
- Upload File
- Get File
- Get Agent Profile Photo
- API Events
Mobile/Web API Specification
Get Chat History
Get Chat History returns all client events and all server events for the current session. Event parameter timestamp can be used to restore the correct message order.
URI
http[s]://<host>:<port>/clientweb/api/v1/chats/{chatId}/history?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 – Array of chat events (content type: application/json)
Example
| {
"events":[<array of chat events>] } |
Errors
401 – Unauthorized
404 – Not found