Routing script tutorial - Revision history

Allyntree at 14:37, 24 May 2024

2024-05-24T14:37:20Z

← Older revision		Revision as of 10:37, 24 May 2024
Line 1:		Line 1:
			<a href="#" id="hideToc">Hide TOC</a>
	== Introduction ==		== Introduction ==

Allyntree at 15:35, 3 April 2024

2024-04-03T15:35:31Z

← Older revision		Revision as of 11:35, 3 April 2024
Line 7:		Line 7:
	#The 'route' method		#The 'route' method

	For more information about the parameters that can be used within a method, ~~please see~~ the [[Routing script tutorial:Mini Development Guide\|mini development guide]]		{\| class="wikitable"

			\|[[File:NoteIcon.png\|100px]]\|\| For more information about the parameters that can be used within a method, consult the [[Routing script tutorial:Mini Development Guide\|Routing Script Tutorial: A mini development guide]]
			\|}


	<br>		<br>

Abrassard: /* 'route_remap' method */

2018-05-09T15:42:00Z

'route_remap' method

← Older revision		Revision as of 11:42, 9 May 2018
Line 85:		Line 85:
	'route_remap' allows to remap the parameter of the route or the call using one of the 4 possible arguments. There are actually 3 types of remapping that can be performed: via the :call_field_name/:route_field_name arguments; the :proc argument; and/or the :method argument.		'route_remap' allows to remap the parameter of the route or the call using one of the 4 possible arguments. There are actually 3 types of remapping that can be performed: via the :call_field_name/:route_field_name arguments; the :proc argument; and/or the :method argument.

	~~# ~~:call_field_name ~~- The field name of the call to remap~~		====:call_field_name====
	# :route_field_name - The field name of the route to remap with. The default is to use the call field name. If the value of the field is empty, the incoming call's attribute is used. The value of the route field can be a regular expression remap. (e.g., /(555000.)/001\1/ )
	# :proc - A user supplied proc to call instead of trying to do the remap internally. It should accept four arguments (route, call object, nap list, call params) and return a hash of remapped fields
	# :method - A user supplied method to call instead of trying to do the match internally. It should accept four arguments (route, call object, nap list, call params) and return a hash of remapped fields

	<br>		The field name of the call to remap
			====:route_field_name====

			The field name of the route to remap with. The default is to use the call field name. If the value of the field is empty, the incoming call's attribute is used. The value of the route field can be a regular expression remap. (e.g., /(555000.)/001\1/ )
			====:proc====
			A user supplied proc to call instead of trying to do the remap internally. It should accept four arguments (route, call object, nap list, call params) and return a hash of remapped fields

			====:method====
			A user supplied method to call instead of trying to do the match internally. It should accept four arguments (route, call object, nap list, call params) and return a hash of remapped fields

			<br>

	=== 'init_routes' method ===		=== 'init_routes' method ===

Abrassard: /* 'route_match' method */

2018-05-09T15:41:16Z

'route_match' method

← Older revision		Revision as of 11:41, 9 May 2018
Line 48:		Line 48:

	'route_match' allows to match a call to one route using one of 4 possible arguments. It is possible to call 'route_match' multiple times to reduce the number of matching routes. Since 'route_match' will return the first matching route it find, there is a possibility that there is more than one route match, therefore it is important to order the routes or prioritize them using 'route_order'.		'route_match' allows to match a call to one route using one of 4 possible arguments. It is possible to call 'route_match' multiple times to reduce the number of matching routes. Since 'route_match' will return the first matching route it find, there is a possibility that there is more than one route match, therefore it is important to order the routes or prioritize them using 'route_order'.

	~~# :call_field_name - The field name of the call to try to match~~
	# :route_field_name - The field name of the route to try to match with. The default is to use the call field name. If the value of the field is empty, the match is considered positive. The value of the route field can be a regular expression. (e.g., /555000./ )
	~~# :proc - A user-supplied proc to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match~~
	~~# :method - A user-supplied method to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match~~

	====:call_field_name====		====:call_field_name====
Line 60:		Line 55:
	* A route that has a specific value will only match if the call has the same value		* A route that has a specific value will only match if the call has the same value
	* A route with a regular expression value will match if the regular expression from the route matches the value from the call		* A route with a regular expression value will match if the regular expression from the route matches the value from the call
			** For example: /555000./ will match any number with 7 digits starting with 555000
	* This function supports a special case when matching SIP :calling or :called attributes: The format 'number@sip_host:sip_ort' can be used for matching calling/called number, the domain, and the port.		* This function supports a special case when matching SIP :calling or :called attributes: The format 'number@sip_host:sip_ort' can be used for matching calling/called number, the domain, and the port.
	** For example 1234@abc.com:5060 will match only calls with number 1234, on SIP host 'abc.com' on port 5060.		** For example: 1234@abc.com:5060 will match only calls with number 1234, on SIP host 'abc.com' on port 5060.
	** For example @abc.com will match any call on sip_host 'abc.com' on any port		** For example: @abc.com will match any call on sip_host 'abc.com' on any port

			====:route_field_name====
			This option will specify an alternate route attribute name to match with the call attribute :call_field_name (in case the route attribute name differs from the call attribute name)

			====:proc====
			A user-supplied proc to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match

			====:method====
			A user-supplied method to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match

	====base_routing pre-implemented matching method====		====base_routing pre-implemented matching method====

