Tmedia Routing - Revision history

Luc Morissette: /* Related actions */

2024-01-19T21:32:16Z

Related actions

← Older revision		Revision as of 17:32, 19 January 2024
Line 469:		Line 469:
	'''Refer to the appropriate Toolpack release:'''		'''Refer to the appropriate Toolpack release:'''
	*[[Toolpack:Call_Routes_Settings_E\|Call routes for version 3.2]]		*[[Toolpack:Call_Routes_Settings_E\|Call routes for version 3.2]]
	*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call ~~Routes Settings~~ v3.1]]		*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call routes for version v3.1]]
	<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">		<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">
	*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]		*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]

Luc Morissette: Added 3.2 link

2024-01-19T21:31:58Z

Added 3.2 link

← Older revision		Revision as of 17:31, 19 January 2024
Line 468:		Line 468:
	== Related actions ==		== Related actions ==
	'''Refer to the appropriate Toolpack release:'''		'''Refer to the appropriate Toolpack release:'''
			*[[Toolpack:Call_Routes_Settings_E\|Call routes for version 3.2]]
	*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call Routes Settings v3.1]]		*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call Routes Settings v3.1]]
			<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">
	*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]		*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]
	*[[Toolpack:Call_Routes_Settings_C\|Call Routes Settings v2.10]]		*[[Toolpack:Call_Routes_Settings_C\|Call Routes Settings v2.10]]
	*[[Toolpack:Call_Routes_Settings_B\|Call Routes Settings v2.9]]		*[[Toolpack:Call_Routes_Settings_B\|Call Routes Settings v2.9]]
	~~<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">~~
	*[[Toolpack:Call_Routes_Settings_A\|Call Routes Settings v2.8]]		*[[Toolpack:Call_Routes_Settings_A\|Call Routes Settings v2.8]]
	*[[Web_Portal_Tutorial_Guide_v2.7#Routes\|Web Portal v2.7: Routes Configuration]]		*[[Web_Portal_Tutorial_Guide_v2.7#Routes\|Web Portal v2.7: Routes Configuration]]
	*[[Web_Portal_Tutorial_Guide_v2.6#Routes\|Web Portal v2.6: Routes Configuration]]		*[[Web_Portal_Tutorial_Guide_v2.6#Routes\|Web Portal v2.6: Routes Configuration]]
	</div>		</div>

Luc Morissette: Updated the newline symbols

2023-08-17T14:51:37Z

Updated the newline symbols

← Older revision		Revision as of 10:51, 17 August 2023
Line 373:		Line 373:

	===='''out_calls''' parameters====		===='''out_calls''' parameters====
	'''out_calls''' parameters are the same as "call" parameters, but one set for each route.<br\>		'''out_calls''' parameters are the same as "call" parameters, but one set for each route.<br>
	The list of parameters can be different for each route. This describes the call parameters for each one of them. <br\>		The list of parameters can be different for each route. This describes the call parameters for each one of them. <br>
	out_call[0] maps the first set of parameters to be used for the first route. <br\>		''out_call[0]'' maps the first set of parameters to be used for the first route. <br>

	=== Filter Scripts examples: ===		=== Filter Scripts examples: ===

Luc Morissette: Updated formatting

2020-04-14T21:02:39Z

Updated formatting

← Older revision		Revision as of 17:02, 14 April 2020
Line 278:		Line 278:

	=== Notes on parameters ===		=== Notes on parameters ===
	Parameters will be mapped to variables to be used in the script.		Parameters will be mapped to variables to be used in the script.<br\>
	For example the "SIP:To - user-info" will be mapped to the "called" parameter.		For example the '''SIP:To - user-info''' will be mapped to the '''called''' parameter.<br\>
	Parameters will only appear in the structures if they are present.		Parameters will only appear in the structures if they are ''present''. For example a call without any SIP '''diversion''' header will not have the '''original_called_number''' parameter present.
	For example a call without any diversion header will not have the "original_called_number" parameter present.

	===='''call''' parameters include all the parameters here:~~====~~		===='''call''' parameters====
			'''call''' parameters include all the parameters here:
	[[Routing_script_tutorial:Mini_Development_Guide#Script_parameters_protocol_mapping\|Routing Scripts variables]]		[[Routing_script_tutorial:Mini_Development_Guide#Script_parameters_protocol_mapping\|Routing Scripts variables]]

	===='''routes''' parameters ~~include:~~====		===='''routes''' parameters====
			'''routes''' parameters include all the parameters here:
	{\| cellpadding="5" border="1" class="wikitable"		{\| cellpadding="5" border="1" class="wikitable"
	\|-		\|-
	! width="250" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Variable name		! width="250" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Variable name
	! width="~~400~~" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Description		! width="500" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Description
	\|-		\|-
	\| valign="top" \|		\| valign="top" \|
Line 300:		Line 301:
	routeset_name		routeset_name
	\| valign="top" \|		\| valign="top" \|
	Label name. Only used in label routing: [[Label_Routing]]		Label name. Only used in label routing: see [[Label_Routing]]
	\|-		\|-
	\| valign="top" \|		\| valign="top" \|
	nap		nap
	\| valign="top" \|		\| valign="top" \|
	NAP where the incoming call was received		NAP (Network Access Point) where the incoming call was received
	\|-		\|-
	\| valign="top" \|		\| valign="top" \|
Line 316:		Line 317:
	\| valign="top" \|		\| valign="top" \|
	calling number of the incoming call		calling number of the incoming call
			\|-
			\| valign="top" \|
			remapped_nap
			\| valign="top" \|
			NAP of the outgoing call
	\|-		\|-
	\| valign="top" \|		\| valign="top" \|
Line 343:		Line 349:
	\|}		\|}

	===='''naps''' parameters ~~include:~~====		===='''naps''' parameters ====
			'''naps''' parameters include:
	{\| cellpadding="5" border="1" class="wikitable"		{\| cellpadding="5" border="1" class="wikitable"
	\|-		\|-
	! width="250" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Variable name		! width="250" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Variable name
	! width="~~400~~" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Description		! width="500" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" \| Description
	\|-		\|-
	\| valign="top" \|		\| valign="top" \|
	routeset_definition		routeset_definition
	\| valign="top" \|		\| valign="top" \|
	pointer to routeset definition file if label routing is used: [[Label_Routing]]		pointer to routeset definition file if label routing is used: see [[Label_Routing]]
	\|-		\|-
	\| valign="top" \|		\| valign="top" \|
Line 365:		Line 372:
	\|}		\|}

	===='''out_calls''' parameters are the same as "call" parameters, but one set for each route.~~====~~		===='''out_calls''' parameters====
			'''out_calls''' parameters are the same as "call" parameters, but one set for each route.<br\>
	The list of parameters can be different for each route. This describes the call parameters for each one of them. <br\>		The list of parameters can be different for each route. This describes the call parameters for each one of them. <br\>
	out_call[0] maps the first set of parameters to be used for the first route. <br\>		out_call[0] maps the first set of parameters to be used for the first route. <br\>

Luc Morissette: First draft of parameters description

2020-04-14T20:28:54Z

First draft of parameters description

@@ Line 276: / Line 276: @@
      return params
    end
 === Filter Scripts examples:  ===

Luc Morissette: Updated to link filters

2020-02-04T19:50:41Z

Updated to link filters

← Older revision		Revision as of 15:50, 4 February 2020
Line 278:		Line 278:

	=== Filter Scripts examples: ===		=== Filter Scripts examples: ===
			See [[How to Setup Filters\|How to setup Filters]]<br>
	*'''priority_and_weight_load_balancer.rb:''' After filter that will reorder routes by priority and weight (load sharing per weight for routes with the same priority)
	*'''forward_sip_domain.rb:''' Route remap filter that will, per route, control forwarding of sip domain of various SIP headers (forward domains, else replace by local IP / proxy IP)
	*'''sip_header_params.rb:''' After remap filter that will add specified parameters to specified SIP headers
	*'''Black and White listing (black_white_listing.rb):''' With this script, any called or calling number prefix can be blacklisted or whitelisted. This script can be assigned globally, or per NAP. It reads a .csv file which has the called and calling number list. See ~~[[Adding White or Black listing to Routing Script]]~~
	*'''lawful_intercept.rb:''' Script that will identify some calls to perform lawful interception on (by calling/called number matching from a .csv file)

	~~Learn how to add a Filter to normal scripts:~~ [[How to Setup Filters\|How to setup Filters]]<br>

	== <br>Label routing<br> ==		== <br>Label routing<br> ==
Line 375:		Line 368:
	== Related actions ==		== Related actions ==
	'''Refer to the appropriate Toolpack release:'''		'''Refer to the appropriate Toolpack release:'''
			*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call Routes Settings v3.1]]
	*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]		*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]
	*[[Toolpack:Call_Routes_Settings_C\|Call Routes Settings v2.10]]		*[[Toolpack:Call_Routes_Settings_C\|Call Routes Settings v2.10]]
	*[[Toolpack:Call_Routes_Settings_B\|Call Routes Settings v2.9]]		*[[Toolpack:Call_Routes_Settings_B\|Call Routes Settings v2.9]]
			<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">
	*[[Toolpack:Call_Routes_Settings_A\|Call Routes Settings v2.8]]		*[[Toolpack:Call_Routes_Settings_A\|Call Routes Settings v2.8]]
	~~<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">~~
	*[[Web_Portal_Tutorial_Guide_v2.7#Routes\|Web Portal v2.7: Routes Configuration]]		*[[Web_Portal_Tutorial_Guide_v2.7#Routes\|Web Portal v2.7: Routes Configuration]]
	*[[Web_Portal_Tutorial_Guide_v2.6#Routes\|Web Portal v2.6: Routes Configuration]]		*[[Web_Portal_Tutorial_Guide_v2.6#Routes\|Web Portal v2.6: Routes Configuration]]
	</div>		</div>

Abrassard: /* After remap (after_remap) */

2019-05-30T19:29:17Z

After remap (after_remap)

← Older revision		Revision as of 15:29, 30 May 2019
Line 265:		Line 265:
	# Called once per incoming call		# Called once per incoming call
	def my_custom_after_remap_filter( params )		def my_custom_after_remap_filter( params )
	# - params[ :out_calls] Array of all outgoing call to be created (corresponding to each matching route).		# - params[ :call] Hash of call attributes of the incoming call.
			# Useless to modify, because has been copied to params[ :out_calls ] for each matching route
			# - params[ :out_calls ] Array of all outgoing call to be created (corresponding to each matching route).
	# Can be modified to customize each outgoing call attempt.		# Can be modified to customize each outgoing call attempt.
	# - params[ :routes ] Array of all routes in your configuration with all their attributes.		# - params[ :routes ] Array of all routes in your configuration with all their attributes.

Abrassard: /* After filter (after_filter) */

2019-05-30T19:28:18Z

After filter (after_filter)

← Older revision		Revision as of 15:28, 30 May 2019
Line 213:		Line 213:
	# Called once per incoming call		# Called once per incoming call
	def my_custom_after_filter( params )		def my_custom_after_filter( params )
	# See ~~init_my_custom_after_filter~~ above for details about params		# See my_custom_before_filter above for details about params

	return params		return params

Abrassard: /* Filter Scripts examples: */

2019-03-28T18:49:03Z

Filter Scripts examples:

← Older revision		Revision as of 14:49, 28 March 2019
Line 277:		Line 277:
	=== Filter Scripts examples: ===		=== Filter Scripts examples: ===

	*'''~~Request-URI routing (ruri~~.rb):''' ~~Will route~~ the ~~call on SIP RURI instead of the to: field~~		*'''priority_and_weight_load_balancer.rb:''' After filter that will reorder routes by priority and weight (load sharing per weight for routes with the same priority)
	*'''~~Modify the Nature of Address (noa_npi_remap~~.rb):''' ~~We can use this to change the NOA to national or international~~		*'''forward_sip_domain.rb:''' Route remap filter that will, per route, control forwarding of sip domain of various SIP headers (forward domains, else replace by local IP / proxy IP)
	*'''Remove Loop (~~FilterRemoveLoop.rb~~)~~: '''Will prevent calls from being routed back to the sender~~		*'''sip_header_params.rb:''' After remap filter that will add specified parameters to specified SIP headers
	*'''~~Load sharing on NAP groups or on route groups (nap_group_weight_retry_with_overload~~.rb):''' ~~This is a powerful script~~ that ~~allows for a regrouping of NAPs of the same kind, distributes loads among them, and prioritizes one group versus another.  Alternatively, you can do the same on routes. You need to~~ add ~~two columns~~ to the NAPs (or the routes), one called "group" and one called "weight". Groups of lower value will have a higher priority (group=0 has more priority than group=10). The calls will be distributed according to the weight value. To have an equal number of calls on each destination, use the same weight value (weight=10). See [[Adding Load Sharing to Routing Script\|Adding Load Sharing to Routing Script]]<br>
	*'''Black and White listing (black_white_listing.rb):''' With this script, any called or calling number prefix can be blacklisted or whitelisted. This script can be assigned globally, or per NAP. It reads a .csv file which has the called and calling number list. See [[Adding White or Black listing to Routing Script]]		*'''Black and White listing (black_white_listing.rb):''' With this script, any called or calling number prefix can be blacklisted or whitelisted. This script can be assigned globally, or per NAP. It reads a .csv file which has the called and calling number list. See [[Adding White or Black listing to Routing Script]]
	~~<br>~~		*'''lawful_intercept.rb:''' Script that will identify some calls to perform lawful interception on (by calling/called number matching from a .csv file)

	Learn how to add a Filter to normal scripts: [[How to Setup Filters\|How to setup Filters]]<br>		Learn how to add a Filter to normal scripts: [[How to Setup Filters\|How to setup Filters]]<br>

Abrassard: /* Filters */

2019-03-28T18:42:59Z

Filters

← Older revision		Revision as of 14:42, 28 March 2019
Line 110:		Line 110:
	Other standard routing scripts implement Filters and are covered in the next section.		Other standard routing scripts implement Filters and are covered in the next section.

	== ~~<br>~~Filters~~<br>~~ ==		== Filters ==
	<pre>Gateway -> Routing scripts </pre>		<pre>Gateway -> Routing scripts </pre>
	Adds functionality to standard scripts. Filters can be added to any standard script in a few steps. For example, you may want to remove the '1' prefix for uniformed routing, select the SIP Request URI to route the call instead of the called number, and more.		Adds functionality to standard scripts. Filters can be added to any standard script in a few steps. For example, you may want to remove the '1' prefix for uniformed routing, select the SIP Request URI to route the call instead of the called number, and more.

← Older revision		Revision as of 17:31, 19 January 2024
Line 468:		Line 468:
	== Related actions ==		== Related actions ==
	'''Refer to the appropriate Toolpack release:'''		'''Refer to the appropriate Toolpack release:'''
			*[[Toolpack:Call_Routes_Settings_E\|Call routes for version 3.2]]
	*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call Routes Settings v3.1]]		*[[Toolpack:Tsbc_Call_Routes_Settings_3.1\|Call Routes Settings v3.1]]
			<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">
	*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]		*[[Toolpack:Call_Routes_Settings_D\|Call Routes Settings v3.0]]
	*[[Toolpack:Call_Routes_Settings_C\|Call Routes Settings v2.10]]		*[[Toolpack:Call_Routes_Settings_C\|Call Routes Settings v2.10]]
	*[[Toolpack:Call_Routes_Settings_B\|Call Routes Settings v2.9]]		*[[Toolpack:Call_Routes_Settings_B\|Call Routes Settings v2.9]]
	~~<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">~~
	*[[Toolpack:Call_Routes_Settings_A\|Call Routes Settings v2.8]]		*[[Toolpack:Call_Routes_Settings_A\|Call Routes Settings v2.8]]
	*[[Web_Portal_Tutorial_Guide_v2.7#Routes\|Web Portal v2.7: Routes Configuration]]		*[[Web_Portal_Tutorial_Guide_v2.7#Routes\|Web Portal v2.7: Routes Configuration]]
	*[[Web_Portal_Tutorial_Guide_v2.6#Routes\|Web Portal v2.6: Routes Configuration]]		*[[Web_Portal_Tutorial_Guide_v2.6#Routes\|Web Portal v2.6: Routes Configuration]]
	</div>		</div>