Adding capture dtmf script - Revision history

Allyntree at 15:27, 13 June 2022

2022-06-13T15:27:37Z

← Older revision		Revision as of 11:27, 13 June 2022
Line 11:		Line 11:
	\|}		\|}

	This arcticle describes how to add a '''Capture DTMF''' script to any Routing ~~scripts~~.		This arcticle describes how to add a '''Capture DTMF''' script to any Routing script.

	'''Script Description''' <br>		'''Script Description''' <br>

Allyntree: /* Applies to version(s): v2.9, v2.10, v3.0, v3.1 */

2022-06-13T15:27:11Z

Applies to version(s): v2.9, v2.10, v3.0, v3.1

← Older revision		Revision as of 11:27, 13 June 2022
Line 1:		Line 1:
	~~=== '''''Applies to version(s): v2.9, v2.10, v3.0, v3.1''''' ===~~
	{{DISPLAYTITLE:Adding Capture DTMF Script}}		{{DISPLAYTITLE:Adding Capture DTMF Script}}

Allyntree: format and typo

2022-06-13T15:26:55Z

format and typo

← Older revision		Revision as of 11:26, 13 June 2022
Line 1:		Line 1:
	=== '''''Applies to version(s): v2.9, v2.10, v3.0, v3.1''''' ===		=== '''''Applies to version(s): v2.9, v2.10, v3.0, v3.1''''' ===
	{{DISPLAYTITLE:Adding Capture DTMF Script}}		{{DISPLAYTITLE:Adding Capture DTMF Script}}
	~~This shows how to add '''Capture DTMF''' script to any Routing scripts.~~

	== Script ~~description~~ <br> ==		{\| class="wikitable"
			\|-
			\|rowspan="3"\|This article applies to:
			\|'''Product'''
			\|'''Version'''
			\|-
			\|Tmedia
			\|2.9, 2.10, 3.0, 3.1
			\|}

			This arcticle describes how to add a '''Capture DTMF''' script to any Routing scripts.

			'''Script Description''' <br>

	If the called number is a specific value, it will play an announcement and ~~waits~~ to capture digits.		If the called number is a specific value, it will play an announcement and wait to capture digits.
	# Call 1-800-999-4444		# Call 1-800-999-4444
	# Hear tone		# Hear tone
Line 13:		Line 24:
	# Hear tone		# Hear tone
	# Enter destination number		# Enter destination number
	The call then routes to a TG (NAP) based on the 2 digit switch number and the INVITE contains the TG number in the TGRP= parameter.

			The call then routes to a TG (NAP) based on the 2-digit switch number, and the INVITE contains the TG number in the TGRP= parameter.
	Sample INVITE with TGRP=		Sample INVITE with TGRP=
	INVITE sip:18003608022@192.168.101.180;tgrp=98741 SIP/2.0		INVITE sip:18003608022@192.168.101.180;tgrp=98741 SIP/2.0
