Routing script tutorial:Mini Development Guide - Revision history

Allyntree at 13:58, 9 May 2024

2024-05-09T13:58:49Z

← Older revision		Revision as of 08:58, 9 May 2024
Line 1:		Line 1:
	{{DISPLAYTITLE:Routing Script Tutorial: Development Guide}}		{{DISPLAYTITLE:Routing Script Tutorial: Development Guide}}

			<a href="#" id="hideToc">Hide TOC</a>

	==Introduction==		==Introduction==

Allyntree at 17:09, 3 April 2024

2024-04-03T17:09:58Z

← Older revision		Revision as of 12:09, 3 April 2024
Line 6:		Line 6:
	{\| class="wikitable"		{\| class="wikitable"

	\|[[File:NoteIcon.png\|100px]]\|\| An ~~earlier~~ version of this guide is available. [[Routing script tutorial\|Consult it to enhance your learning.]]		\|[[File:NoteIcon.png\|100px]]\|\| An alternate version of this guide for routing scripts is available. [[Routing script tutorial\|Consult it to enhance your learning.]]
	\|}		\|}

Allyntree at 15:33, 3 April 2024

2024-04-03T15:33:17Z

← Older revision		Revision as of 10:33, 3 April 2024
Line 6:		Line 6:
	{\| class="wikitable"		{\| class="wikitable"

	\|[[File:NoteIcon.png\|100px]]\|\| ~~We developed an~~ earlier version of this guide. [[~~Its information can~~ enhance your learning.]]		\|[[File:NoteIcon.png\|100px]]\|\| An earlier version of this guide is available. [[Routing script tutorial\|Consult it to enhance your learning.]]


	~~If you do not know the default IP address, go to ''Changing the 800 Series Gateway Management Port IP Address''.~~
	\|}		\|}

Allyntree: /* Introduction */

2024-04-03T15:31:15Z

Introduction

← Older revision		Revision as of 10:31, 3 April 2024
Line 3:		Line 3:
	==Introduction==		==Introduction==
	This Routing Script Tutorial provides you with essential information in managing the routing of your calls. Consult the sections below to learn more.		This Routing Script Tutorial provides you with essential information in managing the routing of your calls. Consult the sections below to learn more.

			{\| class="wikitable"

			\|[[File:NoteIcon.png\|100px]]\|\| We developed an earlier version of this guide. [[Its information can enhance your learning.]]


			If you do not know the default IP address, go to ''Changing the 800 Series Gateway Management Port IP Address''.
			\|}

	==Accessing Routing Script Parameters ==		==Accessing Routing Script Parameters ==

Allyntree: /* Custom User Context */

2024-04-03T15:27:06Z

Custom User Context

← Older revision		Revision as of 10:27, 3 April 2024
Line 63:		Line 63:
	== Custom User Context ==		== Custom User Context ==
	[[Routing Script Tutorial: Custom User Context\|Custom User Context]]		[[Routing Script Tutorial: Custom User Context\|Custom User Context]]


	== Routing Script Tests ==		== Routing Script Tests ==
	[[Routing Script Tutorial: Routing Script Tests\|Learn how to use the Web Portal to test your routing scripts.]]		[[Routing Script Tutorial: Routing Script Tests\|Learn how to use the Web Portal to test your routing scripts.]]

Allyntree at 13:29, 1 April 2024

2024-04-01T13:29:12Z

← Older revision		Revision as of 08:29, 1 April 2024
Line 1:		Line 1:
	{{DISPLAYTITLE:Routing Script Tutorial Development Guide}}		{{DISPLAYTITLE:Routing Script Tutorial: Development Guide}}

	==Introduction==		==Introduction==

Allyntree at 13:28, 1 April 2024

2024-04-01T13:28:45Z

← Older revision		Revision as of 08:28, 1 April 2024
Line 1:		Line 1:
	{{DISPLAYTITLE:Routing Script ~~tutorial: A Mini~~ Development Guide}}		{{DISPLAYTITLE:Routing Script Tutorial Development Guide}}

	==Introduction==		==Introduction==

Allyntree: /* Routing Script Tests */

2024-03-29T18:54:47Z

Routing Script Tests

