Skip to main content
POST

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Body

application/json
carrier_name
string
required

Display name for the carrier

Required string length: 1 - 100
sip_gateway
object
required

SIP gateway endpoint. Inbound gateways (inbound: true) must use IPv4 address; hostnames are rejected by the validator because the telephony platform requires IP for SBC matching.

trunk_type
enum<string>
default:static_ip

SIP trunk authentication type:

  • static_ip - IP-based authentication (default)
  • auth - Credential-based inbound authentication
  • reg - SIP registration
Available options:
static_ip,
auth,
reg
registration
object

Required when trunk_type is 'reg'

inbound_auth
object

Required when trunk_type is 'auth'

Response

Carrier created successfully

id
string<uuid>

Carrier record ID

account_id
string<uuid>

Account UUID

voip_carrier_sid
string<uuid>

Carrier UUID (for use in phone number provisioning)

carrier_name
string

Display name

trunk_type
enum<string>
Available options:
static_ip,
auth,
reg
created_at
string<date-time>