Settings
Name (Label) |
Type |
Req'd |
Single Setting Value |
Sub. Allow |
Default |
Notes |
||
(Input Mode) |
string enum |
Yes |
|
|
both |
The type of
entry allowed for input. Possible values are:
The adapter type Cisco DTMF is not compatible with input modes
|
||
(Noinput Timeout) |
string |
Yes |
|
|
|
The maximum time allowed for silence or no keypress before a noinput event is thrown. Possible values are standard time designations including both a non-negative number and a time unit, for example, 3s (for seconds) or 3000ms (for milliseconds). Default = 5s. |
||
(Form Max NoInput) |
int ≥ 0 |
Yes |
|
|
|
0 = infinite noinputs allowed. |
||
(Form Max NoMatch) |
int ≥ 0 |
Yes |
|
|
|
0 = infinite nomatches allowed. |
||
(Form Confidence Level) |
decimal (0.0 – 1.0) |
Yes |
|
|
|
The confidence level threshold to use for data capture. |
||
(Voice Grammar) |
string |
*No |
|
|
None |
Defines an external voice grammar for Form, in a string format delimited with semi-colons specifying these values in the following order:
The type can
be left blank to use the adapter default or set to
This setting
is repeatable so multiple external grammar sources may be specified. None of
the four settings -
|
||
(DTMF Grammar) |
URI |
*No |
|
|
None |
Defines an external DTMF grammar for Form, in a string format delimited with a semi-colon specifying four values in the following order:
The type can be left blank to use the adapter default or set to null to not include a type at all. If one of the optional parameters is defined, three semi-colons must be used, even if the other parameters are not used. For example:
This setting
is repeatable so multiple external grammar sources may be specified. None of
the four settings -
|
||
(Voice Keyword) |
string |
*No |
|
|
None |
Defines the inline voice grammar for Form, with each configuration of this repeatable setting specifying one option for the grammar. The valid format is a string separated with a semi-colon specifying four values in the following order:
Sample configurations values are:
None of the
four settings -
|
||
(DTMF Keypress) |
character (0-9, #, *) |
*No |
|
|
None |
Defines the inline DTMF grammar for Form, with each configuration of this repeatable setting specifying one option for the grammar. The valid format is a string separated with a semi-colon specifying three values in the following order:
Sample configurations values are:
None of the
four settings -
|
||
(Help Voice Keyword) |
string |
No |
|
|
None |
Specifies a custom inline voice grammar to activate the help audio group. Each value of this repeatable setting adds another valid utterance. The format is a string specifying just the utterance (for example, news report). If this setting is configured, a custom inline voice grammar will be generated, replacing the default help grammar used by a browser, and the custom grammar will be active only within the current Form element. |
||
(Help DTMF Keypress) |
character (0-9, #, *) |
No |
|
|
None |
Specifies a custom inline DTMF grammar to activate the help audio group. Each value of this repeatable setting adds another valid DTMF keypress. The format is a character (0-9, #, *) representing just the keypress. If this setting is configured, a custom inline DTMF grammar will be generated, and it will be active only within the current Form element. |
||
(Disable Hotlinks) |
boolean |
Yes |
|
|
|
Whether or not to temporarily disable all hotlink grammars (global or local) and universal grammars. If set to true, only the current Form element grammars will be enabled for the duration of the element. Otherwise all active grammars will be enabled. |
||
(Field Name) |
string |
Yes |
|
|
found ation _fld |
foundation_fld - The value to assign to the VXML field name attribute. |
||
(Field Slot) |
string |
No |
|
|
None |
The name to assign to the VXML field slot attribute. If left unspecified, the field will not include a slot attribute. |
||
(Slot Element Data) |
string |
No |
|
|
None |
Specifies for which grammar slot the return value should be stored as element data. This is a repeatable setting so multiple slot names can be specified. See notes below for further details. |
||
(Maxnbest) |
int ≥ 1 |
Yes |
|
|
1 |
The maximum number of speech recognition results that can be generated per voice input. |
||
(Secure Logging) |
boolean |
Yes |
|
|
|
If set to true, user DTMF input for the element is considered
secure and the attributes utterance, interpretation, value, nbestUtteranceX and
nbestInterpretationX are masked in VXML server logs. The format used to render
secure element attributes is to add a
_secureLogging
suffix. For example
|
||
|
boolean |
Yes |
|
true |
|
When the property is set to true the wave-form-uri of the recorded audio is submitted to VXML server. |
||
(DTMF Overlay) |
Boolean |
Yes |
|
|
|
Setting this property to
|
||
(DTMF Overlay Interval) |
String |
Yes |
|
|
|
Time Interval (in ms) between the generation of two DTMF tones. The interval is a random number that is +/-25% of the duration
that is mentioned. For example, if the duration mentioned is
|
|