Enabling and controlling tone detection
To enable tone detection, set server.toneDetector.configFile on all Nuance Speech Server instances to $NSSSVRSDK/config/tones.all.on, the location of the tones library. You must do this for the other service properties to have any effect.
All service properties can be set in the Management Station, meaning they apply to all applications handled by that service. Several can also be set in an application-specific session.xml file. A session.xml file is an optional XML file that specifies parameter defaults and resources to load for a specific application. Values set in the session.xml take precedence over values set in the Management Station. This allows support for applications that handle different tones. See Use case 1—Using session.xml files to detect tones for more information.
Service properties
This table describes the service properties that control tone detection and where they can be set.
|
Service property |
Description |
Default |
Where set |
|---|---|---|---|
|
browser.tonedetection.amd.enable |
Enables or disables answering-machine tone detection. Set to FALSE to disable. |
TRUE |
Management Station (Voice Browser service) session.xml |
|
Specifies the maximum time, in milliseconds, to wait for the greeting message of a detected answering machine to finish. If this time expires, the Voice Browser service stops waiting and proceeds with the application, which determines the action to take (normally a prompt). |
30000 |
Management Station (Voice Browser service) session.xml |
|
|
browser.tonedetection.fax.enable |
Enables or disables fax tone detection. Set to FALSE to disable. |
TRUE |
Management Station (Voice Browser service) session.xml |
|
browser.tonedetection.sit.enable |
Enables or disables SIT tone detection. Set to FALSE to disable. |
TRUE |
Management Station (Voice Browser service) session.xml |
|
browser.tonedetection.tty.enable |
Enables or disables TTY tone detection. Set to FALSE to disable. |
TRUE |
Management Station (Voice Browser service) session.xml |
|
Specifies the location of the tones library configuration file, which enables tone detection. Required when using other tone-detection service properties. For North American tones, bundled with Voice Platform, set to $NSSSVRSDK/config/tones.all.on. To disable tone detection after enabling it, remove the service property from the Speech Server’s Advanced tab at the same scope at which you set it. For example, if you enabled tone detection at the network scope (globally), then remove the service property on the Speech Server at the network scope. All Speech Server instances inherit the change. |
Not set (tone detection is disabled) |
Management Station (Nuance Speech Server) |
|
|
server.toneDetector.originator |
Specifies the component detecting the tone. For Voice Platform, this value can only be nss. |
nss |
Management Station (Nuance Speech Server) |
|
server.toneDetector.timeOut |
Specifies the maximum time, in milliseconds, that tone detection is active. Once this limit is surpassed, tone detection stops. Tone detection is activated by a new call or call transfer. Applies only to fax, SIT, and TTY. There is no timeout for DTMF tones. For answering-machine tones, see browser.tonedetection.amd.maxgreeting to control the amount of time to wait for the end of a greeting message. |
20000 |
Management Station (Nuance Speech Server) |
Disabling tone detection on the gateway
For deployments on SIP, you must configure the gateway if you want Voice Platform to perform tone detection. This is required to allow audio tones to pass through undetected to Voice Platform and prevent duplicate tone handling. The method differs if you use a Cisco gateway or an AudioCodes gateway.
Cisco gateway
Make these changes at the global level or for specific dial-peer configurations:
- Set Fax protocol to none
- Remove dtmf relay
AudioCodes gateway
From Media Settings→Fax/Modem/CID Settings, set:
- Fax Transport Mode = Disable
- CNG Detector Mode = Disable
From Protocol Configuration→Protocol Definition→DTMF & Dialing, set:
- Declare
- TMF Option = blank
