From Bright Pattern Documentation
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

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
  • EMAIL
  • 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":[

{

"<name>":”<type>”

},

...

]

}

Errors

401 – Unauthorized


< Previous | Next >
< Previous | Next >