Skip to main content
POST

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Makes a retry safe. A 2xx response is stored for 24 hours per account, and a retry with the same key gets it back with Idempotent-Replay: true instead of running again. Errors aren't stored, so a retry after one runs fresh. The key isn't tied to a path or body: use a new key for every different request. A malformed key gets 400.

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. Must be unique on your account.

Required string length: 1 - 100
sip_gateway
object
required

Primary gateway, used for outbound calls. With inbound: true, ipv4 must be an IPv4 address: inbound calls are matched by source IP.

trunk_type
enum<string>
default:static_ip

How the trunk authenticates:

  • static_ip: matched by source IP.
  • auth: SIP credentials on inbound calls. Requires inbound_auth.
  • reg: SIP registration. Requires registration.
Available options:
static_ip,
auth,
reg
inbound_gateways
object[]

Extra inbound-only source ranges, for a trunk that sends calls from more than one address.

Maximum array length: 16
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. Use it to delete the carrier.

account_id
string<uuid>

Account UUID

voip_carrier_sid
string<uuid>

Pass as voip_carrier_sid when adding a number on this carrier.

carrier_name
string

Display name

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