Voice Address Messages
A Voice Address notification type sends a spoken message to a telephone. This notification type requires the use of a SIP Server or a Dialogic board and text-to-speech software (MSSAPI).
There are two types of voice address notifications: SIP or Dialogic. 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 described in the Voice Messaging Keywords table below.
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.
Note: Text tokens can be used in this type of notification to specify a dynamic message using data from the data Point Service, the Current Value Service, or the Facility Service. See Using Tokens in Notifications for more information.
GNS Configuration File Keywords — Voice Messaging
The following keywords must be configured to enable Voice Address Notification. See Voice Messaging Keywords for more information.
| Keyword | Description |
|---|---|
|
VOICE_PROTOCOL |
VOICE_PROTOCOL specifies the protocol used for voice messaging (DIALOGIC or SIP). |
|
RESPONSE_PHONE_NUMBER |
RESPONSE_PHONE_NUMBER specifies the dial-in telephone number for notification acknowledgment. |
| Shared Text to Speech Parameters | |
|
VOICE_SPEECH_NAME |
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 |
VOICE_SPEECH_RATE specifies the speech rate used for voice notifications. (-10 to +0). |
|
VOICE_SPEECH_VOLUME |
VOICE_SPEECH_VOLUME specifies the volume used for voice notifications. (0 to 100). |
|
VOICE_SPEECH_PITCH |
VOICE_SPEECH_PITCH specifies the pitch used for voice notifications. (-10 to +10). |
| Dialogic | |
|
VOICE_PORTS |
VOICE_PORTS specifies the notification send port(s) in the format B#C#. Use a space to separate multiple ports (B1C1 B1C2). |
|
ACK_PORTS |
ACK_PORTS specifies the notification acknowledgment port(s) in the format B#C#. Use a space to separate ports (B1C1 B1C2). |
|
TTS_ENGINE |
TTS_ENGINE specifies the text-to-speech engine to use. |
|
DIALOGIC_AMD |
DIALOGIC_AMD specifies 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 |
VOICE_SIP_LINE_COUNT specifies the number of simultaneous call lines allowed for the SIP client. Valid values include 1 to 2,147,483,647. Required to start the GNS. |
|
VOICE_SIP_HOST |
VOICE_SIP_HOST specifies the name of the host server providing the SIP connection (provided by your enterprise’s IT department or VoIP experts). Authentication is required when VOICE_PROTOCOL is set to "SIP". |
|
VOICE_SIP_PORT |
VOICE_SIP_PORT specifies the port used by the SIP host for SIP connections. Authentication is required when VOICE_PROTOCOL is set to "SIP". |
|
VOICE_SIP_HOST_USER |
VOICE_SIP_HOST_USER specifies the username used to register to the SIP host (provided by your enterprise’s IT department or VoIP experts). VOICE_SIP_HOST_USER is the dialing phone number. Authentication is required when VOICE_PROTOCOL is set to "SIP". This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled. |
|
VOICE_SIP_HOST_PASSWORD |
VOICE_SIP_HOST_PASSWORD specifies the password for the username used to register to the SIP host. Authentication is required when VOICE_PROTOCOL is set to "SIP". This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled. Once encrypted, password keywords for the email server cannot be decrypted. |
|
VOICE_SIP_DISPLAY_NAME |
VOICE_SIP_DISPLAY_NAME specifies the display name that optionally may be made available to recipients for identification (e.g., caller ID) purposes. This field is the name that will appear in the caller ID of the callee (may be server-dependent or carrier-dependent). |
|
VOICE_SIP_STUN_HOST |
VOICE_SIP_STUN_HOST specifies the name of the host server providing STUN services for the SIP connection. Optional. |
|
VOICE_SIP_STUN_PORT |
VOICE_SIP_STUN_PORT specifies the port used by the STUN host for STUN services. |
|
VOICE_SIP_PROTOCOL |
VOICE_SIP_PROTOCOL specifies the SIP transport and media transfer protocols used by the SIP host for VoIP communications. The default is UDP_RTP, which means that the SIP client will use UDP for SIP transport and RTP for media transfer. |
Response Messages
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 Notification Message Cache
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.
