Differences

This shows you the differences between two versions of the page.

--- vxi_installation_guide:freepbx:start [2015/02/10 13:21] – borja
+++ vxi_installation_guide:freepbx:start [2017/07/31 16:17] (current) – ↷ Links adapted because of a move operation javier
@@ Line 1: / Line 1: @@
 ====== FreePBX ======
-[[:vxi_installation_guide:start|Home]] >
+[[vxi_installation_guide:start|Home]] >
@@ Line 19: / Line 19: @@
 The following open source distributions include FreePBX:
-  * The Official FreePBX Distro
+  * [[http://www.freepbx.com|The Official FreePBX Distro]]
-  * PBX in a Flash
+  * [[http://pbxinaflash.org/|PBX in a Flash]]
-  * AsteriskNOW
+  * [[http://www.asterisk.org/|AsteriskNOW]]
-  * Elastix
+  * [[http://www.elastix.org/|Elastix]]
 Over this installation, you add the VoiceXML browser following the "VoiceXML browser Installation" steps.
@@ Line 31: / Line 31: @@
-The FreePBX integration is only available for V12 and after VXI* VoiceXML browser releases.
+The FreePBX integration is only available for **V12** and after VXI* VoiceXML browser releases.
-===== Module installation =====
+===== VoiceXML Module installation =====
+NOTE:
+To access FreePBX in Elastix you have to enable Direct access from Security >Advance Setting.
+**Enable direct access (Non-embedded) to FreePBX : ON**
+Open the Browser, access URL https://your_pbx_ip_address/admin
 === Step 1 ===
@@ Line 38: / Line 47: @@
 Go to the Admin menu and select Module Admin items.
-{{:vxi_installation_guide:freepbx:2_menu_module_admin.png?600|}}
+{{:vxi_installation_guide:freepbx:2_menu_module_admin.png?640|}}
 === Step 2 ===
@@ Line 46: / Line 55: @@
 Its status is uninstalled.
-{{:vxi_installation_guide:freepbx:3_module_voicexml_uninstalled.png?600|}}
+{{:vxi_installation_guide:freepbx:3_module_voicexml_uninstalled.png?640|}}
 === Step 3 ===
-Select Acion :'Install', and validate with 'Progress'.
+Select Acion :'Install', validate with 'Progress' and confirm the installation.
-{{:vxi_installation_guide:freepbx:6_module_voicexml_install_confirm.png?600|}}
+{{:vxi_installation_guide:freepbx:6_module_voicexml_install_confirm.png?640|}}
 === Step 4 ===
@@ Line 59: / Line 68: @@
 Enable Module Signature Module : set 'False' and validate.
-{{:vxi_installation_guide:freepbx:9_disable_module_signature_checking.png?600|}}
+{{:vxi_installation_guide:freepbx:9_disable_module_signature_checking.png?640|}}
 ===== VoiceXML Module =====
@@ Line 66: / Line 75: @@
 === VoiceXML Settings (Settings) ===
-{{:vxi_installation_guide:freepbx:10_voicexml_settings.png?600|}}
+The form configure main VoiceXML general parameters.
+  * **Record silence** : When the record start, keep or remove the silence before the voice of the speaker.
+  * **Threshold** : Adjust the sensibility of the VoiceActivityDetection used by the VoiceXML module.
+  * **WAV default codec** : When the VoiceXML browser set encoding "audio/x-wav", define the codec used with the Wav Contener.
+  * **Debug** : Enable the VoiceXML logs (for the VoiceXML Asterisk Module, and for the VoiceXML browser with verbose DEV).
+  * **Priority Events** : If mixed DTMF grammars with single DTMF keys and long DTMF inputs, set if after the first digits (events) the VoiceXML should return a value or if it should wait for possible long length input.
+  * **Dial format** : String format parameter to set the asterisk Dial() parameter with the <transfer> destination attribute. Example: SIP/%s@sip_trunk.
+  * **Cache timeout** : Remove Temporary TextToSpeech audio files after this time.
+{{:vxi_installation_guide:freepbx:10_voicexml_settings.png?640|}}
 === VoiceXML License (Settings) ===
-{{:vxi_installation_guide:freepbx:10_voicexml_license.png?600|}}
+Set the license options:
+  * **Key** : License Key provider by i6net after purchasing a commercial license.
+  * **Expiration Date** :  Expiration date YYMMDD.
+  * **Video** : Enable video functions (play/record/transcoder applications).
+  * **TextToSpeech** : Enable TextToSpeech prompting.
+  * **Speech** : Enable Speech/AutomaticSpeechRecognition recognizing.
+  * **Externals** : Enable to execute Asterisk Dialplan Extension with keeping the VoiceXML session context.
+  * **Dialer** : Enable Dialer ().
+{{:vxi_installation_guide:freepbx:10_voicexml_license.png?640|}}
 === VoiceXML Statistics (Reports) ===
-{{:vxi_installation_guide:freepbx:10_voicexml_statistics.png?600|}}
+{{:vxi_installation_guide:freepbx:10_voicexml_statistics.png?640|}}
 === VoiceXML Log Files (Reports) ===
-{{:vxi_installation_guide:freepbx:15_voicexml_log_files.png?600|}}
+{{:vxi_installation_guide:freepbx:15_voicexml_log_files.png?640|}}
 === VoiceXML Application (Application) ===
-{{:vxi_installation_guide:freepbx:11_voicexml_add_application.png?600|}}
+{{:vxi_installation_guide:freepbx:11_voicexml_add_application.png?640|}}
 ===== Configuration example =====
-Create a new VoiceXML application.
+=== Add a VoiceXML application ===
 Select Menu Application and item VoiceXML.
 Fill the Application form like this :
-{{:vxi_installation_guide:freepbx:12_voicexml_add_application_filled.png?600|}}
+{{:vxi_installation_guide:freepbx:12_voicexml_add_application_filled.png?640|}}
+The VoiceXML browser will play the audio file message.wav (in the same folder). In this example, the audio content is an english message.
+<code>
+<?xml version="1.0"?>
+<vxml version = "2.0" xmlns="http://www.w3.org/2001/vxml">
+  <form>
+    <block>
+      <prompt>
+        <audio src="message.wav"/>
+      </prompt>
+    </block>
+  </form>
+</vxml>
+</code>
+Download :
+[[http://links.i6net.com/index.vxml|index.vxml]]
+[[http://links.i6net.com/message.wav|message.wav]]
+To be able to execute The VoiceXML Application, you can set use a Misc Application to define a Feature Code to be able to call this service locally from any Extension Phone. Another way is to define in a 'Trunk' and use the 'Inbound route'  with 'Destination' set to the VoiceXML applicatiion.on.
+=== Add a Misc application ===
+To be able to execute The VoiceXML Application, you can set use a Misc Application to define a Feature Code to be able to call this service locally from any Extension Phone.
+Select the privous VoiceXML application added.
+Another way is to define in a SIP trunk configuration to set the VoiceXML application too.
+{{:vxi_installation_guide:freepbx:14_add_misc_application_filled.png?640|}}
+=== Call the VoiceXML application ===
+Apply the configuration modifications and call the 9999 from your phone extension.
+{{:vxi_installation_guide:freepbx:eyebeam.png|}}
+=== Debug the VoiceXML application ===
+With the VoiceXML Log Files you can access to the VoiceXML browser logs (to enable it you need to enable 'Debug' in the 'VoiceXML settings').
-To be able to execute The VoiceXML Application, you can set use a Misc Application to define a Feature Code to be able to call this service locally from any Extension Phone. Another way is to define in a SIP trunk configuration to set the VoiceXML application too.
+{{:vxi_installation_guide:freepbx:15_voicexml_log_files.png?640|}}
-{{:vxi_installation_guide:freepbx:14_add_misc_application_filled.png?600|}}