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

Outbound Call Route Parameters

  • Last updated on

While the default outbound routes and standard regex routing should meet the needs of most users, there may be cases where custom route parameters are required for the Barracuda Phone System to properly route and deliver outbound calls.

Route Parameters are added at the end of the route match condition, separated by a leading semicolon, with the format param=value . Multiple parameters are allowed on a single outbound route, provided they do not conflict with each other. If two conflicting entries are set on a single route, the last entry takes precedence:

^(\d{10})$:::$1;param1=value1;param2=value2

Below is list of all routing parameters. Parameters apply to all types of trunks (i.e., analog, PRI/digital, SIP), unless otherwise specified.

ParameterPossible Value(s)

Description

Remarks
npi0,1,3,4,8,9,15

Number Plan Index

0 - Unknown

1 - ISDN/E.164

3 - Data/X.121

4 - Telex/F.69

8 - National

9 - Private

15 - Reserved

Available only on PRI circuits. Only define these parameters at telco's request.

For more information, refer to ITU Q.931:

http://www.itu.int/rec/T-REC-Q.931-199805-I/en

Example - North American Numbering Plan
^1?([2-9]\d{2}[2-9]\d{6})$:::1$1;npi=8

 

 

ton0,1,2,3,4,6,7

Type of Network

0 - Unknown

1 - International

2 - National

3 - Network Specific

4 - Subscriber

Available only on PRI circuits. Only define these parameters at telco's request.

For more information, refer to ITU Q.931:

http://www.itu.int/rec/T-REC-Q.931-199805-I/en

Example - North American Numbering Plan

^1?([2-9]\d{2}[2-9]\d{6})$:::$1;ton=2

privacy

no,

yes,

full,

name,

number

no - Pass Name and Number

yes - Block Name and Number

full - Pass Name and Number

name - Pass Name but not Number

number - Pass Number but not Name

This parameter defines Caller ID restrictions.

Example - Accept specific number and suppress all caller ID

^((\+1)|(1))?7345551212$:::+17345551212;privacy=full

 

Applicable on PRI and SIP trunks only.

 

 

 

diversionfalse 

This parameter suppresses any diversion headers in INVITEs sent outbound. Diversion headers are used when a call is diverted back outbound by the telephony engine of the Barracuda Phone System when configured from an Advanced Call Router or a Find Me Forwarding action.

Example - Accept optional E.164 '+' symbol, optional 1, send 11 with + always

^((\+1)|(1))?(\d{10})$:::+1$4;diversion=false

Only applicable on SIP trunks.

e911_aniany numeric value 

This parameter will force an explicit caller ID number. It can also be used for non-emergency routes.

Example - 911

^911$:::911;e911_ani=17345551212

Only applicable on SIP trunks and PRI trunks.

dtmf

inband,

info

inband - inband RTP

info - SIP INFO transport

  • When set to inband, DTMF tones are transmitted in-band with the voice path. This is typically used for legacy SIP providers.
  • When set to info, DTMF tones are transmitted in SIP INFO packets, so the provider must acknowledge receipt of the INFO packet.
  • Do not attempt to set both of these parameters at the same time.

Without either of these values defined, the Barracuda Phone System sends DTMF tones as out-of-band RTPEVENT packets. Do not define these values unless recommended by the Telco or Support as these parameters require the telco to support these methods. Also note that forcing in-band DTMF can result in improper detection by far-end Interactive Voice Response systems/Automated Attendants. More information on out-of band RTPEVENT packets can be found here:

https://www.rfc-editor.org/rfc/rfc2833.txt

Example - Accept optional 1 require 10 digit numbers for 313 area code

^1?(313(\d{7}))$:::$2;dtmf=info

This parameter is only applicable to SIP trunks.

cmctrue 

This parameter permits the calling party to enter a Client Matters Code, for accounting purposes, before the call is bridged. The CMC, entered after dialing the number, is inserted in the accountcode column on the CSV CDR on the Reports > Call Detail Records page.

Example - Accept optional 1 + 10 digits, send out 11 digits

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

queue_dtmfW,w,0,1,2,3,4,5,6,7,8,9,*,#,A,B,C,D 

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

Example - Wait 3 U.S rings and send 1

^9999$:::17345551212;queue_dtmf=WWWWWWWWWWWWWWWWWWWWWWWW1

authenticatetrue 

In some cases, you may want to configure a route for outbound calling, and restrict the route to certain users on the system. Add an authenticated route to require a pin to be entered prior to the call being bridged. The authenticate requirement is applied after any other routing rules or matches, so it checks phone, group, and site restrictions. Once the system determines that the route can be used, the system asks for a pin number to continue the call. The pin entered is compared to the voicemail pin of the assigned user. This design leads to three restrictions to use of this feature:

  1. Unassigned Phones are not allowed to place calls outbound to any route if the authenticate value is set to true.
  2. When using the sites feature to route calls through another Barracuda Phone System, the call must authenticate before routing to the other site because authentication applies to local accounts only.
  3. Using IP-Based Authentication for remote devices supersedes the route authentication check. Due to this, these sites cannot be restricted by a PIN.

    Example - Authenticate Callers for International Calls and send E.164

    ^011(\d{8,18})$:::+$1;authenticate=true

Last updated on