Agents API

ActiveDeploymentsResponse

object

The latest deployment for each environment (sandbox, pre-release,
live). Entries are null when no deployment exists for an environment.

activeDeploymentsobjectrequired

Latest deployment per environment (sandbox, pre-release, live). Value is null if no deployment exists for that environment.

Example

AgentRulesResponse

object
* Additional properties are NOT allowed.
behaviorstringrequired
Example

AttributeResponse

object
* Additional properties are NOT allowed.
idstringrequired
namestringrequired
Example

BatchGetConnectorsBody

object

Set of connector IDs to retrieve in a single call.

connectorIdsarray[string]required

List of connector IDs to retrieve

>= 1 items

Example

BatchGetConnectorsResponse

object

Result of a batch connector lookup, partitioned into connectors that
were found and IDs that weren’t.

foundarray[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
notFoundarray[string]required
Example