Trunk Parameters

Descriptions for parameters in exported and imported Trunk CSV file.

Note: Only SIP Peer Trunk and Register Trunks can be exported and imported.
Parameter Description Importance Restriction Default Value
Name The trunk name. Required The maximum character length is 63.

Space and special characters are not allowed.

Trunk's name cannot be duplicated.

 N/A
Trunk Status Whether to enable or disable the trunk. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: Trunk Status will be filled with default value 1 if you leave this field empty.
 1
Trunk Type Trunk type. Required Permitted value:
  • register
  • did_based
  • port_based
  • private_network
Note:
  • Importing Account Trunk is not supported.
  • Trunk Typewill be filled with default value register if you leave this field empty.
 register
Transport The transport protocol that is provided by the ITSP. Required

Permitted value:

  • If Trunk Type is port_based, the permitted value is udp.
  • If Trunk Type is did_based, the permitted value is udp or tcp.
  • If Trunk Type is private_network, the permitted value is udp, tcp, or tls.
  • If Trunk Type is register, the permitted value is udp, tcp, tls, or dnsnaptr.
Note: Transport will be filled with default value udp if you leave these fields empty.
 udp
Hostname/IP The IP address or the domain of the ITSP. Required The maximum character length is 255. N/A
Port The trunk port. Required Only numbers between 0 and 65535 are allowed. N/A
Domain The domain in SIP URI of a specific header like From, To header.
Note: If the domain is not provided by ITSP, enter the same value as Hostname/IP.
 Required The maximum character length is 255. N/A
Username The username to register to the ITSP. Required if Trunk Type = register The maximum character length is 255. N/A
Password The password that is associated with the username. Required if Trunk Type = register The maximum character length is 255. N/A
Authentication Name The authentication name to register to the ITSP. Optional The maximum character length is 255. N/A
Enable Outbound Proxy Whether to enable or disable outbound proxy. Required if Trunk Type = register Permitted value:
  • 0: Disable
  • 1: Enable
Note: Enable Outbound Proxy will be filled with default value 0 if you leave this field empty.
 0
Outbound Proxy Server The address of outbound proxy server. Required if Enable Outbound Proxy = 1 The maximum character length is 255. N/A
Port of Outbound Proxy Server The port of outbound proxy server. Required if Enable Outbound Proxy = 1 Only numbers between 1 and 65535 are allowed. N/A
Codec Setting The audio codec for trunk. Required Permitted value: ulaw, alaw, g729, gsm, h264, h263, h263p, ilbc, g722, g726, speex, adpcm, vp8, or mpeg4, opus.

For multiple Codec, please enter values in order and use & as a separator, e.g. {first_value}&{second_value}.

Note: If the value you enter is not permitted, Codec Setting will be skipped.
 ulaw&alaw&gsm&h264&ilbc&g722&g726&g729
DTMF Mode The default mode for sending DTMF tones. Required Permitted value: rfc4733, info, inband, or auto.
Note: DTMF Mode will be filled with default value rfc4733 if you leave this field empty.
 rfc4733
DTMF FMTP The value of the DTMF fmtp attribute when the DTMF mode is rfc4733. Optional Permitted value: 0-16, 0-15.
Note: This field will be filled with default value 0-16 if you leave this field empty.
 0-16
Qualify Whether to send SIP OPTION packet to check if the SIP device is up. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: Qualify will be filled with default value 1 if you leave this field empty.
 1
Enable SRTP Whether to enable or disable SRTP (encrypted RTP) for the trunk. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: Enable SRTP will be filled with default value 0 if you leave this field empty.
 0
T.38 Support Whether to enable or disable T.38 fax. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: T.38 Support will be filled with default value 0 if you leave this field empty.
 0
Inband Progress Whether to enable or disable inband progress. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: Inband Progress will be filled with default value 0 if you leave this field empty.
 0
Ignore 183 Message without SDP Whether to ignore 183 messages without SDP. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: Ignore 183 Message without SDP will be filled with default value 0 if you leave this field empty.
 0

