Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel

In this section:

Table of Contents

 

Call routing allows call routes and routing labels to be configured. The route has fields which are matched against call characteristic. It also contains a reference to a routing label which is selected when a match is successful. The matching process is partially controlled by Element Routing Priority.

The following diagram shows multiple routes referencing Routing Label.

Image Removed
Caption
0Figure
1Route and Route Label Objects

Image Added

The 

Spacevars
0product
supports  supports route lookups based on the following:

  • Destination National
  • Destination Country
  • Username
  • Domain Name
  • Ingress Trunk group or Carrier or Calling Number
  • Call Type
  • Digit Type
  • Day of Week, Time of Day, Holidays and Special Days
  • Call Parameters

Global Call Routing Parameters - Route

Command Syntax

Code Block
languagenone
% set global callRouting route
	callingNumber <Element Id 1> <Element Id 2>
		<relay | standard | username> 
		<Destination National>
		<Destination Country>
		<Call type options>
		<Digit type options>
		<Time Range Profile>
		<Call Parameter Filter Profile>
		<Domain Name>
	carrier <Element Id 1> <Element Id 2>
		<relay | standard | username> 
		<Destination National>
		<Destination Country>
		<Call type options>
		<Digit type options>
		<Time Range Profile>
		<Call Parameter Filter Profile>
		<Domain Name>
	none <Element Id 1> <Element Id 2>
		<relay | standard | username>
		<Destination National>
		<Destination Country>
		<Call type options>
		<Digit type options>
		<Time Range Profile>
		<Call Parameter Filter Profile>
		<Domain Name>
	trunkGroup <Element Id 1> <Element Id 2>
		<relay | standard | username>
		<Destination National>
		<Destination Country>
		<Call type options>
		<Digit type options>
		<Time Range Profile>
		<Call Parameter Filter Profile>
		<Domain Name>
 
% show global callRouting route 

% delete global callRouting route 
	callingNumber
	carrier
	none
	trunkGroup

Command Parameters

Div
classpdf8pttext
Caption
0Table
1Global Call Routing Parameters - Route

Parameter

Description

callingNumber
Use this parameter to specify Calling Number originating entity type.
  • <Element Id 1> – Enter calling number. (range: 0-31)
  • <Element Id 2> – Enter calling country. (range: 0-31)
  • <standard | username> – Use the standard option when the called party is a number that is for calledNumber or calledNumber@domain/ipAddress. Use the username option when the called party is a username that is for username or username@domain/ipAddress.
  • <Destination National> – For standard routing type, the value is the national number component of the called number. Leading digits or the complete number can be provisioned. (range: 0-63).
  • <Destination Country> – For standard routing type, the value is the called country code. For username routing type, the value is Sonus_NULL. (range: 0-15).
  • <Call Type> – See Call Type Options table below for options.
  • <Digit Type> – See Digit Type Options table below for options.
  • <Time Range Profile> – Time range profile assigned to this route. Use the default profile ALL or a custom profile. (range: 0-23).
  • <Call Parameter Filter Profile> – The Call Parameter Filter Profile to associate with this route. (range: 0-23).
  • <Domain Name> – Destination domain name (e.g. a reference to the SIP domain  ) (range: 0-63)
carrier
Use this parameter to specify Carrier originating entity type.
  • <Element Id 1> – Enter carrier name. (range: 0-31)
  • <Element Id 2> – Value is Sonus_NULL. (range: 0-31)
  • <standard | username> – Use the standard option when the called party is a number that is for calledNumber or calledNumber@domain/ipAddress. Use the username option when the called party is a username that is for username or username@domain/ipAddress.
  • <Destination National> – For standard routing type, the value is the national number component of the called number. Leading digits or the complete number can be provisioned. (range: 0-63).
  • <Destination Country> – For standard routing type, the value is the called country code. For username routing type, the value is Sonus_NULL. (range: 0-15).
  • <Call Type> – See Call Type Options table below for options.
  • <Digit Type> – See Digit Type Options table below for options.
  • <Time Range Profile>Time range profile assigned to this route. Use the default profile ALL or a custom profile. (range: 0-23).
  • <Call Parameter Filter Profile> – The Call Parameter Filter Profile to associate with this route. (range: 0-23).
  • <Domain Name> – Destination domain name (e.g. a reference to the SIP domain  ) (range: 0-63)
