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/25 21:20]
borja
vxi_installation_guide:management:start [2017/07/31 16:17]
javier ↷ Page moved from legacy:vxi_installation_guide:management:start to vxi_installation_guide:management:start
Line 3: Line 3:
 ===== 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 77: Line 77:
  
 Application that launch a VoiceXML session in the asterisk channel and when complete, return control. Application that launch a VoiceXML session in the asterisk 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. Exemplevxml(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. ExampleVxml(test) 
 +Pass the “@” to allocate a VoiceXML channel and pass the execution to this dialplan extensionExample : 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 89: 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 111: Line 129:
  
 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.
- 
  
 ** VXML_ERROR ** ** VXML_ERROR **
Line 126: Line 143:
   * VXML_ERROR=INTERPRETER ; Session refused, critical error with the VoiceXML browser connection.   * VXML_ERROR=INTERPRETER ; Session refused, critical error with the VoiceXML browser connection.
  
 +===== Examples =====
  
-Example:+Example use with an URL parameter:
 <code> <code>
 [incoming]  [incoming] 
Line 136: 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 ======
  
  • vxi_installation_guide/management/start.txt
  • Last modified: 2017/07/31 16:17
  • by javier