Forward the 180 (SDP) Message Following the Peer's Format

 Whether the PBX will send a 180 message with SDP, depending on whether the 180 message received from the other party contains SDP. Required Permitted value:
  • 0: Disable
  • 1: Enable
Note: Forward the 180 (SDP) Message Following the Peer's Format will be filled with default value 0 if you leave this field empty.
 0
Dedicated Trunk Whether it is a dedicated trunk that requires a dedicated internal IP address for connection. Optional Permitted value:
  • 0: Disable
  • 1: Enable
Note: Dedicated Trunk will be filled with default value 0 if you leave this field empty.
 0
Enable SIP Authentication Cache Whether the PBX will cache successful SIP authentication credentials and reuse them for subsequent requests (INVITE and BYE) within the same session or registration cycle. Optional Permitted value:
  • 0: Disable
  • 1: Enable
Note: Enable SIP Authentication Cache will be filled with default value 0 if you leave this field empty.
 0
Force SIP URI Scheme Whether to forcibly use sip: URI scheme instead of sips: in registration requests to change SIP transport from encrypted to unencrypted. Optional Permitted value:
  • 0: Disable
  • 1: Enable
Note:
  • Only available when Trunk Type is set to register and Transport is set to tls or dnsnaptr.
  • Force SIP URI Scheme will be filled with default value 0 if you leave this field empty.
 0
Ignore 100 Trying Response Whether the PBX will ignore the 100 Trying response. Optional Permitted value:
  • 0: Disable
  • 1: Enable
Note:
  • Only available when Trunk Type is set to register.
  • Ignore 100 Trying Response will be filled with default value 0 if you leave this field empty.
 0
Support SIP REFER Whether the PBX can process the SIP REFER requests received via the trunk. Optional Permitted value:
  • 0: Disable
  • 1: Enable
Note: Support SIP REFER will be filled with default value 0 if you leave this field empty.
 0
Allow Transfer To Specify the allowed destination types for blind transfers triggered by REFER requests. Required if Support SIP REFER is set to 1 Permitted value:
  • external_number: External Number
  • internal_number: Internal Number
  • external_number&internal_number: External Number and Internal Number.
Note: Only available when Support SIP REFER is set to 1.
 N/A
Prefix The prefix of the outbound route for blind transfers triggered by REFER requests.

The PBX will prepend the prefix to the target number in the REFER request when transferring the call.

 Optional Numbers and characters * # ( ) . - + are allowed.

The maximum character length is 7.

Note: Only available when Support SIP REFER is set to 1, and Allow Transfer To is set to external_number or external_number&internal_number.
 N/A
Maximum Concurrent Calls Specify the maximum number of concurrent calls allowed in the trunk. Required Only numbers are allowed.

Specially, 0 means unlimited.

The maximum character length is 5.

Note: Maximum Concurrent Calls will be filled with default value 0 if you leave this field empty.
 0
Call Restriction Type Specify based on which type of calls to define the maximum number of concurrent calls for this trunk. Required Permitted value: outbound or all.
Note: Call Restriction Type will be filled with default value outbound if you leave this field empty.
 outbound
Default Outbound Caller ID The caller ID that is displayed on the callee's device. Optional Numbers, letters, and characters ( ) . - + * # are allowed.
The maximum character length is 31.
Note: The outbound caller ID should be supported by the ITSP.
 N/A
Default Outbound Caller ID Name The caller ID name that is displayed on the callee's device. Optional The maximum character length is 127. N/A
Get Caller ID From Decide from which header field will the trunk retrieve Caller ID. Required Permitted value:
  • follow_system: [Follow System]
  • from: From
  • contact: Contact
  • rpid: Remote-Party-ID
  • pai: P-Asserted-Identity
  • ppi: P-Preferred-Identity
Note: Get Caller ID From will be filled with default value follow_system if you leave this field empty.
 follow_system
Get DID From Different devices or providers may contain DID numbers in different SIP headers. When an inbound call through a SIP trunk reaches the PBX, the PBX needs to retrieve a correct DID number, or the call will fail.

Adjust the setting after analysis of the SIP packets sent from the trunk provider.

