Skip to main content
POST
Create an 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.

Path Parameters

agentId
string
required

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"

Body

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

International telephone number in E.164 form.

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

"+573001234567"

mediaEncryption
enum<string>
default:required

Required media-encryption policy for a SIP channel.

Available options:
allowed,
disabled,
required
Example:

"required"

password
string
Required string length: 1 - 2000
terminationAddress
string
Required string length: 1 - 500
transport
enum<string>
default:tls

Signaling transport requested for a SIP channel.

Available options:
auto,
tcp,
tls,
udp
Example:

"tls"

username
string
Required string length: 1 - 255

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.