Abrassard: /* 'route_match' method */

2018-05-09T15:39:24Z

'route_match' method

← Older revision		Revision as of 11:39, 9 May 2018
Line 54:		Line 54:
	# :method - A user-supplied method to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match		# :method - A user-supplied method to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match

	base_routing pre-implemented matching method:		====:call_field_name====
			This option will compare the specified call attribute with the route attribute. For example, :call_field_name => :called will match the called number attribute.

			* A route that has empty value is considered "match everything".
			* A route that has a specific value will only match if the call has the same value
			* A route with a regular expression value will match if the regular expression from the route matches the value from the call
			* This function supports a special case when matching SIP :calling or :called attributes: The format 'number@sip_host:sip_ort' can be used for matching calling/called number, the domain, and the port.
			** For example 1234@abc.com:5060 will match only calls with number 1234, on SIP host 'abc.com' on port 5060.
			** For example @abc.com will match any call on sip_host 'abc.com' on any port

			====base_routing pre-implemented matching method====

	*'match_nap_availability', this method will verify the availability through the nap status.		*'match_nap_availability', this method will verify the availability through the nap status.

Luc Morissette: /* Useful links */

2014-01-31T14:27:12Z

Useful links

← Older revision		Revision as of 10:27, 31 January 2014
Line 118:		Line 118:

	== Useful links ==		== Useful links ==
	[[Tmedia_Routing\|Tmedia Routing]]		*[[Tmedia_Routing\|Tmedia Routing]]

Luc Morissette: Added link to Tmedia routing

2014-01-31T14:26:02Z

Added link to Tmedia routing

← Older revision		Revision as of 10:26, 31 January 2014
Line 116:		Line 116:

	Back to the [[Scriptable Routing Engine\|Scriptable Routing Engine]] page.		Back to the [[Scriptable Routing Engine\|Scriptable Routing Engine]] page.

			== Useful links ==
			[[Tmedia_Routing\|Tmedia Routing]]

Luc Morissette: /* Examples and tutorials */

2014-01-29T16:21:16Z

Examples and tutorials

← Older revision		Revision as of 12:21, 29 January 2014
Line 105:		Line 105:
	=== Examples and tutorials ===		=== Examples and tutorials ===

	*[[Routing script tutorial:Routing Class Tutorial\|~~script routing~~ class tutorial]]		*[[Routing script tutorial:Routing Class Tutorial\|Routing Script class tutorial]]
	*[[Routing script tutorial:route order Tutorial\|'route_order' tutorial]]		*[[Routing script tutorial:route order Tutorial\|'route_order' tutorial]]
	*[[Routing script tutorial:route match Tutorial\|'route_match' tutorial]]		*[[Routing script tutorial:route match Tutorial\|'route_match' tutorial]]

Abrassard at 13:01, 17 November 2010

2010-11-17T13:01:31Z

@@ Line 90: / Line 90: @@
 == Route retry algorithm  ==
+Documentation on route retry algorithm can be found here:
-The route retry feature applies when more than one matching route is returned by the active routing script. The route retry algorithm works the following way:
+[[Route_retry]]
 == What else?  ==

Ktrueman: /* 'route_match' method */ capitalized ASR

2010-08-20T14:17:13Z

'route_match' method: capitalized ASR

← Older revision		Revision as of 10:17, 20 August 2010
Line 60:		Line 60:
	route_match :method => :match_nap_availability		route_match :method => :match_nap_availability

	*'match_asr_threshhold', this method will verify will match any route who's destination NAP has a higher ~~asr~~ than the threshold stored for that nap. This method requires adding 2 custom '''NAP''' parameters called. The first custom parameter is 'asr_threshhold_type'. Its values can be: global, last_24h, current_hour, last_hour. The second custom parameter is 'asr_threshhold'. Its value needs to be an '''integer''' between 0 and 100.		*'match_asr_threshhold', this method will verify will match any route who's destination NAP has a higher ASR than the threshold stored for that nap. This method requires adding 2 custom '''NAP''' parameters called. The first custom parameter is 'asr_threshhold_type'. Its values can be: global, last_24h, current_hour, last_hour. The second custom parameter is 'asr_threshhold'. Its value needs to be an '''integer''' between 0 and 100.

	route_match :method => :match_asr_threshhold		route_match :method => :match_asr_threshhold

	<br>		<br>

	=== 'route_remap' method ===		=== 'route_remap' method ===