Required Permitted value:
  • follow_system: [Follow System]
  • to: To
  • invite: Invite
  • diversion: Diversion
  • rpid: Remote-Party-ID
  • pai: P-Asserted-Identity
  • ppi: P-Preferred-Identity
  • pcpid: P-Called-Party-ID
Note: Get DID From will be filled with default value follow_system if you leave this field empty.
 follow_system
From User Part A From header contains caller ID and caller ID name.

From User Part indicates caller ID.

 Required Permitted value:
  • default: [Default]
  • ext_cid: Extension Caller ID
  • trunk_user: Trunk Username
    Note: Only available when Trunk Type is set to register.
  • trunk_def_outbcid: Trunk Outbound Caller ID
  • ext_outbcid: Extension's Outbound Caller ID in Trunk
  • outrounter_outbcid: Outbound Route Outbound Caller ID
  • originator_cid: Originator Caller ID

  • A customized value.

    Note: Fill in a desired value directly. The maximum character length is 31. Only numbers, letters, and characters ( ) . - + * # are allowed.
Note: From User Part will be filled with default value default if you leave this field empty.
 default
From Display Name Part

A From header contains caller ID and caller ID name.

From Display Name Part indicates caller ID name.		 Required Permitted value:
  • default: [Default]
  • ext_cid_name: Extension Caller ID Name
  • trunk_def_outbcid_name: Trunk Outbound Caller ID Name
  • ext_outbcid_name: Extension's Outbound Caller ID Name in Trunk
  • originator_cid_name: Originator Caller ID Name

  • A customized value.

    Note: Fill in a desired value directly. The maximum character length is 63.
Note: From Display Name Part will be filled with default value default if you leave this field empty.
 default
Diversion Define the parameters included in the Diversion SIP header. Optional Permitted value:
  • default: [Default]
  • ext_cid: Extension Caller ID
  • trunk_user: Trunk Username
    Note: Only available when Trunk Type is set to register.
  • trunk_def_outbcid: Trunk Outbound Caller ID
  • ext_outbcid: Extension's Outbound Caller ID in Trunk
  • outrounter_outbcid: Outbound Route Outbound Caller ID
  • originator_cid: Originator Caller ID

  • A customized value.

    Note: Fill in a desired value directly. The maximum character length is 31. Only numbers, letters, and characters ( ) . - + * # are allowed.
Note: Leave Diversion field empty means [None]: do not send this parameter with SIP INVITE packet.
 N/A
Remote-Party-ID Define the parameters included in the Remote-Party-ID SIP header. Optional Permitted value:
  • default: [Default]
  • ext_cid: Extension Caller ID
  • trunk_user: Trunk Username
    Note: Only available when Trunk Type is set to register.
  • trunk_def_outbcid: Trunk Outbound Caller ID
  • ext_outbcid: Extension's Outbound Caller ID in Trunk
  • outrounter_outbcid: Outbound Route Outbound Caller ID
  • originator_cid: Originator Caller ID

  • A customized value.

    Note: Fill in a desired value directly. The maximum character length is 31. Only numbers, letters, and characters ( ) . - + * # are allowed.
Note: Leave Remote-Party-ID field empty means [None]: do not send this parameter with SIP INVITE packet.
 N/A
P-Asserted-Identity Define the parameters included in the P-Asserted-Identity SIP header. Optional Permitted value:
  • default: [Default]
  • ext_cid: Extension Caller ID
  • trunk_user: Trunk Username
    Note: Only available when Trunk Type is set to register.
  • trunk_def_outbcid: Trunk Outbound Caller ID
  • ext_outbcid: Extension's Outbound Caller ID in Trunk
  • outrounter_outbcid: Outbound Route Outbound Caller ID
  • originator_cid: Originator Caller ID

  • A customized value.

    Note: Fill in a desired value directly. The maximum character length is 31. Only numbers, letters, and characters ( ) . - + * # are allowed.
Note: Leave P-Asserted-Identity field empty means [None]: do not send this parameter with SIP INVITE packet.
 N/A
