From Bright Pattern Documentation
Contents
- Introduction
- API Methods
- General Information
- Check Availability
- Expected Parameters
- Request Chat
- Request SMS Chat Session
- Get Active Chat
- 1 Send Events
- Get Chat History
- Get New Chat Events
- Upload File
- Get File
- Get Agent Profile Photo
- API Events
Mobile/Web API Specification
Send Events
Send Events sends events from the client to the server side and returns events from the server.
URI
http[s]://<host>:<port>/clientweb/api/v1/chats/{chatId}/events?tenantUrl=<tenantUrl>
HTTP Method
POST
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
Request Body
Array of chat events (content type: application/json)
Example
{
“events”:[<array of chat events>] } |
Returns
200 – OK (content type: application/json)
Example
{
"events":[<array of new chat events from server>] } |
Errors
401 – Unauthorized
404 – Not found