Expected Parameters

get

https://mytenant.cx.onecloud.com/clientweb/api/v2/parameters

This method 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 Messaging/Chat 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

Returns

Code	Description
200	application/json with names and types of parameters that may be expected from the client application

Errors

Code	Description
403	Forbidden

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

tenantUrl

string

Identifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).

Headers

Authorization

string

appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. clientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to "WebChat", HTTP cookies will be used for client identification.

User-Agent

string

Response

defaultdefault