vxi_installation_guide:management:start

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
vxi_installation_guide:management:start [2015/02/03 21:25] – [Using VoiceXML Asterisk module] borjavxi_installation_guide:management:start [2017/07/31 16:17] (current) – ↷ Page moved from legacy:vxi_installation_guide:management:start to vxi_installation_guide:management:start javier
Line 1: Line 1:
-====== System Management ======+====== Management ======
  
 ===== Getting Started ===== ===== Getting Started =====
  
-Once you have completed installing the VoiceXML browser, you must configure the VoiceXML browser before attempting to place calls. The management and configuration procedures completely depend on the integration, as the reference VoiceXML browser components never directly access a configuration subsystem.  Instead, all configuration parameters are passed to the initialization or resource creation functions for each VoiceXML browser component. OpenVXI is an old portable open source VoiceXML interpreter and is a part of Vxi.  The Vxi VoiceXML browser is configured through a text configuration file specified on the command line. Each line of this file defines a value for a property (parameter) applying to a given VoiceXML Engine; the possible property names are defined in the interface header files for the various components.  The configuration file format is described in detail in a comment block at the top of the sample configuration file, /etc/vxmld.conf (old versions:/etc/openvxi/client.cfg).+Once you have completed installing the VoiceXML browser, you must configure the VoiceXML browser before attempting to place calls. The management and configuration procedures completely depend on the integration, as the reference VoiceXML browser components never directly access a configuration subsystem.  Instead, all configuration parameters are passed to the initialization or resource creation functions for each VoiceXML browser component. OpenVXI is an old portable open source VoiceXML interpreter and is a part of Vxi.  The Vxi VoiceXML browser is configured through a text configuration file specified on the command line. Each line of this file defines a value for a property (parameter) applying to a given VoiceXML Engine; the possible property names are defined in the interface header files for the various components.  The configuration file format is described in detail in a comment block at the top of the sample configuration file, /etc/openvxi/client.cfg.
  
 NOTE: NOTE:
Line 74: Line 74:
 </code> </code>
  
-===== Usage Syntax =====+===== VoiceXML Asterisk Application =====
  
-Description:+Application that launch a VoiceXML session in the asterisk channel and when complete, return control.
  
-Launch a VoiceXML session in the channel and when complete, return control.+==== Syntax ==== 
 + 
 + 
 +<code> 
 +Vxml([URL|Name|Number]) 
 +</code>
  
 The URL can by set with different ways : The URL can by set with different ways :
 <code> <code>