none
Use this parameter to specify no originating entity type.
  • <Element Id 1> – Value is Sonus_NULL. (range: 0-31)
  • <Element Id 2> – Value is Sonus_NULL. (range: 0-31)
  • <standard | username> – Use the standard option when the called party is a number that is for calledNumber or calledNumber@domain/ipAddress. Use the username option when the called party is a username that is for username or username@domain/ipAddress.
  • <Destination National> – For standard routing type, the value is the national number component of the called number. Leading digits or the complete number can be provisioned. (range: 0-63).
  • <Destination Country> – For standard routing type, the value is the called country code. For username routing type, the value is Sonus_NULL. (range: 0-15).
  • <Call Type> – See Call Type Options table below for options.
  • <Digit Type> – See Digit Type Options table below for options.
  • <Time Range Profile>Time range profile assigned to this route. Use the default profile ALL or a custom profile. (range: 0-23).
  • <Call Parameter Filter Profile> – The Call Parameter Filter Profile to associate with this route. (range: 0-23).
  • <Domain Name> – Destination domain name (e.g. a reference to the SIP domain  ) (range: 0-63)
trunkGroup
Use this parameter to specify Trunk Group originating entity type.
  • <Element Id 1> – Enter ingress trunk group. (range: 0-31)
  • <Element Id 2> – Enter system name. (range: 0-31)
  • <standard | username>– Use the standard option when the called party is a number that is for calledNumber or calledNumber@domain/ipAddress. Use the username option when the called party is a username that is for username or username@domain/ipAddress.
  • <Destination National> – For standard routing type, the value is the national number component of the called number. Leading digits or the complete number can be provisioned. (range: 0-63).
  • <Destination Country> – For standard routing type, the value is the called country code. For username routing type, the value is Sonus_NULL. (range: 0-15).
  • <Call Type> – See Call Type Options table below for options.
  • <Digit Type> – See Digit Type Options table below for options.
  • <Time Range Profile>Time range profile assigned to this route. Use the default profile ALL or a custom profile. (range: 0-23).
  • <Call Parameter Filter Profile> – The Call Parameter Filter Profile to associate with this route. (range: 0-23).
  • <Domain Name> – Destination domain name (e.g. a reference to the SIP domain  ) (range: 0-63)

NOTE: For entity type 'trunkGroup', the gateway component name must be in all UPPER case. For example:

 
set global callRouting route trunkGroup Carrier1 GATEWAY2 standard Sonus_NULL 1 nationalType nationalType ALL none Sonus_NULL routingLabel To_ABC_Core

Call Type Options:

Caption
0Table
1Call Type Options
3Call Type Options

Call type options for standard and username:

All

carrierCutThrough

internationalOperator

internationalType

ipVpnService

localOperator

longDistanceOperator

mobile

nationalOperator

nationalType

otherCarrierChosen

private

test

transit

userName

Digit Type Options:

Caption
0Table
1Digit Type Options
3Digit Type Options

_900PremiumToll

_950CarrierAccess

all

carrierAccess

directoryAssistance

easilyIdentifiableNumber

emergency

governmentEmergency

ieps

internationalOperator

internationalType

ipVpn

localOperator

longDistanceOperator

nationalOperator

nationalType

noDigits

otherCarrierChosen

private

serviceAccessCode

subscriberOperator

subscriberType

test

tollFree

transit

username

verticalServiceCode

 

 

 

Global Call Routing Parameters - Routing Label

Command Syntax

Code Block
languagenone
% set global callRouting routingLabel <Id>
	action <routes | scripts>
	numRoutesPerCall <integer>
	overflowNOA 
	overflowNPI <data | isdn | none | private | spare0Unknown | spare1...spare7 | telex>
	overflowNumber <string>
	routePrioritizationType <allProportionAllocation | leastCostRouting | proportionAllocation | roundRobin | sequence>
	routingLabelRoute <0-32000> 
		cost <1-1000000>
		inService <inService | outOfService>
		ipPeer <name>
		proportion <0-999>
		testing <nonTest | normal | test>
		trunkGroup <name>
   script <script>
 
% show global callRouting routingLabel

% delete global callRouting routingLabel <id>

Command Parameters

Div
classpdf6pttext
Caption
0Table
1Global Call Routing Parameters - Routing Label

Parameter

Length/Range

Description

routingLabel

1-23

