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
Expected Parameters
This 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
- FIRST_NAME
- LAST_NAME
- ACCOUNT
- COMPANY
URI
http[s]://<host>:<port>/clientweb/api/v1/parameters?tenantUrl=<tenantUrl>
HTTP Method
GET
Authentication
Authorization: MOBILE-API-140-327-PLAIN appId="<Unique app identifier>", clientId="<Unique client ID>"
Parameters
tenantUrl – specifies tenant if request sent not to tenant’s domain
Returns
200 – Names and types of parameters that may be expected from the client application (content type: application/json)
Example
{
"parameters":[ { ] } |
Errors
401 – Unauthorized