Create a Sip Trunk

post https://12345-hpbx.dashmanager.com/ns-api/?object=connection&action=create

creates a sip trunk connection

Form Data

aor

string

required

Address of record (or origination match) of Sip Trunk connection. This is the value that the switch will be expecting your PBX to send in the HOST part of the URI in the from header. MUST start with "sip*@". Example: "sip*@1.2.3.4"

domain

string

required

Domain of sip trunk connection to create

address

string

required

This is the URI that your PBX will be registering to. MUST start with 'sip:'. Example: 'sip:user@abc-company.11111.service'. If setting up a static ip trunk put the ip address here

to_host_trans

string

required

Should be the same value as the 'aor' but without the 'sip*@'. Example: '1.2.3.4'

req_host_trans

string

required

Should be the same value as the 'aor' but without the 'sip*@'. Example: '1.2.3.4'

auth_user

string

This is the Sip User your PBX will be registering to. This value is not needed if using a static ip sip trunk

authentication_key

string

This is the Sip Password your PBX will use to register. The switch will generate a random key if you do not include this parameter

authentication_realm

string

Should be the same value as 'domain'. Only needed if using registration. Example: abc-company.11111.service

dial_plan

string

required

Should be the same value as 'domain'. Example: abc-company.11111.service

dial_policy

string

required

Must be set to one of the following: 'Permit All' , 'US and Canada' , 'US, Canada and Mexico' , 'Deny International', 'Continental US' or 'All 1+ Destinations'

origination_allowed

string

required

Allows inbound connections. Must be 'yes' or 'no'

termination_allowed

string

required

Allows outbound connections. Must be 'yes' or 'no'

rate_account

string

required

Must be "domain"

max_orig

int32

required

Defaults to null

Maximum number of inbound connections on the sip trunk

max_term

int32

required

Defaults to null

Maximum number of outbound connections on the sip trunk

max_total

int32

required

Defaults to null

Maximum number of total connections on the sip trunk

Responses

Language

Credentials

Request


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://12345-hpbx.dashmanager.com/ns-api/?object=connection&action=create' \
3
     --header 'Authorization: Bearer $access_token' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/x-www-form-urlencoded' \
6
     --data max_orig=null \
7
     --data max_term=null \
8
     --data max_total=null

Choose an example:

application/json

200200

400400