Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
vxi_installation_guide:management:start [2015/02/03 21:32] – [Troubleshooting (for Support)] borja | vxi_installation_guide:management:start [2017/07/28 23:51] – ↷ Page moved from legacy:vxi_installation_guide:management:start to vxi_installation_guide:management:start javier | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== 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, | + | 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, |
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 ==== | ||
+ | |||
+ | |||
+ | < | ||
+ | Vxml([URL|Name|Number]) | ||
+ | </ | ||
The URL can by set with different ways : | The URL can by set with different ways : | ||
< | < | ||
- | Pass the URL as the appplication parameter. | + | No parameter, the application will use the VoiceXML accounts (match called number with accounts numbers) : Vxml() |
- | Pass the account name or the account number. | + | Pass the URL as the appplication parameter. |
- | Pass the “@” to match the caller number | + | Pass the account name or the account number. |
+ | Pass the “@” to allocate a VoiceXML channel and pass the execution | ||
</ | </ | ||
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: | ||
- | < | ||
- | Vxml([URL|Name|Number]) | ||
- | </ | ||
- | 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/ | ||
** VXML_ID ** | ** VXML_ID ** | ||
Line 112: | Line 130: | ||
After execution, the VoiceXML result of < | After execution, the VoiceXML result of < | ||
- | 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/ | ||
+ | * VXML_ERROR=BILLING ; Session refused, billing interface refuse the session. | ||
+ | * VXML_ERROR=INTERPRETER ; Session refused, critical error with the VoiceXML browser connection. | ||
+ | |||
+ | ===== Examples ===== | ||
+ | |||
+ | Example | ||
< | < | ||
[incoming] | [incoming] | ||
Line 121: | Line 154: | ||
</ | </ | ||
+ | Example to catch the Vxml() errors : | ||
+ | < | ||
+ | exten => _X., | ||
+ | exten => _X., | ||
+ | exten => _X., | ||
+ | exten => _X., | ||
+ | exten => _X., | ||
+ | </ | ||
===== Asterisk Online Help ====== | ===== Asterisk Online Help ====== | ||
Line 319: | Line 360: | ||
- An Apache/PHP script exists generate the traces from a standard Internet browser (Internet Explorer, Mozilla/ | - An Apache/PHP script exists generate the traces from a standard Internet browser (Internet Explorer, Mozilla/ | ||
- 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/ | - 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/ | ||
- | |||
- | Simple traces for the VoiceXML development: | ||
- | < | ||
- | *CLI> vxml debug interpreter dev | ||
- | </ | ||
Full traces: | Full traces: | ||
< | < | ||
- | *CLI> vxml debug interpreter | + | *CLI> vxml debug interpreter |
</ | </ | ||
Line 333: | Line 369: | ||
< | < | ||
*CLI> vxml no debug interpreter | *CLI> vxml no debug interpreter | ||
- | </ | ||
- | |||
- | Restore the log traces: | ||
- | < | ||
- | *CLI> vxml debug interpreter log | ||
</ | </ | ||