Agents API

GetAgentsResponse

array
accountIdstringrequired
agentIdstringrequired
agentNamestringrequired
createdAtstringrequired
updatedAtstringrequired
branchCountnumberrequired

GetAttributesResponse

object
* Additional properties are NOT allowed.
attributesarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

GetConfigPageResponse

object

A single config page for one environment.

clientEnvstringrequired

Environment (sandbox, pre-release, live)

variablesobject

Config key-value pairs

schemaobject

JSON Schema (Draft 7) definition

lastUpdatedstring

ISO 8601 timestamp of last update

Example

GetConfigPagesResponse

object

One config page per environment (sandbox, pre-release, live).

configPagesarray[object]required

A real-time config page for one environment: its JSON Schema
definition plus the current variable values.

Show Child Parameters
Example

GetConnectorsResponse

object

Every connector in the project.

connectorsarray[object]required

A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.

Show Child Parameters
Example