VoiceXML properties

At the highest level of precedence, you can specify a value for certain parameters within a VoiceXML application. Some such parameters can be set via the VoiceXML <property> element, while others may be set as an attribute of another VoiceXML element.

Within a VoiceXML application, the precedence of a property is governed by the rules of VoiceXML.

Parameters that may be specified in VoiceXML include:

  • W3C recommended parameters—The W3C VoiceXML specification recommends support for certain standard parameters related to speech recognition.
  • Application-settable service properties—Some Voice Platform service properties can be set within an application rather than at service initialization.
  • Proprietary application-settable parameters—Some parameters that are proprietary to Nuance can also be set in VoiceXML.

These parameters are fully described in other manuals of the Voice Platform documentation set as noted below.

Many VoiceXML parameters can also be set in a context file. For more information on context files, see Using context files.

W3C recommended parameters

The W3C Voice Extensible Markup Language specification describes several standard parameters that Voice Platform supports. These parameters can all be specified in a <property> element. Some of them (bargein and timeout) are also attributes of the <prompt> element.

The parameters described in the W3C VoiceXML specification include:

Parameter

Type

Description

bargein

String

Allows callers to interrupt prompts.

This parameter may be set in a <property> element, or as an attribute of the <prompt> element.

completetimeout

Integer

Specifies the time to wait before assuming the end of caller speech if the current utterance is recognizable.

confidencelevel

Integer

Minimum confidence score. Voice Platform rejects utterances with scores below this value.

incompletetimeout

Integer

Specifies the time to wait before assuming the end of caller speech if the current utterance is not recognizable.

maxspeechtimeout

Integer

Sets maximum duration for an utterance.

sensitivity

Integer

Controls speech detector sensitivity when looking for speech.

timeout

Integer

How long to wait for speech after a prompt ends.

This parameter may be set in a <property> element, or as an attribute of the <prompt> element.

Application-settable service properties

Most Voice Platform service properties are applied to a specific service at initialization—that is, when you start the service in the Management Station. However, very few service properties can be set at runtime in an application, using the <property> element.

The application-settable service properties include:

Parameter

Type

Description

audio.nms.isdncta

String

Specifies the lines for running the isdncta process to start the D-channel.

audio.nms.ISDNVariant

String

Specifies the ISDN protocol variant for the NMS board.

audio.nms.Protocol

String

Specifies the underlying protocol for the NMS board to use.

audio.sip.listenipaddress

String

Specifies the host name or IP address used to build the SIP contact header.

Proprietary application-settable parameters

In addition to application-settable service properties and the standard properties described in the W3C VoiceXML specification, Voice Platform supports certain proprietary extensions to VoiceXML.

The Nuance extensions that are supported in Voice Platform include:

Parameter

Type

Description

swirec.mute_wcr

Boolean

When activated (1), masks a caller utterance with silence in the whole call recording.

swirec.secure_context

String

Suppresses or encrypts a user response in call logs.

switts.mute_wcr

Boolean

When activated (1), masks an application prompt with silence in the whole call recording.

switts.secure_context

String

Suppresses or encrypts an application prompt in call logs.

For more information on these parameters, see Logging security.