There are two types of voice address notifications: Dialogic or SIP. These are specified by the VOICE_PROTOCOL parameter in the Gns.cfg file.
When the VOICE_PROTOCOL parameter value is "SIP", the voice address notifications use the parameters that are required for SIP. These keywords are noted in the GNS Configuration File Voice Messaging Keywords table.
If a user selects "DIALOGIC" as the protocol, the voice address notifications require a Dialogic text-to-speech board and the Microsoft Speech API (MSSAPI) text-to-speech software. The Dialogic board is manufactured by Intel. MSSAPI is a standard Windows component on newer operating systems. You can verify its installation by viewing the Speech Properties in the Control Panel.
Installation of the Dialogic board, its drivers, and the Microsoft Speech API software are outside of the scope of CygNet.
Note: The CygNet GNS uses the Microsoft Speech API (SAPI) for text-to-speech conversion. The SAPI comes pre-installed with Windows. If you want to install other third-party voices, they must be compatible with version of SAPI pre-installed with Windows.
The following keywords must be configured to enable Voice Address Notification. See Voice Messaging Keywords for more information.
| Keyword | Description |
|---|---|
|
VOICE_PROTOCOL |
The protocol used for voice messaging (DIALOGIC or SIP). |
|
RESPONSE_PHONE_NUMBER |
Specifies the dial-in telephone number for notification acknowledgment. |
| Shared Text to Speech Parameters | |
|
VOICE_SPEECH_NAME |
Specifies the text-to-speech synthesizer to use for voice notifications. The name must be enclosed in quotation marks if it contains spaces (for example, "Microsoft David", "Microsoft Zira"). Voices are shipped with each Windows operating system, or other voices are available for download for use with client, server and mobile platforms from Microsoft and third-party vendors. |
|
VOICE_SPEECH_RATE |
Specifies the speech rate used for voice notifications (-10 to +0). |
|
VOICE_SPEECH_VOLUME |
Specifies the volume used for voice notifications (0 to 100). |
|
VOICE_SPEECH_PITCH |
Specifies the pitch used for voice notifications (-10 to +10). |
| Dialogic | |
|
VOICE_PORTS |
Specifies the notification send port(s) in the format B#C#. Use a space to separate multiple ports (B1C1 B1C2). |
|
ACK_PORTS |
Specifies the notification acknowledgment port(s) in the format B#C#. Use a space to separate ports (B1C1 B1C2). |
|
TTS_ENGINE |
Specifies the text-to-speech engine to use. |
|
DIALOGIC_AMD |
The switch to enable answering machine detection. This is a Dialogic feature. If an answering machine is detected, the Dialogic board will not play the message until prompted to do so by the answering machine. |
| SIP | |
|
VOICE_SIP_LINE_COUNT |
The number of simultaneous call lines allowed for the SIP client. |
|
VOICE_SIP_HOST |
The name of the host server providing the SIP connection. |
|
VOICE_SIP_PORT |
The port used by the SIP host for SIP connections. |
|
VOICE_SIP_HOST_USER |
The username used to register to the SIP host. |
|
VOICE_SIP_HOST_PASSWORD |
The password for the username used to register to the SIP host. |
|
VOICE_SIP_DISPLAY_NAME |
Depending on how the SIP server is configured, the display name may be made available to recipients for identification (e.g., caller ID) purposes. |
|
VOICE_SIP_STUN_HOST |
The name of the host server providing STUN services for the SIP connection. |
|
VOICE_SIP_STUN_PORT |
The port used by the STUN host for STUN services. |
|
VOICE_SIP_PROTOCOL |
The SIP transport and media transfer protocols used by the SIP host for VoIP communications. |
Response messages are those messages played along with a voice notification (such as the greeting, farewell, instructions for repeating, acknowledging, and passing on the message, etc.) The messages are stored in an XML file (Responses.xml) in the GNS directory. An editor (ResponsesEditor.exe) is included in the CygNet\Utilities directory provided so that you can edit the messages. By default these messages are text-to-speech messages, however, you can also use WAV files. You must supply the WAV files.
Two of the messages are time-out messages. A user has 30 seconds to take action. If the notification requires acknowledgment, the "notime_unacked" message will be played. If the notification does not require acknowledgment, the "notime" message will be played.
See GNS Responses Editor Utility for more information.
Voice notifications are saved in a cache on the host server (C:\WINDOWS\Temp\CygNetCache\SITE.GNS_Notifications, where SITE is the name of the CygNet site). The notification information is stored in XML files. The file names are sequentially numbered. The cache will store the last 100 messages.