Installing VoiceGuide v7 for VoIP / HMP
VoiceGuide v7.x can use VoIP (SIP) to handle calls over the network interface.
No physical cards are needed for deploy a VoIP/SIP only system.
VoIP/SIP deployments can also be made on Virtual Machines and on 'Cloud' services.
Platforms supported: VMware ESXi, Microsoft Azure Cloud.
HMP can also use Dialogic HMP Interface Boards to allow HMP systems to connect to physical T1/E1/Analog lines
Installing Dialogic HMP
Dialogic HMP 3.0 drivers should be installed first.
Please always refer to the Dialogic Release Notes and/or Installation Notes to determine what operating system may be used, and what system tests need to be ran to confirm HMPs suitability. eg: hpettool.exe to test for HPET compatibility.
It is best if only one network interface is enabled on the system.
If more then one network interface is enabled on the system then Dialogic HMP must use the 'First' network interface for all VoIP/SIP communications.
On Server class systems if there is an option to set 'C-State' then you need to ensure that C-State is disabled (set to C0).
After installing HMP you will need to ensure that the Dialogic service is started. The Dialogic service can be started using the Dialogic Configuration Manager (DCM).
If Dialogic HMP service has problems starting then you should ensure that there is no other VoIP
software installed on the system that would interfere with HMP operation, and that no anti-virus type software is blocking the service start.
If there are still problems then please try fully disabling the Windows' User Access Control and then reinstalling the Dialogic System Release drivers. Windows' User Access Control is disabled in the Windows Registry, by setting the EnableLUA parameter to 0.
To re-install Dialogic System Release you need to first fully uninstall it, selecting 'Do not save configuration', and restart system after uninstall. After installing the Dialogic System Release the system needs to be restarted again.
If using HMP Interface Boards please ensure that the 'Device -> Restore Defaults' is done for all the cards present in system as well as for the 'HMP_Software' device and the 'Configured Devices' root. This is done using Dialogic DCM.
It's recommended to also set the Dialogic service to start automatically. This can be set using DCM 's Settings -> System/Device autostart -> Start System menu, or by using the Windows' Control Panel -> System and Security -> Administrative tools -> Services applet.
HMP comes with a 1 port Evaluation license.
Please contact firstname.lastname@example.org regarding purchasing of HMP licenses or obtaining temporary HMP evaluation licenses
Testing VoIP/SIP System Installation
After installing HMP, start Dialogic's IP Media Server Demo application, and then perform a test call into the system by dialling the IP address of the HMP system from a VoIP phone or softphone on another system.
The IP Media Server Demo application is located here:
The C:\ProgramData\ directory is a hidden directory, and needs to be made visible first:
Windows 8, Windows 2012 :
In File Explorer click View on the menu bar at the top. From the displayed icons on the ribbon click Options.
From the opened File Options box go to View tab. In the Advanced Settings list select "Show hidden files, folders and drives" option.
Click OK to save.
(See also: here and here)
Windows 7, Windows 2008 :
Click on C:\ drive in Windows Explorer, then click on the "Organize" button in top left corner and select "Folder and Search Options". Click on "View" tab and select "Show hidden files, folders and drives" option. Click OK to save.
T1/E1/Analog HMP Systems
For systems which use Dialogic HMP Interface Boards to connect with T1/E1/Analog lines please refer to installation and configuration instructions for the board which is used.
NOTE: The testing softphone MUST NOT be installed on the same system as Dialogic HMP.
It must be installed on some other system.
There can be no other SIP software that uses SIP 5060 port installed on same system as Dialogic HMP.
Only one software can use the SIP 5060 port.
One softphone that you can use to dial the IP address directly is Linphone.
Linphone can be downloaded here: http://www.linphone.org/
With Linphone the SIP address to be dialled must be prefixed with "sip:" eg: sip:10.1.1.19 will dial IP address 10.1.1.19 directly.
Also please select Linphone's Options->Preferences menu, and set the following:
Network Settings tab : Media Encryption is set to 'None'
Codecs tab: only enable the PCMU and PCMA codecs, and disable the rest.
Another softphone that you can use to dial the IP address directly is SJPhone.
SJPhone can be downloaded here: http://www.sjlabs.com/sjp.html
Once SJPhone is installed the IP address by itself can be just entered as the number to call, and SJPhone will dial that IP address directly.
Trace SIP Messages
WireShark can be used to confirm that SIP packets are arriving at VoiceGuide/HMP system.
To isolate SIP traffic the following should be specified in WireShark's Filter text box:
To isolate SIP and RTP traffic the following should be specified in WireShark's Filter text box:
sip || rtp
To save the isolated traces go to WireShark's File->Export Specified Packets menu and save the displayed packets as .pcapng format.
A successful running of the IPMediaServer demo should look like this in the Command Prompt window:
* IP Media Server - Media services over IP Demo Program. *
[info] CEventRouter::Init: Initializing channels...may take a few seconds!
Number of Fax (& Voice) boards found: 1
Number of Voice (& Fax boards) found: 1
Number of IPT boards found: 1
Number of IPM boards found: 1
Waiting for key:
'Q' - to quit
CIPDevice::processEvent -> receive GCEV_UNBLOCKED on :N_iptB1T1:P_IP:M_ipmB1C1
Dialogic's HMP drivers must be installed before proceeding with VoiceGuide installation.
VoiceGuide needs to be installed using the Administrator account. If not logged in as Administrator then right click on install .EXE and select 'Run as administrator'.
When installing VoiceGuide select the "VoIP / SIP / HMP" option to install the configuration files used for VoIP / HMP installations.
System configuration is set using the Config.xml file. Config.xml file is located in VoiceGuide's \conf\ subdirectory.
Config.xml is used to set the script to be used when answering incoming calls, and a number of other settings.
The default Config.xml file opens one VoIP line.
Sample Config files are provided showing how to set up the Config.xml file for systems other then the default 1 line VoIP setup.
If not running as Administrator then some permission changes may need to be made to allow editing of Config.xml, VG.INI, etc. files.
In Windows Explorer:
- Right click on the VoiceGuide directory,
- Select Properties,
- Go to the Security tab,
- Make the necessary changes
Alterntively, the text editor application used to edit the Config.xml, VG.INI, etc. files would need to be started using the 'Run as administrator' option. Then Windows will not block the saving of new versions of Config.xml, VG.INI, etc. files.
Perform a test call into the system by dialling the IP address of the HMP system from VoIP phone or softphone on another system.
In order for VoiceGuide to answer calls directed to specific VoIP lines and extensions VoiceGuide must 'register' itself with the relevant VoIP Server. Configuration of the registration process is made through the Config.xml. The relevant VoIP_Registrations and VoIP_Authentications sections in Config.xml must be filled out in order for VoiceGuide to register the VoIP lines/extensions.
After you hear the demonstration script answer the call you are now ready to start creating your own scripts, make outgoing calls etc.
The Script Designer and other VoiceGuide applications can be started by right-clicking on the IVR tray icon and selecting from the context menu.
If not running as Administrator then you will not be able to stop and start the VoiceGuide service using the VoiceGuide Service Monitor applet from the icon tray.
To stop/start the VoiceGuide IVR service you will need to go to Control Panel -> System and Security -> Administrative tools -> Services
Setting Transport Protocol and Port
Default transport protocol is UDP. Most VoIP systems use UDP for SIP communications. If the VoIP systems with which VoiceGuide is to communicate use TCP instead, then VoiceGuide can be configured to use TCP by setting the following entry in VG.INI's [SIP] section:
Port used can be set using the sip_signaling_port entry.
In order to allow incoming VoIP calls to be received by VoiceGuide service the Firewall Inbound Rules will need to be set to allow incoming SIP packets (or, if possible, the Firewall can just be disabled).
Firewall Inbound Rules should be set to allow the vgIvrService.exe program to receive all types of incoming messages (both TCP and UDP).
The specific port ranges used are:
RTP: 49100 and above
VoiceGuide Reporting and REST API : 7130 - 7140
Wav file format
All sound files should be in .WAV uLaw format (8kHz, 8 bit, Mono, uLaw). uLaw is often used for VoIP conenctions.
The exact same bytes from the .WAV uLaw sound file will be sent in the RTP packets if the connection also uses G.711 uLaw. This allows exact control over quality of sound played over the VoIP connection.
Applying Dialogic HMP License
After selecting the new license in the HMP License Manager the following steps need to be performed in the DCM.
1. Click on the "HMP Software" entry in the DCM to select it.
2. Click Device -> Restore Defaults menu.
3. Press Yes.
4. The "Assign Firmware File" windows will open. Click on the license which you want to select and then press OK.
5. Another Winow will open for a few seconds.
6. On completion the "Restore device defaults successful" message will be shown. License has now been applied.