Differences

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

--- vxi_installation_guide:configuration:start [2015/06/05 18:27] – [General Section [general]] borja
+++ vxi_installation_guide:configuration:start [2018/06/13 22:51] (current) – borja
@@ Line 59: / Line 59: @@
 |autoexit | yes/no | no | Stop the Asterisk with return code -1, if VXI interpreter no answer (msq timeouts). |
 |monitor | yes/no/old/1..100 | no | yes execute mixmonitor() (or monitor() if old) before starting the VoiceXML session. You can set a random value (using a %).|
-|monitordirectory |directory|mixmonitor directory|Set the mixmonitor() monitor() directory or use the default one (/var/lib/asterisk/monitor).|
+|monitordirectory |directory|mixmonitor directory|Set the mixmonitor() monitor() directory or use the default one (/var/lib/asterisk/monitor). You can set @caller, @called, @both or @freepbx to change the default naming filename.|
 |monitorformat |wav/gsm/pcm/ulaw/alaw|wav|Set the format for the mixmonitor recording.|
 |defaulttimeout |value in milisecondes|5000|Default timeout if not set in the VoiceXML syntax.|
@@ Line 237: / Line 237: @@
 ^Key ^Values ^Default ^Purpose |
-|name |  |  |  |
+|name | string |  | The name or designation of the account. This reference can be used to identify the account used by the VXML application, Vxml(name of the account). |
-|number |  |  |  |
+|number | number/expression |  | The identification of an account with the called number, signaling information from the ANI function, CALLERID(). You can use the “*”, the wildcard character, to specify a substring such as *03 or 014612* , that the number function will contain. You can start the number with “_” to use Asterisk Diaplan Patterns too (see : http://www.voip-info.org/wiki/view/Asterisk+Dialplan+Patterns).The function can also be used to identify the account, like the name, Vxml(number of the account). You can start the number with “@” to match the caller number to the account number (use the same syntax as the called number There is a way to ) |
-|url |  |  |  |
+|url | URL |  | The VoiceXML URL of the account. |
-|urlvideo |  |  |  |
+|urlvideo | URL |  | The VoiceXML video URL of the account. |
-|max |  |  |  |
+|max | number | max | The maximum number of sessions allowed to this account. If there are not enough sessions then the VoiceXML application will generate an error. |
-|dialformat |  |  |  |
+|dialformat | string | empty | This is similar to the general function, but for the account only. If not set, use the general value. |
-|dialformatvideo |  |  |  |
+|dialformatvideo | string empty |  | The same purpose as the dialformat, only for video sessions. |
-|dialnumbersonly |  |  |  |
+|dialnumbersonly | yes/no | no |  |
-|force | y/n/video/audio/ulaw/alaw/flash/ringing/vxml/h263/h263p/h264 |  | y=Video / n=audio |
+|force | yes/nno/video/audio/ulaw/alaw/flash/ringing/vxml/h263/h263p/h264 |  | If set to video, set the Transfercapability to VIDEO (and enable the h324m processing). If set to audio, the Vxml application execute directly the account URL and bypass the redirection execution (parameter with '@'). |
 |videoprofile |  |  |  |
-|speech | y/n/emulation/automatic/debug |  |  |
+|speech | yes/no/emulation/automatic/debug | general | As the general function, but for the account only. If not set, use the general value. |
-|speechprovider |  |  |  |
+|speechprovider | string | general | As the general function, but for the account only. If not set, use the general value. |
-|speechscore |  |  |  |
+|speechscore |  |  | As the general function, but for the account only. If not set, use the general value. |
-|speechfactor |  |  |  |
+|mark | string | empty | Set a string mark in the VoiceXML browser traces. The session ID and this string will be added to the channel number column (3rd) in the traces (Example : …33… → …33_1_user1… ). Four redirection exist : @remote : @remote : caller number, local : called number, @id : VoieXML id parameter value, @param : VoiceXML parameter value|
-|speechforcescore |  |  |  |
+|durationlimit | number | 0 | The maximum duration in seconds for the session using this account. The call will be hangup after this maximal duration. |
-|speechforcename |  |  |  |
-|mark |  |  |  |
-|durationlimit |  |  |  |
 |maxtime |  |  |  |
 |param |  |  |  |
@@ Line 265: / Line 262: @@
 |audiowait |  |  |  |
-=====  LogsSection [logs] =====
+=====  LogsSection [logs] (deprecated) =====
 ^Key ^Values ^Default ^Purpose |
@@ Line 276: / Line 273: @@
-=====  License Section [license] =====
-The following section covers license information and keys of Vxi.
-To obtain a commercial valid license key for your copy of VoiceXML browser (for use more than one session), you should run asterisk and get your code by typing the following commands:
-<code>
-*CLI> vxml show license
-</code>
-Default License section (no key) allow to run any VoiceXML application with one free port.
-Example:
-<code>
-[license]
-max=1
-key=
-</code>
-Example:
-<code>
-[license]
-max=30
-key=yourkey
-</code>
-=====  Account Section [account_] =====
-The Vxi VoiceXML browser is designed to manage hosted VoiceXML services and share different applications thru different Inbound / Outbound phone lines. This will allow you to manage customers’ accounts for VoiceXML hosted applications and control easily the capacity you need to assign to each one.
-To create accounts, you need to add an [accountX] section (where “X” is a number  1-100) in the bottom part of the /etc/asterisk/vxml.conf file. Please find here three added accounts to manage different port capacity per application/URI:
-Examples:
-<code>
-[account1]
-name=voiceportal1
-local=0099090
-url=http://www.i6net.com/vxml/voiceportal1.vxml
-max=25
-[account2]
-name=helloworld
-local=0099090
-url=http://www.i6net.com/vxml/helloword/index.vxml
-max=10
-[account3]
-name=localservice
-local=0099090
-url=http://localhost/vxml/test.vxml
-max=51
-</code>
-The account properties are defined within sections.  Each account has a specific section. The sections are named and numbered from account1 to account99 (maximun 100 accounts).  The example below shows the functions in each account section.
-<code>
-[account1]
-name=example
-number=*3
-url=http://…/index.vxml
-urlvideo=http://…/index.vxml
-max=5
-speech=no
-dialformat=SIP/%s
-dialformatvideo=SIP/%s
-</code>
-** name= {string}**
-This function indicates the name or designation of the account.  This reference can be used to identify the account used by the VXML application, Vxml(name of the account). This allows you to execute a VoiceXML session corresponding to the account values.
-**number= {called number}**
-This function allows the identification of an account with the called number, signaling information from the ANI function, CALLERID().  You can use the “*”, the wildcard character, to specify a substring such as *03 or 014612* , that the number function will contain. You can start the number with “_” to use Asterisk Diaplan Patterns too (see : http://www.voip-info.org/wiki/view/Asterisk+Dialplan+Patterns).The function can also be used to identify the account, like the name, Vxml(number of the account).  You can start the number with “@” to match the caller number to the account number (use the same syntax as the called number
-There is a way to )
-**url= {voicexml URL}**
-This function indicates the VoiceXML URL of the account.
-**urlvideo= {voicexml URL}**
-This function defines the Video VoiceXML URL of the account. The call is identified as a video call by the set codecs or the function CHANNEL(transfercapability)=VIDEO.
-**max= {0…120}**
-This indicates the maximum number of sessions allowed to this account. If there are not enough sessions then the VoiceXML application will generate an error.
-**dialformat= {application(]/%s[)}**
-This is similar to the general function, but for the account only. If not set, use the general value.
-**dialformatvideo= {application(]/%s[)}**
-This function has the same purpose as the dialformat, only for video sessions.
-**force= {video/audio}**
-If set to video, set the Transfercapability to VIDEO (and enable the h324m processing).
-If set to audio, the Vxml application execute directly the account URL and bypass the redirection execution (parameter with '@').
-**speech= {yes/no/emulation/automatic}**
-This speech function is as the general function, but for the account only. If not set, use the general value.
-**speechprovider= {lumenvox/verbio}**
-This speech function is as the general function, but for the account only. If not set, use the general value.
-**speechscore= {0..100}**
-This speech function is as the general function, but for the account only. If not set, use the general value.
-**speechforcedscore= {0..100}**
-This speech function is as the general function, but for the account only. If not set, use the general value.
-**mark= {string/@local/@remote/@id/@param}**
-Set a string mark in the VoiceXML browser traces. The session ID and this string will be added to the channel number column (3rd) in the traces (Example : ...|33|... → ...|33_1_user1|... ).
-Four redirection exist :
-	@remote : caller number
-	@local : called number
-	@id : VoieXML id parameter value
-	@param : VoiceXML parameter value
-**durationlimit= {0…}**
-This indicates the maximum duration in seconds for the session using this account. The call will be hangup after this maximal duration.
 =====  Configuration example =====