Line 19:		Line 32:
	<br>		<br>

	== Add '''Capture DTMF''' Scripts in system<br> ==		'''Add '''Capture DTMF''' Scripts in system'''<br>

	Download this file:		Download this file:
	{\| cellpadding="5" border="1" class="wikitable"		{\| cellpadding="5" border="1" class="wikitable"
Line 31:		Line 45:
	[[Import_Customized_Routing_Script_C]]		[[Import_Customized_Routing_Script_C]]

	~~== Setting up '''Capture DTMF''' Scripts<br> ==~~

	To ~~setup~~ a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script.<br>		'''Setting up '''Capture DTMF''' Scripts'''<br>

			To set up a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script.<br>

	First, go to the routing script section of the Web portal		First, go to the routing script section of the Web portal
	<pre>Gateway -> Routing scripts -> Example Scripts -> simple_routing.rb [Edit]		<pre>Gateway -> Routing scripts -> Example Scripts -> simple_routing.rb [Edit]
	</pre>		</pre>


	Three things need to be added. At the start of the script:<br>		Three things need to be added. At the start of the script:<br>
	<pre>require 'capture_dtmf'		<pre>require 'capture_dtmf'
	</pre>		</pre>


	In the main class:<br>		In the main class:<br>
	<pre>include CaptureDTMF		<pre>include CaptureDTMF
	</pre>		</pre>


	<pre>after_filter :method => :capture_dtmf		<pre>after_filter :method => :capture_dtmf
	</pre>		</pre>
	<br>		<br>


	The final script will look like this:		The final script will look like this:
	<pre>		<pre>
Line 65:		Line 88:
	end		end
	</pre>		</pre>
	== Upload audio file <br> ==

			'''Upload audio file'''<br>
	The script will play a tone for the user to ask them to enter a dtmf string. This show how to add the default one which can be downloaded here:		The script will play a tone for the user to ask them to enter a dtmf string. This show how to add the default one which can be downloaded here:
	{\| cellpadding="5" border="1" class="wikitable"		{\| cellpadding="5" border="1" class="wikitable"
Line 78:		Line 103:
	# Click '''Browse''' and select 'fen-tone-400hz-300ms.wav'		# Click '''Browse''' and select 'fen-tone-400hz-300ms.wav'
	# Click '''Upload'''		# Click '''Upload'''

	See instructions here: [[Toolpack:Configuring_Audio_Prompts_C]] <br>		See instructions here: [[Toolpack:Configuring_Audio_Prompts_C]] <br>
	However any G.711 alaw or G.711 ulaw wav file can be added to the system to be played: you need to edit the capture_dtmf.rb script with the appropriate wav file.		However any G.711 alaw or G.711 ulaw wav file can be added to the system to be played: you need to edit the capture_dtmf.rb script with the appropriate wav file.

Luc Morissette: Update

2020-02-04T19:32:05Z

Update

← Older revision		Revision as of 15:32, 4 February 2020
Line 1:		Line 1:
			=== '''''Applies to version(s): v2.9, v2.10, v3.0, v3.1''''' ===
			{{DISPLAYTITLE:Adding Capture DTMF Script}}
	This shows how to add '''Capture DTMF''' script to any Routing scripts.		This shows how to add '''Capture DTMF''' script to any Routing scripts.

Luc Morissette: New page for capture DTMF script

2020-02-04T19:30:25Z

New page for capture DTMF script

New page

This shows how to add '''Capture DTMF''' script to any Routing scripts.

== Script description ==

If the called number is a specific value, it will play an announcement and waits to capture digits.
# Call 1-800-999-4444
# Hear tone
# Enter 2 digit switch number optionally followed by #
# Hear tone
# Enter TG number – can be 4 or 5 digits depending on which switch the call goes to
# Hear tone
# Enter destination number
The call then routes to a TG (NAP) based on the 2 digit switch number and the INVITE contains the TG number in the TGRP= parameter.
Sample INVITE with TGRP=
INVITE sip:18003608022@192.168.101.180;tgrp=98741 SIP/2.0
This will work with any TMG device with a license to play files. For ProSBC, it requires transcoding devices.
 

== Add '''Capture DTMF''' Scripts in system ==
Download this file:
{| cellpadding="5" border="1" class="wikitable"
|-
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" |Capture DTMF Script
|-
| valign="top" |
*[[Media:capture_dtmf.zip|capture_dtmf.rb]]
|}
Then upload it in the system with these instructions:
[[Import_Customized_Routing_Script_C]]

== Setting up '''Capture DTMF''' Scripts ==

To setup a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script. 

First, go to the routing script section of the Web portal
<pre>Gateway -> Routing scripts -> Example Scripts -> simple_routing.rb [Edit]
</pre>
Three things need to be added. At the start of the script: 
<pre>require 'capture_dtmf'
</pre>
In the main class: 
<pre>include CaptureDTMF
</pre>
<pre>after_filter :method => :capture_dtmf
</pre>
 
The final script will look like this:
<pre>
require 'base_routing'
require 'capture_dtmf'

class SimpleRouting < BaseRouting
include CaptureDTMF

route_match :call_field_name => :called
route_match :call_field_name => :calling
route_match :call_field_name => :nap
route_remap :call_field_name => :called, :route_field_name => :remapped_called
route_remap :call_field_name => :calling, :route_field_name => :remapped_calling
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap

after_filter :method => :capture_dtmf
end
</pre>
== Upload audio file ==
The script will play a tone for the user to ask them to enter a dtmf string. This show how to add the default one which can be downloaded here:
{| cellpadding="5" border="1" class="wikitable"
|-
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" |Sample Tone File
|-
| valign="top" |
*[[Media:Fen-tone-400hz-300ms.wav|fen-tone-400hz-300ms.wav]]
|}

# Click '''Audio Prompts''' in the navigation panel
# Click '''Browse''' and select 'fen-tone-400hz-300ms.wav'
# Click '''Upload'''
See instructions here: [[Toolpack:Configuring_Audio_Prompts_C]] 
However any G.711 alaw or G.711 ulaw wav file can be added to the system to be played: you need to edit the capture_dtmf.rb script with the appropriate wav file.