From Bright Pattern Documentation
Contents
- Introduction
- API Methods
- General Information
- Check Availability
- 1 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
Expected Parameters
| Description | Returns an array of expected parameters. The parameters are optional. They may be used, for example, to look for the most qualified agents to handle the requested chat sessions and/or to display user information for the agents. These parameters are initially specified for the mobile/web scenario entry through which this mobile application will communicate with the contact center.
Currently the following parameter types are supported: PHONE, TEXT, EMAIL, FIRST_NAME, LAST_NAME, ACCOUNT, COMPANY. |
| URL | http[s]://<host>:<port>/clientweb/api/v1/parameters?tenantUrl=<tenantUrl> |
| Method | GET |
| Returns | 200 – Names and types of parameters that may be expected from the client application (content type: application/json). Example:
{ "parameters":[ { ] } |
| Errors | 401 – Unauthorized |