Skip to main content
POST
Create the Agent channel

Authorizations

Authorization
string
header
required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Body

application/json

Connects a managed voice number as an Agent channel.

accountSid
string
required
Required string length: 1 - 160
authToken
string
required
Required string length: 1 - 2000
kind
string
required
Allowed value: "number"
phoneNumber
string
required

International telephone number in E.164 form.

Pattern: ^\+[1-9]\d{7,14}$
Example:

"+573001234567"

agentId
string

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

displayName
string
Required string length: 1 - 160

Response

OK

Created channel plus a human setup capability when the provider requires one.

channel
Agent channel · object
required

Provider-neutral organization endpoint and its current Agent assignment.

authorization
Agent channel authorization · object

Short-lived human authorization capability for completing provider channel setup.