Skip to main content
POST
Add a new SIP trunk connection

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
name
string
required

Friendly label. Free-form.

Maximum string length: 255
phone_number
string
required

The phone number the trunk routes calls to. Stored exactly as provided.

Maximum string length: 32
gateway
string
required

Primary SIP server hostname or IP from your provider. Examples: sip.telnyx.com, sip.zadarma.com. Not a phone number, not a URL with scheme — just the host.

Maximum string length: 255
username
string
required

SIP auth username. Never returned in responses.

Maximum string length: 255
password
string
required

SIP auth password. Never returned in responses.

Maximum string length: 255
secondary_gateway
string | null

Optional fallback SIP server. Same format as gateway. Leave blank if your provider has only one.

Maximum string length: 255

Response

Connection created

success
boolean
message
string
data
object