From Bright Pattern Documentation
Contents
- Introduction
- API Methods
- General Information
- 1 Check Availability
- Expected Parameters
- Request Chat
- Request SMS Chat Session
- 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
Check Availability
| Description | Returns the current status of configured services. The notAvailable status normally means that the office providing the requested service is currently closed. |
| URI | http[s]://<host>:<port>/clientweb/api/v1/availability?tenantUrl=<tenantUrl> |
| Method | GET |
| Returns | 200 – Names of configured services with current status (content type: application/json). Example:
{ "chat": “<available|notAvailable>” } |
| Errors | 401 – Unauthorized |