Skip to main content
POST
Create a carrier connection

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
carrier
enum<string>
required

Carrier to connect. Zadarma supports one active number per connection and requires a free SIP login slot.

Available options:
twilio,
telnyx,
vonage,
zadarma
name
string
required

Display name for this carrier connection.

Required string length: 1 - 80
account_sid
string

Twilio account SID. Required unless reusing a saved Twilio connection.

auth_token
string
write-only

Twilio US1 Auth Token. Required for US1 unless the source connection has one. Optional for IE1 and AU1 when setting up SMS through US1. Stored encrypted.

twilio_voice_region
enum<string>

Twilio voice processing region for a new connection. Defaults to US1. The number’s active Voice region in Twilio must already match before import.

Available options:
us1,
ie1,
au1
regional_auth_token
string
write-only

Twilio Auth Token for IE1 or AU1. Required in those regions and stored encrypted.

source_connection_id
string<uuid>

Reuse the account SID and any saved US1 Auth Token from a Twilio connection in this workspace. Omit account_sid. Supply auth_token only if the source has no US1 token.

api_key
string
write-only

Required for Telnyx, Vonage and Zadarma. Telnyx keys start with KEY.

api_secret
string
write-only

Required for Vonage and Zadarma; stored encrypted.

sip_region
enum<string>

Region of the incoming SIP endpoint. Defaults to Europe for Twilio IE1 and global for other connections.

Available options:
global,
eu,
us,
uk,
india,
japan,
aus,
sa

Response

Created connection.

data
object
required