IVR Setup - Revision history

Monica: /* How it works */

2013-10-31T15:09:36Z

‎How it works

Dana: /* How to route calls to script */

2013-01-16T11:48:13Z

‎How to route calls to script

Dana: /* How to route calls to script */

2013-01-16T11:44:34Z

‎How to route calls to script

Dana: /* How it works */

2013-01-16T11:41:22Z

‎How it works

Dana: /* How it works */

2013-01-16T11:40:31Z

‎How it works

Dana: /* How to route calls to script */

2013-01-16T11:39:32Z

‎How to route calls to script

Dana: /* How to route calls to script */

2013-01-16T11:39:16Z

‎How to route calls to script

Dana at 11:16, 11 December 2012

2012-12-11T11:16:49Z

Dana at 15:04, 31 October 2012

2012-10-31T15:04:30Z

Dana: Created page with " In Yate the IVR functionality is not related to routing, therefore regexroute - or any other routing module - will not help writing an IVR. In Yate an IVR is rather an applic..."

2012-10-31T14:22:20Z

Created page with " In Yate the IVR functionality is not related to routing, therefore regexroute - or any other routing module - will not help writing an IVR. In Yate an IVR is rather an applic..."

New page

In Yate the IVR functionality is not related to routing, therefore regexroute - or any other routing module - will not help writing an IVR. In Yate an IVR is rather an application started when an incoming call is routed to that application. This application gets the opportunity of inspecting events generated by the caller and giving commands to Yate - all these by handling or generating [[Messages]].

You must make sure extmodule.yate exist (is compiled and/or installed) and is not disabled from the yate.conf file. Also in extmodule.conf make sure you specify a proper scripts_dir setting in the [general] section. The scripts_dir parameter must point to the directory where the external scripts and their libraries are installed, like in this example:

[general]
scripts_dir=/usr/local/lib/yate/

In this directory you should place the IVR applications or scripts you are going to use.

You will also need to route the incoming calls to the external application so it creates an instance of the IVR when the user dials that number. Let's suppose you want to use [[Regular expressions]] to route the short number 555 to the voicemail.

^555$=external/nodata/voicemail.php

Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.

When the 555 number is dialed an instance of the voicemail.php script is launched and the "call.execute" message is passed to it (even if it didn't install a handler) so it can pick up usefull info about the call:
* caller channel "id"
* caller number "caller"
* caller user account "user" - if authenticated by the incoming call driver
* called number "called" - in case the IVR handles more than one number

The application then keeps running, installing message handlers, generating messages and keeping the event loop running. In the end the caller is either disconnected or is transferred to another channel which can be another IVR. The application terminates when the caller disconnects or is transferred.

You can find more about the internal working of an IVR application in the page related to [[Writing an IVR]].

← Older revision		Revision as of 15:09, 31 October 2013
Line 40:		Line 40:
	* [[External Module]]		* [[External Module]]
	* [[Lib Yate PHP\|Library PHP in Yate]]		* [[Lib Yate PHP\|Library PHP in Yate]]
		+
		+	[[Category:Routing]] [[Category:IVR]] [[Category:Extmodule]]

@@ Line 19: / Line 19: @@
 Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.
-You can find some IVR examples in '''share/scripts/''' from your Yate build directory.
+You can find some IVR examples Yate's sources '''~/share/scripts/'''.
 === How it works ===

@@ Line 19: / Line 19: @@
 Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.
-You can find voicemail.php in '''share/scripts/''' from your Yate build directory.
+You can find some IVR examples in '''share/scripts/''' from your Yate build directory.
 === How it works ===

← Older revision		Revision as of 11:40, 16 January 2013
Line 32:		Line 32:

	You can find more about the internal working of an IVR application in the page related to [[Writing an IVR]].		You can find more about the internal working of an IVR application in the page related to [[Writing an IVR]].
		+
		+
		+	'''See also'''
		+
		+	* [[External Module]]
		+	* [[Lib Yate PHP\|Library PHP in Yate]]

@@ Line 19: / Line 19: @@
 Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.
-You can find voicemail.php in share/scripts/ from your Yate build directory.
+You can find voicemail.php in '''share/scripts/''' from your Yate build directory.
 === How it works ===

@@ Line 29: / Line 29: @@
 * called number "called" - in case the IVR handles more than one number
-The application then keeps running, installing message handlers, generating messages and keeping the event loop running. In the end the caller is either disconnected or is transferred to another channel which can be another IVR. The application terminates when the caller disconnects or is transferred.
+The application then keeps running, installing message handlers, generating messages and keeping the event loop running.<br>
 You can find more about the internal working of an IVR application in the page related to [[Writing an IVR]].

← Older revision		Revision as of 11:39, 16 January 2013
Line 18:		Line 18:

	Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.		Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.
		+
		+	You can find voicemail.php in share/scripts/ from your Yate build directory.

	=== How it works ===		=== How it works ===

@@ Line 1: / Line 1: @@
-=== Where to place the script ===
+In Yate the IVR functionality is not related to routing, therefore regexroute - or any other routing module - will not help writing an IVR. In Yate an IVR is rather an application started when an incoming call is routed to that application. This application gets the opportunity of inspecting events generated by the caller and giving commands to Yate - all these by handling or generating Messages.
-In Yate the IVR functionality is not related to routing, therefore regexroute - or any other routing module - will not help writing an IVR. In Yate an IVR is rather an application started when an incoming call is routed to that application. This application gets the opportunity of inspecting events generated by the caller and giving commands to Yate - all these by handling or generating [[Messages]].
+=== Where to place the script ===
 You must make sure extmodule.yate exist (is compiled and/or installed) and is not disabled from the yate.conf file. Also in extmodule.conf make sure you specify a proper scripts_dir setting in the [general] section. The scripts_dir parameter must point to the directory where the external scripts and their libraries are installed, like in this example:

@@ Line 1: / Line 1: @@
 In Yate the IVR functionality is not related to routing, therefore regexroute - or any other routing module - will not help writing an IVR. In Yate an IVR is rather an application started when an incoming call is routed to that application. This application gets the opportunity of inspecting events generated by the caller and giving commands to Yate - all these by handling or generating [[Messages]].
@@ Line 8: / Line 10: @@
 In this directory you should place the IVR applications or scripts you are going to use.
 You will also need to route the incoming calls to the external application so it creates an instance of the IVR when the user dials that number. Let's suppose you want to use [[Regular expressions]] to route the short number 555 to the voicemail.
@@ Line 14: / Line 18: @@
 Most IVR scripts would use type "nodata" for their type as the actual voice data is not provided by the IVR itself but by Yate provided sources attached later.
 When the 555 number is dialed an instance of the voicemail.php script is launched and the "call.execute" message is passed to it (even if it didn't install a handler) so it can pick up usefull info about the call: