create a new sip trunk

API Docs by APIMATIC

Create a New SIP Trunk

Use this method to create a new SIP trunk on the account.

This endpoint requires authentication.

POST /trunks
  • EXPLORER
  • PARAMETERS
Endpoint Arguments*
Parameters*
body (CreateSIPTrunkRequest)*

Configuration parameters of the SIP trunk to be created

User-defined name of the SIP trunk

Password set for the SIP trunk

Caller ID to be set for the SIP trunk

Indicates if connection to the SIP trunk is allowed from whitelisted IPs only

Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites

Indicates if max call duration limit is activated for the SIP trunk.

Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.

Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.

Indicates if a custom dial plan is activated for the SIP trunk.

Indicates if Caller ID passthrough feature is activated for the SIP trunk.

host_request (HostRequest)*

If specified, SIP trunk authentication method will be set to "IP Authentication". SIP trunk will use IP address specified in ```host_request``` for authentication. Any user with this external IP address will be able to send outgoing traffic through this trunk. Subject for Administrator review.

Public IP address to be used for identification.

Max call duration for the SIP trunk, in seconds. Cannot be higher than the max call duration set for the account.

Max cost of an outbound call, in USD.

Max number of concurrent outbound calls placed via the SIP trunk. Cannot be higher than the outbound channel capacity configured on the account.

Leading digits to be added before dialed phone numbers.

Leading digits to be deleted from dialed numbers.

allowed_ips (AllowedIps)

Whitelisted IPs for the SIP trunk.

Response Type

Errors

HTTP Status CodeError DescriptionException Class
403
Request failed. The feature is disabled for the account.
curl -X POST \
  --url 'https://api.wavix.com/v1/trunks?appid=your-API-key' \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  --data-raw '{
  "label": "My trunk",
  "password": "4r=h;EaCB85QNtr2",
  "callerid": "13132847320",
  "ip_restrict": false,
  "didinfo_enabled": true,
  "call_restrict": false,
  "cost_limit": false,
  "channels_restrict": false,
  "rewrite_enabled": true,
  "passthrough": false,
  "host_request": {}
}'