<Id> – The Routing Label ID which identifies a set of up to 200 Routes (199 or fewer Routes if you want to include an Overflow Number) and/or a Script.

action

N/A

Type of action to be taken by the routing label. Options are:

  • routes – This routing label returns a set of routes.
  • script – Routing label returns a script. Enter script to select script type (see script parameter below)
numRoutesPerCall1-10

The maximum number of routes per call for the specified routing label (default = 10).

overflowNOA

Integer

The overflow Nature Of Address (NOA). See Routing Label Overflow NOA Parameters table below for list of options.

overflowNPI

N/A

Overflow Numbering Plan Indicator (NPI). Options are:

  • data
  • isdn
  • none
  • private
  • spare0Unknown
  • spare1 - spare7
  • telex

overflowNumber

0-31

If the overflow number is present, it is used to determine a routing label and additional routes that will be associated with the call.

routePrioritizationType

N/A

Determines how the Embedded Routing Engine (ERE) allocates the routes contained within this routing label. Options are:

  • allProportionAllocation – The ERE uses proportions to determine the order of all of the the routes in the route list on a call-by-call basis (compared to proportionAllocation which determines first route only). For the first route, the ERE follows the process described below for the Proportion option by generating a random number. For the second route, the ERE recalculates the random number and determines the route, and then generates a new random number. The ERE continues this process to determine each of the remaining routes in the route list.
  • leastCostRouting– The ERE determines the routes by cost, the least (lowest) cost route being the first priority route selected. Each route can be configured with a cost value in the Route dialog box.
    • routePrioritizationTypeForEqualCostRoutes In the case of equal cost routes, the Route Prioritization Type for Equal Cost Routes parameter is used to select a secondary route prioritization type.
  • proportionAllocation – The ERE uses this option to to determine the first route (only) on a call-by-call basis. For example, a Route Label contains three routes with assigned proportions of 80, 50, and 30. The system generates a random number in this case between 0 and 159. If the number is between 0 and 79, the system assigns the route with the 80 proportion as the first route. If the random number is between 80 and 129, the system assigns the route with the 50 proportion as the first route. If the random number is between 130 and 159, the system assigns the route with the 30 proportion as the first route.
  • roundRobin – The ERE distributes the call traffic equally across the routes in a Routing Label. For each call, the routes are cyclically rotated by one position. For example, call 1 receives routes 1, 2, 3; call 2 receives routes 2, 3, 1; call 3 receives routes 3,1, 2, and so on.
  • sequence – The ERE allocates the routes in the order of the values provided in the route Sequence field.

routingLabelRoute

0-32000

Defines the data rows for Routing Label. Options are:

  • cost – A value indicating the relative cost of this route to the carrier. The cost value is used in least cost routing calculations; returned routes are ordered based on cost in ascending order (the least cost route will be the first one in the returned route list).  
    (range: 1-1000000 / default is 1000000).
  • inService – Flag to indicate if route is available for routing.
    • inService (default)
    • outOfService
  • ipPeer – IP address assigned to the far end of the trunk group.
  • proportion – Indicates a value that specifies the proportion of calls whether this route should be the first route choice. If three routes are assigned to this Routing Label with proportions 80, 70, 50, the SBC returns the route assigned the proportion of 80 as the first route 40% of the time (80/ 200). The total can be any whole number. (range: 0-999 / default = 9).
  • testing – Mode for making test calls and verifying routes before using them.
    • nonTest – When selected, the ERE does not return the route when the Calling Party Category (CPC) value in a Policy Request is Test Call range of values. When the CPC range of values is not Test Call or is not present in the Policy Request, the ERE returns the route.
    • normal – When selected, the ERE returns the route regardless of the CPC value, or absence of a CPC value, received in the policy request. (Default setting). After testing and verifying a route, select this option to use the route for live calls.
    • test – When the CPC value in a Policy Request is Test Call, the ERE returns the route. When the CPC value is not Test Call or is not present in the policy request, the ERE does not return the route.
  • trunkGroup – The name of the trunk group for this route.

script

N/A

