Skip to main content
POST
Create SIP trunk

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json
name
string
required

Display name, 1 to 100 characters.

Value constraints

Required string length: 1 - 100
direction
enum<string>
required

Specifies direction for this management platform access create sip trunk request.

Allowed values

Available options:
inbound,
outbound,
both
projectId
string<uuid>

Project that owns the trunk. Required for organization keys; project keys use their own project.

Value constraints

enabled
boolean

Defaults to true.

outbound
object

Specifies outbound for this management platform access create sip trunk request.

inbound
object

Specifies inbound for this management platform access create sip trunk request.

codecs
enum<string>[]

Distinct codecs in preference order. Defaults to PCMU, PCMA, opus.

Allowed item values

Value constraints

Required array length: 1 - 3 elements
Available options:
PCMU,
PCMA,
opus
maxConcurrentCalls
integer

1 to 500. Defaults to 30.

Value constraints

Required range: 1 <= x <= 500

Response

SIP trunk created. Store inboundCredentials.password now; it cannot be retrieved later.

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.