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 [2016/01/18 22:18] – [2) VoiceXML service] borja | installation_guide:configuration:start [2016/10/25 21:27] – [Call Detail Record] 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** : full access |
- | Each login has a default | + | Each login have a default |
- | //-- add screenshot --// | + | {{: |
+ | ===== System Status ===== | ||
+ | |||
+ | 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 | ||
+ | |||
+ | {{: | ||
---- | ---- | ||
- | ===== Configuration | + | ===== Main configuration |
To configure the Voximal IVR you have 4 steps to do : | To configure the Voximal IVR you have 4 steps to do : | ||
- Configure the VoIP telephony access ([[installation_guide: | - Configure the VoIP telephony access ([[installation_guide: | ||
- | - Create VoiceXML service ([[# | + | - 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 |
- | // | + | === a) Use the test number and the PIN === |
- | ---- | + | 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. | ||
- | ==== 1) SIP accounts ==== | + | === b) Connect a trunk SIP === |
- | You can create a SIP trunk with an operator | + | Before you can make external calls or accept incoming calls from outside, you need to setup SIP Trunks. You can choose any VoIP Service providers. |
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 54: | Line 74: | ||
0033123456789: | 0033123456789: | ||
</ | </ | ||
- | | + | * Click on **[submit]** button |
- | //-- add screenshot --// | + | {{: |
+ | |||
+ | === c) Add an extension === | ||
+ | |||
+ | After you setup your Voxibot, the first thing you do is to add extensions (connect a Phone). The integrated FreePbx allows you to add a couple of different Device types | ||
+ | |||
+ | * Generic SIP Device | ||
+ | * Generic IAX2 Device | ||
+ | * Generic DAHDi Device | ||
+ | * Other Custom Device | ||
+ | |||
+ | Among these types, SIP device is the most common and popular one. | ||
+ | |||
+ | You can give your extension any unique number, Display Name, password, whether allow this extension to accept inbound external calls or can make outbound external calls. can have voicemail or not etc. | ||
---- | ---- | ||
- | ==== 2) VoiceXML service ==== | + | ==== 2) Create a VoiceXML service ==== |
- | You need to create VoiceXML service, by uploading it or writing it directly with embedded VoiceXML/ | + | You need to create VoiceXML service, by uploading it or writing it directly with the embedded 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. |
- | - **'' | + | - **Dial format** : you can define a specific dialout format for outgoing calls. |
- | - **'' | + | - **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 **Automatic** choice. |
- | - **'' | + | - **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. |
- | - **'' | + | - **Start delay** : you can set a time delay to start the service. |
- | //-- add screenshot --// | + | {{: |
+ | ---- | ||
- | ==== Routes configuration ==== | + | ==== 4) Number/Routes configuration ==== |
- | Firstly, you have to define which application | + | You have your DID number and SIP Trunk set up (with the test number, the called number will be 4568 : " |
- | It's done by defining | + | |
- | - Select **'' | + | You can to define which application |
- | - __Leave empty Field__ **'' | + | It's done by defining the **any DID/any CID** or **All DIDs** settings in **Connectivity/ |
- | - Select the application to use : **'' | + | |
- | | + | |
- | | + | |
- | - **Click on submit** button | + | |
- | //-- add screenshot | + | |
+ | | ||
+ | | ||
+ | * You can select an existing application (for example Voximal) | ||
+ | * Or create a new one by clicking "Add new **Voximal application**" | ||
+ | | ||
+ | {{: | ||
+ | |||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Call Detail Record ===== | ||
+ | |||
+ | The CDR Reports allows you to view a report showing the telephone calls made from and received to your system. | ||
+ | You can choose to view a complete history or calls, or to search by date, date range, number called, caller ID, etc. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ===== Logs ===== | ||
+ | |||
+ | The Asterisk Logfiles Module is an easy way to view portions of the Asterisk Log. However, this Module is only useful when you want to view a very recent event in the Asterisk Log. | ||
+ | |||
+ | You have similar Module for the Voximal log : | ||
+ | |||
+ | {{: | ||
+ | |||
+ | |||
+ | |||
+ | ===== Settings ===== | ||
+ | |||
+ | === a) General === | ||
+ | |||
+ | {{: | ||
+ | |||
+ | === b) TextToSpeech === | ||
+ | |||
+ | {{: | ||
+ | |||
+ | 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 | ||
+ | |||
+ | === d) License === | ||
+ | |||
+ | === c) Test number === | ||
+ | |||
+ | {{: | ||
+ | |||
===== Configuration files ===== | ===== Configuration files ===== | ||
* / | * / | ||
- | * / | + | * / |
+ |