-Pass the URL as the appplication parameter. Exemple : vxml(file://tmp/test.vxml) +No parameter, the application will use the VoiceXML accounts (match called number with accounts numbers) : Vxml() 
-Pass the account name or the account number. Exemple: vxml(test) +Pass the URL as the appplication parameter. Example : Vxml(file://tmp/test.vxml) 
-Pass the “@” to match the caller number to the account number.+Pass the account name or the account number. Example: Vxml(test) 
 +Pass the “@” to allocate a VoiceXML channel and pass the execution to this dialplan extension. Example : Vxml(@600)
 </code> </code>
 Set the VXML_URL variable before executing the vxml application. Set the VXML_URL variable before executing the vxml application.
Line 91: Line 97:
 The following describes how to execute a VoiceXML session. The following describes how to execute a VoiceXML session.
  
-Syntax: 
-<code> 
-Vxml([URL|Name|Number]) 
-</code> 
  
-Variables:+==== Variables ==== 
 + 
 +Variables to set before or filled after the Vxml() execution :
  
 ** VXML_URL ** ** VXML_URL **
  
 If the variable VXML_URL has been set when vxml runs, the value of that variable will be used for the URL unless the parameter is not set to the application.  If the variable VXML_URL has been set when vxml runs, the value of that variable will be used for the URL unless the parameter is not set to the application. 
 +
 +** VXML_LOCAL **
 +
 +Force the called number (variable in VoiceXML context session.connection.local.uri).
 +
 +** VXML_REMOTE **
 +
 +Force the caller number (variable in VoiceXML context, session.connection.remote.uri).
 +
 +** VXML_MARK **
 +
 +Allow to add his value/mark in the VoiceXML browser logs associated to this call/VoiceXML session.
  
 ** VXML_ID **  ** VXML_ID ** 
Line 114: Line 130:
 After execution, the VoiceXML result of <exit> tag and the property ‘expr’ are accessible by the variable VXML_RESULT. After execution, the VoiceXML result of <exit> tag and the property ‘expr’ are accessible by the variable VXML_RESULT.
  
-Example:+** VXML_ERROR ** 
 + 
 +After execution, the VoiceXML application notify the error cause, if the VoiceXML session cannot be launched. 
 + 
 +  * VXML_ERROR=(empty) ; No error occurs. 
 +  * VXML_ERROR=INITALISATION ; Session refused, Asterisk module not connected to the VoiceXML browser. 
 +  * VXML_ERROR=LICENSE ; Session refused, license locking 
 +  * VXML_ERROR=ACCOUNT_LIMIT ; Session refused, max session for the account reached. 
 +  * VXML_ERROR=SPEECH ; Session refused, cannot allocate the Speech (ASR) ressource. 
 +  * VXML_ERROR=TTY/TDD ; Session refused, no TTD availabe. 
 +  * VXML_ERROR=BILLING ; Session refused, billing interface refuse the session. 
 +  * VXML_ERROR=INTERPRETER ; Session refused, critical error with the VoiceXML browser connection. 
 + 
 +===== Examples ===== 
 + 
 +Example use with an URL parameter:
 <code> <code>
 [incoming]  [incoming] 
Line 123: Line 154:
 </code> </code>
  
 +Example to catch the Vxml() errors :
 +<code>
 +exten => _X.,1,Vxml()
 +exten => _X.,n,NoOp(${VXML_ERROR})
 +exten => _X.,n,GotoIf($["${VXML_ERROR}" == ""]?hangup)
 +exten => _X.,n,Busy()
 +exten => _X.,n(hangup),Hangup()
 +</code>
 ===== Asterisk Online Help ====== ===== Asterisk Online Help ======
  
Line 128: Line 167:
 *CLI> help vxml *CLI> help vxml
  
-===== Management Commands ======+===== CLI Management Commands ======
  
 Now your VXI* VoiceXML browser and Asterisk PBX are running, you can manage the VXML service using the Asterisk prompt *CLI>: Now your VXI* VoiceXML browser and Asterisk PBX are running, you can manage the VXML service using the Asterisk prompt *CLI>:
Line 218: Line 257:
 The following entries are the Asterisk CLI commands for the VoiceXML browser. The following entries are the Asterisk CLI commands for the VoiceXML browser.
  
-Example:+===== VoiceXML example ====== 
 Add extensions to the Asterisk dial plan /etc/asterisk/extensions.conf: Add extensions to the Asterisk dial plan /etc/asterisk/extensions.conf:
 <code> <code>
Line 228: Line 268:
  
 You can create and edit the file /root/example.vxml with the GNU text editor, VI, for example. You can create and edit the file /root/example.vxml with the GNU text editor, VI, for example.
 +
 +<code>
 +# vi /root/example.vxml
 +</code>
  
 NOTE: NOTE:
Line 233: Line 277:
 This example will work if you have text-to-speech configured.  If not, use a pre-recorded wav or gsm file to replace the “Hello world!” text by an <audio> tag.  For more information, see the format extensions supported by Asterisk. This example will work if you have text-to-speech configured.  If not, use a pre-recorded wav or gsm file to replace the “Hello world!” text by an <audio> tag.  For more information, see the format extensions supported by Asterisk.
 <code> <code>
-<block><audio src=”hello.wav”/></block>+<?xml version="1.0"?> 
 +<vxml version = "2.0" xmlns="http://www.w3.org/2001/vxml"> 
 + <form> 
 +  <block><audio src=”hello.wav”/></block> 
 + </form> 
 +</vxml>
 </code> </code>
- 
  
 Save the file in the same directory as the VoiceXML script (relative reference in this example). Save the file in the same directory as the VoiceXML script (relative reference in this example).
 +
 Reload the extensions configuration with: Reload the extensions configuration with:
-*CLI> extensions reload+ 
 +<code> 
 +CLI> extensions reload 
 +</code>
  
 Call the service by calling: Call the service by calling:
Line 257: Line 309:
 /tmp/log.txt (default configuration) /tmp/log.txt (default configuration)
 </code> </code>
- 
-**Core files** 
- 
-Collected files should be sent by email to Technical Support (support@i6net.com). 
  
 **Log Files** **Log Files**
Line 312: Line 360:
    - An Apache/PHP script exists generate the traces from a standard Internet browser (Internet Explorer, Mozilla/firefox...). Get it from our web site    - An Apache/PHP script exists generate the traces from a standard Internet browser (Internet Explorer, Mozilla/firefox...). Get it from our web site
    - At the end of the trace record, don’t forget to stop it to recover optimal real time function. With the V4.x release, you can dynamically enable/disable the interpreter traces with an Asterisk *CLI> command.    - At the end of the trace record, don’t forget to stop it to recover optimal real time function. With the V4.x release, you can dynamically enable/disable the interpreter traces with an Asterisk *CLI> command.
- 
-Simple traces for the VoiceXML development: 
-<code> 
-*CLI> vxml debug interpreter dev 
-</code> 
  
 Full traces: Full traces:
 <code> <code>
-*CLI> vxml debug interpreter all+*CLI> vxml debug interpreter
 </code> </code>
  
Line 326: Line 369:
 <code> <code>
 *CLI> vxml no debug interpreter *CLI> vxml no debug interpreter
-</code> 
- 
-Restore the log traces: 
-<code> 
-*CLI> vxml debug interpreter log 
 </code> </code>
  
  • vxi_installation_guide/management/start.1422998731.txt.gz
  • Last modified: 2017/07/28 22:29
  • (external edit)