← Older revision		Revision as of 13:54, 29 March 2024
Line 67:		Line 67:
	== Routing Script Tests ==		== Routing Script Tests ==
	[[Routing Script Tutorial: Routing Script Tests\|Learn how to use the Web Portal to test your routing scripts.]]		[[Routing Script Tutorial: Routing Script Tests\|Learn how to use the Web Portal to test your routing scripts.]]

	The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.
	~~This is available in the Routing Scripts section of the Web portal.~~

	~~=== Test parameters ===~~
	~~==== @call_params ====~~

	~~That variable should contain a hash of call parameters that will be passed to the routing script. This is equivalent to the incoming call parameters.~~

	~~<br>~~

	~~==== @nap_list ====~~

	~~A list of the hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.~~

	~~'''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.~~

	~~<br>~~

	~~==== @params ====~~

	~~A hash of hashes containing parameters. This hash contains bridge parameters and other kind of parameter groups may be added in the future.~~

	~~@params = {~~
	~~:bridge => {:announcement_tone, "announcement.wav"},~~
	~~:contacts => {~~
	~~:index=>"1",~~
	~~:list=>[~~
	~~{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"",~~
	~~:raw_data=>"", :expiration=>"3600"},~~
	~~{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127",~~
	~~:raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}~~
	],
	~~:source_indexes=>"nil,0"~~
	}
	}

	~~<br>~~

	~~----~~

	~~<br> Back to [[Routing script tutorial\|Routing Script Tutorial]].~~

	~~[[category:FAQ]]~~

Allyntree at 18:52, 29 March 2024

2024-03-29T18:52:42Z

← Older revision		Revision as of 13:52, 29 March 2024
Line 58:		Line 58:
	[[Routing Script Tutorial: NAP Status and other NAP Information\|Learn how to use NAP status field in routing scripts.]]		[[Routing Script Tutorial: NAP Status and other NAP Information\|Learn how to use NAP status field in routing scripts.]]

	== Telephony Services (CNAM Request over SS7==		== Telephony Services (CNAM Request over SS7)==
	[[Routing Script Tutorial: CNAM Request\|Learn how to manage CNAM requests over SS7.]]		[[Routing Script Tutorial: CNAM Request\|Learn how to manage CNAM requests over SS7.]]

	== Custom ~~user context~~ ==		== Custom User Context ==
	~~The routing script may '''save per-call information within the call context''', that will be available if routing is called again later during the call flow.~~		[[Routing Script Tutorial: Custom User Context\|Custom User Context]]

	~~Cases where routing is called multiple times for the same call are:~~
	~~- Call transfer requests~~
	~~- SIP redirect requests~~
	~~- Radius Authorization result~~
	~~- Announcement server with digit collection~~

	~~The routing script can save a recursive hash of attributes here:~~		== Routing Script Tests ==
	~~params~~[:~~user_context~~]		[[Routing Script Tutorial: Routing Script Tests\|Learn how to use the Web Portal to test your routing scripts.]]

	~~For example~~
	~~params[:user_context] = { "SomeKey" => "Some value I want to retrieve upon next routing for this call", "OtherVal" => { "subkey" => "subval" } }~~

	~~Upon first call to routing script, params[:user_context] will be nil.~~
	~~Upon subsequent calls to routing script, it will contain whatever the script had stored upon previous call (or nil if it was not set)~~

	~~Note: This feature is available starting from release 2.9.85, 2.10.31 and 3.0.15 (in respective branches 2.9, 2.10 or 3.0)~~

	~~== Routing Script Tests ==~~
	The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.		The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.
	This is available in the Routing Scripts section of the Web portal.		This is available in the Routing Scripts section of the Web portal.

Allyntree: /* Telephony Services (CNAM Request over SS7 */

2024-03-29T18:47:28Z

Telephony Services (CNAM Request over SS7

← Older revision		Revision as of 13:47, 29 March 2024
Line 59:		Line 59:

	== Telephony Services (CNAM Request over SS7==		== Telephony Services (CNAM Request over SS7==
	[[Routing Script Tutorial: ~~NAP Status and other NAP Information~~\|Learn how to manage CNAM requests.]]		[[Routing Script Tutorial: CNAM Request\|Learn how to manage CNAM requests over SS7.]]

	== Custom user context ==		== Custom user context ==