P-Preferred-Identity Define the parameters included in the P-Preferred-Identity SIP header. Optional Permitted value:
  • default: [Default]
  • ext_cid: Extension Caller ID
  • trunk_user: Trunk Username
    Note: Only available when Trunk Type is set to register.
  • trunk_def_outbcid: Trunk Outbound Caller ID
  • ext_outbcid: Extension's Outbound Caller ID in Trunk
  • outrounter_outbcid: Outbound Route Outbound Caller ID
  • originator_cid: Originator Caller ID

  • A customized value.

    Note: Fill in a desired value directly. The maximum character length is 31. Only numbers, letters, and characters ( ) . - + * # are allowed.
Note: Leave P-Preferred-Identity field empty means [None]: do not send this parameter with SIP INVITE packet.
 N/A
From Host Part Define the domain or IP address to be used in the From field of a SIP INVITE header. Required
Note: This parameter is only required for Peer Trunks.
Permitted value:
  • default: [Default]
  • A customized value.
    Note: Fill in a desired value directly. The maximum character length is 255.
 default
To Host Part Define the domain or IP address to be used in the To field of a SIP INVITE header. Required
Note: This parameter is only required for Peer Trunks.
Permitted value:
  • default: [Default]
  • A customized value.
    Note: Fill in a desired value directly. The maximum character length is 255.
 default
User Agent If the ITSP requires User Agent for authentication, enter the User Agent information that is provided by the ITSP. Optional The maximum character length is 255. N/A
Realm Realm is a string displayed to users so they know which username and password to use. Optional The maximum character length is 255. N/A
Send Privacy ID Whether to send the Privacy ID in SIP header or not. Required Permitted value:
  • 0: Disable
  • 1: Enable
 0
User Phone Whether to add the parameter user=phone as a request line in the header field of the SIP INVITE packet. Required Permitted value:
  • 0: Disable
  • 1: Enable
 0
Send X-OpenAPI-Call-ID Set whether to include a X-OpenAPI-Call-ID field in the SIP INVITE packet to carry the Call ID for inbound calls and outbound calls routed through the trunk. Required Permitted value:
  • 0: Disable
  • 1: Enable
 0
100rel Configure 100rel for this trunk. Required Permitted value:
  • Required: 100rel is required for this trunk.
  • Supported: 100rel is supported by this trunk.
  • Disabled: 100rel is disabled for this trunk.
 Disabled
Maxptime Select the value of the Maxptime used when the PBX sends the INVITE packet. Required Permitted value:
  • default: PBX will send a corresponding maxptime value according to the codec that is used for the outbound call.
  • A customized value.
    Note: Fill in a desired value directly. The value must be the multiple of 10 ranging from 20 to 300.
Note: Maxptime will be filled with default value default if you leave this field empty.
 default
Support P-Early-Media Set whether the P-Early-Media field is included in the INVITE packet. Required Permitted value:
  • 0: Disable
  • 1: Enable
 0
DID/DDI A virtual number that is used to identify which path of the trunk is passing the call.

Required if Trunk Type = register or did_based

The maximum character length is 31.

Note:
  • If Trunk Type = register or did_based: Numbers, letters, and characters ( ) . - + * # are allowed.
  • If Trunk Type = port_based or private_network: Numbers, letters, and characters [ ] * # ( ) . - + ! are allowed.
 N/A
DID/DDI Name The name of DID/DDI that is used to identify which path of the trunk is passing the call. Optional The maximum character length is 127. N/A
Force Selected DOD in From Header Whether to ignore the trunk's From User Part setting and forcibly use the extension's selected DOD number in the From header when the extension selects a specific DOD to make an outbound call. Optional Permitted value:
  • 0: Disable
  • 1: Enable
Note: Force Selected DOD in From Header will be filled with default value 1 if you leave this field empty.
 1
Return 302 on External Forward Whether to return a 302 Moved Temporarily response to the caller when forwarding an inbound call to an external number, allowing the carrier to redirect the call directly.

Optional

Permitted value:
  • 0: Disable
  • 1: Enable
Note: Return 302 on External Forward will be filled with default value 0 if you leave this field empty.
 0