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
Get New Chat Events
Get New Chat Events returns new chat events for the current session. If there are no new events, the server can keep the request active during timeout (for about 5 to 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).
URI
http[s]://<host>:<port>/clientweb/api/v1/chats/{chatId}/events?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
400 – Bad Request
401 – Unauthorized
404 – Not Found