sip trunk configuration

API Docs by APIMATIC

SIP Trunk Configuration

The SIP trunk configuration parameters.

Fields

NameDescription
label Required
String

User-defined name of the SIP trunk

password Required
String

Password set for the SIP trunk

callerid Required
String

Caller ID to be set for the SIP trunk

ip_restrict Required
Boolean

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

didinfo_enabled Required
Boolean

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

call_restrict Required
Boolean

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

call_limit
Number

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

cost_limit Required
Boolean

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

max_call_cost
Decimal

Max cost of an outbound call, in USD.

channels_restrict Required
Boolean

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

max_channels
Number

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

rewrite_enabled Required
Boolean

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

rewrite_prefix
String

Leading digits to be added before dialed phone numbers.

rewrite_cond
String

Leading digits to be deleted from dialed numbers.

passthrough Required
Boolean

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

allowed_ips

Whitelisted IPs for the SIP trunk.

host_request

Allows to add public IP address to be used for identification for a SIP trunk.

{
  "label": "My trunk",
  "password": "4r=h;EaCB85QNtr2",
  "callerid": "13132847320",
  "ip_restrict": false,
  "didinfo_enabled": true,
  "call_restrict": false,
  "cost_limit": null,
  "channels_restrict": false,
  "rewrite_enabled": true,
  "passthrough": null
}