Skip to main content
Provision Sip Trunk

Authorizations

X-API-Key
string
header
required

Headers

authorization
string | null
X-API-Key
string | null

Body

application/json

Body for POST /sip-trunks/provision: a SIP trunk from any carrier plus the numbers on it.

name
string
required
Required string length: 1 - 64
address
string
required

SIP trunk host your carrier gave you, e.g. trunk.example.com

numbers
string[]
required

E.164 numbers on this trunk; the first is the caller ID

Required array length: 1 - 50 elements
username
string | null

SIP login (blank if the carrier authorises by IP)

password
string | null

SIP password

transport
string | null
default:tcp

tcp (recommended), tls or udp

country_code
string | null
Required string length: 2
is_default_outbound
boolean
default:false

Response

Successful Response

Whether a line can place calls now; reason is written for the customer and never carries carrier text.

configuration_id
integer
required
ready
boolean
required
route_id
integer | null
route_state
string | null
numbers
string[]
reason
string | null