Anchor
ScriptParameter
ScriptParameter
Defines script type. Default scripts include:

  • BLOCKING – Script for call termination based on blocking criteria that has been met.
  • DEFAULT_TERMINATING – Script with Release Cause Code set to 16 (Normal Call Clearing).
  • NONSUB_DENY – Non-subscriber call not allowed. Script for call termination because call is from a Calling Party which is not present in the ERE Subscriber table.
  • NO_ROUTES_FOUND – No routes found for the call. Script for calls that have traversed the ERE, but a valid call route match was not found.
  • SCREENING – Script for call termination based on screening criteria that has been met.
  • TANDEM – The default successful call routing script.

Routing Label Overflow NOA Parameters:

Caption
0Table
1Routing Label Overflow NOA Parameters
3Routing Label Overflow NOA Parameters
950aniNotAvailableOrNotProvided
aniOfCalledPartyNationalNumberaniOfCalledPartyNoNumberPresent
aniOfCalledPartySubscriberNumberaniOfCallingPartyNationalNumber
aniOfCallingPartySubscriberNumberany
apnNumberingPlanignore
internationalinternationalNotRestricted
internationalOperatorinternationalRestricted
nationalnationalNotRestricted
nationalOperatornationalRestricted
networkSpecificnone
noNumberCutThroughnoNumberOperatorRequested
partialCallingLineIdpassThrough
sidNumberspare00
spare01spare02
spare03spare04
spare05spare06
spare07spare08
spare09spare0A
spare0Bspare0C
spare0Dspare0E
spare0Fspare10
spare11spare12
spare13spare14
spare15spare16
spare17spare18
spare19spare1A
spare1Bspare1C
spare1Dspare1E
spare1Fspare20
spare21spare22
spare23spare24
spare25spare26
spare2Aspare2B
spare2Cspare2D
spare2Espare2F
spare3Aspare3B
spare3Cspare3D
spare3Espare3F
spare4Aspare4B
spare4Cspare4D
spare4Espare4F
spare5Aspare5B
spare5Cspare5D
spare5Espare5F
spare6Aspare6B
spare6Cspare6D
spare6Espare6F
spare7Aspare7B
spare7Cspare7D
spare7Espare7F

Command Examples

Code Block
languagenone
% show global callRouting
route none Sonus_NULL Sonus_NULL standard Sonus_NULL 1 nationalType subscriberType,nationalType ALL none Sonus_NULL {
routingLabel REHL2_2;
}
route none Sonus_NULL Sonus_NULL standard Sonus_NULL 1 nationalType subscriberType,nationalType ALL none Sonus_NULL {
routingLabel REHL1_1;
}

  

Note
The value 'Sonus_Null' displays when the key in the specified position is wild-carded.

To display call routing label details with display level set to '1':

Code Block
languagenone
% show global callRouting displaylevel 1    
   route trunkGroup TG_SIPART_AS SBX30 standard Sonus_NULL 1 all all ALL none Sonus_NULL;    
   route trunkGroup TG_SIPART_IAD SBX30 standard Sonus_NULL 1 all all ALL none Sonus_NULL;    
   routingLabel TO_TG_SIPART_AS;    
   routingLabel TO_TG_SIPART_IAD;

To display call routing label details with display level set to '3':

Code Block
languagenone
% show global callRouting displaylevel 3
   route trunkGroup TG_SIPART_AS SBX30 standard Sonus_NULL 1 all all ALL none Sonus_NULL {
	routingLabel TO_TG_SIPART_IAD;
   }
   route
   trunkGroup TG_SIPART_IAD SBX30 standard Sonus_NULL 1 all all ALL none
   Sonus_NULL {
	routingLabel TO_TG_SIPART_AS;
   }
   routingLabel TO_TG_SIPART_AS {
	overflowNumber          "";
	overflowNOA             none;
	overflowNPI             none;
	routePrioritizationType sequence;
	script                  "";
	action                  routes;
	routingLabelRoute       1;
   }
   routingLabel TO_TG_SIPART_IAD {
	overflowNumber          "";
	overflowNOA             none;
	overflowNPI             none;
	routePrioritizationType sequence;
	script                  "";
	action                  routes;
	routingLabelRoute       1;
   }

To display call routing label details:

Code Block
languagenone
% show global callRouting routingLabel
   routingLabel REHL1_1 {
	overflowNumber          "";
	overflowNOA             none;
	overflowNPI             none;
	routePrioritizationType sequence;
	script                  "";
	action                  routes;
	routingLabelRoute 1 {
		trunkGroup REHL_1;
		ipPeer     REHL_1;
		proportion 0;
		inService  inService;
		testing    normal;
	}
    }