We use cookies on our website to ensure we provide you with the best experience on our website. By using our website, you agree to the use of cookies for analytics and personalized content.This website uses cookies. More Information
It seems like your browser didn't download the required fonts. Please revise your security settings and try again.

Barracuda Phone System

What custom Route Parameters are available for outbound calling on My Barracuda Phone System?

  • Type: Knowledgebase
  • Date changed: 2 years ago

Solution #00006375

Scope:
All Barracuda Phone Systems, firmware versions 2.6.001 and later.


Answer:

While the default outbound routes and standard regex routing should match the needs of most users, there may be some scenarios where custom route parameters are needed for the Barracuda Phone System to properly route and deliver outbound calls. The following route parameters are supported on the Barracuda Phone System.


Adding Route Parameters to Outbound Routes:
Route Parameters are added the the end of the route string, separated by a leading semicolon, and are formatted as param=value. Multiple parameters are allowed on a single outbound route, provided they do not conflict each other. If two conflicting entries are set on a single route, the last entry will take precedence.


TDM Specific Route Parameters:
Some PRI trunks require custom parameters to be set on outbound calls in order to route correctly. Although not commonly necessary, the values used for PRIs are most commonly ;npi=1;ton=0 but MUST be specific to what the provider expects. Your TDM provider should ask for these if they are needed.


npi

Number Plan Index - This is the format of the dial string being sent

  0 - Unknown
  1 - ISDN/E.164
  3 - Data/X.121
  4 - Telex/F.69
  8 - National
  9 - Private
15 - Reserved


Example

^\d{10}$;npi=1


ton

Type of Network - This is the type of networking used by the PRI itself.

0 - Unknown
1 - International
2 - National
3 - Network Specific
4 - Subscriber
6 - Abbreviated
7 - Reserved


Example

^\d{10}$;ton=0



Given the value above, an outbound NANPA route with number plan national and type of network set to unknown would look like this:
^1?([2-9]\d{2}[2-9]\d{6})$:::$1;npi=8;ton=0


CallerID Route Parameters:
The route parameters in this section can be used on any provider which supports the individual feature. Most of these will apply to all current TDM and SIP providers.


privacy
This parameter sets privacy to prevent CID from being delivered via this route when used.

Valid values for this Parameter are


no - Pass name and number
yes - Block name and number
full - pass name and number
name - Pass name but block number
number - Pass number but block name


Example  
^\d{10}&;privacy=yes



diversion
This parameter removes the diversion header for calls that are redirected.
The only valid value for this parameter is 'false.'


Example
^\d{10}&;diversion=false



e911_ani 
The ANI you wish to present on the route in question.  (Does not need to be an emergency route)
Possible values include any valid phone number.

Example 
^(911)$:::$1;e911_ani=XXXXXXX





DTMF Type Route Parameters:
The route parameters in this section can be used to override our default DTMF method, RFC2833, with the specified option. This Parameter is unnecessary for built-in TDM cards.


dtmf=inband

there are no options for this Parameter


dtmf=info

there are no options for this Parameter


Other Route Parameters:

 

cmc

This parameter will permit the calling party to key in a Client Matter Code that is logged in the accountcode column on the CDR CSV.

The only valid value for this parameter is ‘true’.

Example

^(\d{10})$:::1$1;cmc=true


queue_dtmf

This parameter will send a explicitly set DTMF sequence out a trunk once the leg is successfully bridged.  For a SIP trunk, this means after receiving the 200 OK, or for a PRI trunk, after receiving the CONNECT message on the D-Channel.  On an analogue trunk, the digits are out-pulsed immediately by the TDM card in the Barracuda Phone System.  To add a wait period (for example, when the Barracuda Phone System seizes the line, dials the number, but before the call is answered), you can use a capital ‘W’ to wait 1000ms or a lower case ‘w’ to wait 500ms.  This is typically used to bypass an Interactive Voice Response menu/Automated Attendant.


Possible values include 0-9 and A-D or w or W


Example

 ^(9999)$:::17345551212;queue_dtmf=WWWWWWWWWWWWWWWWWWWWWWWW1

 This scenario waits for 3 U.S. rings (2 seconds on, 4 seconds off cadence) and then sends a 1. This example was written with an analogue trunk in mind.


 ^(011\d{8,18})$:::$1;queue_dtmf=WWW123456

This example is for a SIP or PRI trunk that answers immediately and then requires the calling party to enter a billing code. E.g. 3 seconds of silence and then enqueue '123456'. 


authenticate

Please review Solution #00006062 for information on this parameter.



Link to this page:

https://campus.barracuda.com/solution/501600000013SVbAAM