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 | ||
installation_guide:configuration:start [2015/12/07 17:29] – extern | installation_guide:configuration:start [2016/10/25 20:49] – [Login] borja | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== Voximal |
+ | |||
+ | ===== Access | ||
All the configuration is managed throw a web interface based on the FreePBX project. | All the configuration is managed throw a web interface based on the FreePBX project. | ||
- | To access to the web interface, open the link **'' | + | To access to the web interface, open the link |
+ | |||
+ | **'' | ||
+ | |||
+ | It's protected by a login (the first login after the installation will request you a password). | ||
- | It's protected by a login. | ||
+ | {{: | ||
===== Login ===== | ===== Login ===== | ||
- | After installation there are 3 default login, with differents access permissions | + | After installation there are 3 default login accounts, with differents access permissions |
- | * user : access to Voximal configuration and reports. | + | |
- | * admin : user access and network configuration | + | |
- | * root : all access. | + | |
- | Each login has a default | + | Each login have a default |
- | //-- add screenshot --// | + | {{: |
- | ===== Configuration steps ===== | ||
- | To configure the Voximal IVR you have 3 steps to do : | + | ===== System Status ===== |
- | - Configure the operator | + | |
- | - Create VoiceXML service ([[# | + | The home page after login show you the system status. |
+ | |||
+ | * Host name of the server | ||
+ | * Summary : Main modules status | ||
+ | * Interpreter statistics | ||
+ | * Telephony statistics | ||
+ | * Uptime / Load average | ||
+ | |||
+ | {{: | ||
+ | ---- | ||
+ | |||
+ | ===== Main configuration steps ===== | ||
+ | |||
+ | To configure the Voximal IVR you have 4 steps to do : | ||
+ | - Configure the VoIP telephony | ||
+ | - Create/edit a VoiceXML service ([[#Create a VoiceXML service|Create a VoiceXML service]]) | ||
- Create Voximal accounts ([[#Voximal accounts|Voximal accounts]]) | - Create Voximal accounts ([[#Voximal accounts|Voximal accounts]]) | ||
- Configure the relation between the DID and the VoiceXML service you want to use ([[#Routes configuration|Routes configuration]]) | - Configure the relation between the DID and the VoiceXML service you want to use ([[#Routes configuration|Routes configuration]]) | ||
- | Some default values can be updated with the page **'' | + | ---- |
+ | **Note**: On each configuration | ||
- | The license informations are accessible in page **'' | + | **Note**: All changes are not directly configure on the server. After one change, you'll see a button **[Apply Config]** in menu. To activate the changes on server __you have to click on__ **[Apply Config]**. |
+ | ---- | ||
- | // | + | ==== 1) Configure |
- | ==== SIP accounts ==== | + | If your server is connected to the internet you can use the free test access to place calls to your server. |
+ | There is nothing to do. You should only check that the port 4569 is open from/to internet in UDP. | ||
- | You can create a SIP trunk with an operator with the page **'' | + | |
+ | |||
+ | You can create a SIP trunk with an operator with the page [[installation_guide: | ||
You have to enter informations : | You have to enter informations : | ||
* A trunk name : a string to identify you accounts | * A trunk name : a string to identify you accounts | ||
Line 47: | Line 72: | ||
0033123456789: | 0033123456789: | ||
</ | </ | ||
- | | + | * Click on **[submit]** button |
- | //-- add screenshot --// | + | {{: |
- | ==== VoiceXML service ==== | + | ---- |
- | You have to create VoiceXML | + | ==== 2) Create a VoiceXML service ==== |
+ | |||
+ | You need to create VoiceXML | ||
+ | Select | ||
=== Uploading VoiceXML service === | === Uploading VoiceXML service === | ||
- | In page Applications/ | + | {{: |
+ | |||
+ | In page Applications/ | ||
At the end of the page, you have the way to upload files : | At the end of the page, you have the way to upload files : | ||
- | * Click on **'' | + | * Click on **Browse** and select your files (.vxml, .php, ...). |
- | * Then click on **'' | + | * Then click on **[Upload]**. Your files will appear in list. |
=== Create VoiceXML service with editor === | === Create VoiceXML service with editor === | ||
- | You can update VoiceXML file (extension | + | |
+ | |||
+ | You can update VoiceXML file (extension .vxml), by clicking on the filename. The file content will appear, and you'll be able to update it, and check the syntax. | ||
The editor page allow to create folders and files, and edit them. | The editor page allow to create folders and files, and edit them. | ||
- | To create folders or files, click on right items on top right corner (**'' | + | To create folders or files, click on right items on top right corner (**Create Directory** or **Create File**). |
- | Then enter filename, and click **'' | + | Then enter filename, and click **[Create]**. |
- | //-- add screenshot --// | + | {{: |
- | ==== Voximal accounts ==== | + | ---- |
- | When your VoiceXML services are ready, you have to define it in the IVR. | + | ==== 3) Create a Voximal |
- | To do it, add Voximal | + | |
- | To create a Voximal | + | When your VoiceXML services is ready, you have to configure it in the server. |
- | - An application name, in field '' | + | To do it, add Voximal account. Select the **Voximal** menu item. |
- | - The VoiceXML url of the service, in field '' | + | |
+ | To create a Voximal | ||
+ | - An application name, in field **Name** | ||
+ | - The VoiceXML url of the service, in field **URL**. You can select a local one, in the list or writing a local or HTTP one. | ||
There are several options : | There are several options : | ||
- | - Max sessions : you can define a specific limit, if you want lower maximum session than the license. | + | - **Max sessions** : you can define a specific limit, if you want lower maximum session than the license. |
- | - Dial format : you can define a specific dialout format for outgoing calls. | + | - **Dial format** : you can define a specific dialout format for outgoing calls. |
- | - Mark : you can define a specific mark, that will appear in traces. | + | - **Mark** : you can define a specific mark, that will appear in traces. |
- | - Speech : you can specify the use of the ASR. In case of using ASR server, the better way is to set '' | + | - **Speech** : you can specify the use of the ASR. In case of using ASR server, the better way is to set **Automatic** choice. |
- | - Max time : you can set a maximum duration of call. If not setted or equals to 0, the duration is unlimited. | + | - **Max time** : you can set a maximum duration of call. If not setted or equals to 0, the duration is unlimited. |
- | - Vxml parameter : you can set a string to pass it to vxml script. | + | - **Vxml parameter** : you can set a string to pass it to vxml script. |
- | - Star delay : you can set a time delay to start the service. | + | - **Start |
- | //-- add screenshot --// | + | {{: |
+ | ---- | ||
- | ==== Routes configuration ==== | + | ==== 4) Number/Routes configuration ==== |
- | Firstly, you have to define which application you want to use by default for all incoming calls. | + | You have to define which application you want to use by default for all incoming calls. |
- | It's done by defining the **'' | + | |
- | | + | It's done by defining the **any DID/any CID** or **All DIDs** settings in **Connectivity/ |
- | - Leave empty Field **'' | + | |
- | - Select the application to use : **'' | + | |
+ | - __Leave | ||
+ | - Select the application to use : **Voximal Application** | ||
* You can select an existing application | * You can select an existing application | ||
- | * Or create a new one by clicking "Add new **'' | + | * Or create a new one by clicking "Add new **Voximal application**" |
- | - **Click on submit** button | + | - Click on **[submit]** button. |
+ | |||
+ | {{: | ||
- | //-- add screenshot --// | ||
+ | ---- | ||
===== Configuration files ===== | ===== Configuration files ===== | ||
- | * / | + | * / |
- | * / | + | * / |