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_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, 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.

Body

application/json
carrier
enum<string>
required
Available options:
twilio,
telnyx,
vonage
name
string
required
Required string length: 1 - 80
account_sid
string

Required for Twilio.

auth_token
string
write-only

Required for Twilio; stored encrypted.

api_key
string

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

api_secret
string
write-only

Required for Vonage; stored encrypted.

sip_region
enum<string>
default:global
Available options:
global,
eu,
us,
uk,
india,
japan,
aus,
sa

Response

Created connection.

data
object
required