Skip to main content
POST
Create SIP trunk

Authorizations

Authorization
string
header
required

Send your organization API key as Authorization: Bearer <key>.

Body

application/json

Create a SIP trunk; passwords are write-only on the wire.

pbx
enum<string>
required

PBX vendor preset or generic for other/custom PBX configurations.

Available options:
3cx,
yeastar,
webex,
generic
caller_id_transforms
object[]
inbound_host
string | null

Inbound SIP host or domain; when inbound auth is acl, this host is ACL-validated for inbound traffic.

inbound_auth_type
enum<string> | null

How inbound SIP is authenticated. acl: carrier traffic must match the ACL; inbound_host is the ACL-validated host. digest: SIP digest authentication. none: no inbound auth configured.

Available options:
digest,
acl,
none
inbound_sip_username
string | null
inbound_sip_password
string | null

Inbound SIP secret if required.

outbound_host
string | null

Host to dial for outbound calls, on-call, and transfers.

outbound_sip_username
string | null
outbound_sip_password
string | null

Outbound SIP secret if required.

register
boolean | null

Enable outbound registration when true.

remain_in_dialog
boolean | null

Response

Created trunk

SIP connectivity profile for a supported PBX integration.

id
string<uuid>
created_at
string<date-time>
pbx
enum<string>

PBX vendor preset (3cx, yeastar, webex) applying default trunk behavior, or generic for other / custom PBX setups where you supply hosts and credentials explicitly.

Available options:
3cx,
yeastar,
webex,
generic
caller_id_transforms
object[]

Ordered transforms applied to caller id.

inbound_host
string

Inbound SIP host or domain. When inbound_auth_type is acl, this is the host validated against the ACL (allowed source for inbound calls).

inbound_auth_type
enum<string>

How inbound SIP is authenticated. acl: carrier traffic must match the ACL; inbound_host is the ACL-validated host. digest: SIP digest authentication. none: no inbound auth configured.

Available options:
digest,
acl,
none
inbound_sip_username
string

SIP user for inbound registration if used.

inbound_registration_status
enum<string>

Last known SIP registration outcome for the trunk leg.

Available options:
not_registered,
pending,
registered,
failed,
auth_failed
outbound_host
string

SIP host used for outbound legs: platform-initiated calls, on-call flows, and transfers dial out via this host (your carrier or SBC).

outbound_sip_username
string

Credentials username for outbound, if any.

register
boolean

Whether the platform registers this trunk with the carrier.

outbound_registration_status
enum<string>

Last known SIP registration outcome for the trunk leg.

Available options:
not_registered,
pending,
registered,
failed,
auth_failed
remain_in_dialog
boolean

Keeping SIP dialog routing behavior when true.