Hardware Interface Interaction Parameters
By using LVCA_SetCustomStringData, you can control the Platform's hardware interface, allowing for greater
control of how the Platform will treat incoming speech and DTMF entry. Simply use SetCustomStringData to the parameters outlined below, using the
values specified in the description field.
| Parameter |
Type |
Default |
Description |
| DTMF_MATCH_MASK |
String |
"" |
Specifies list of DTMF string values that cause immediate return of the DTMF string. See Digit Mask, below for a more detailed description. |
| DTMF_MAX_DIGITS |
Integer |
31 |
The maximum number of DTMF digits to collect. |
| DTMF_INTER_DIGIT_TIMEOUT |
Integer |
2000 |
The time, in milliseconds, the system will wait between DTMF digits. If this value is reached, the system returns
and stops waiting for more digits. |
| SILENCE_TIMEOUT |
Integer |
2000 |
The time, in milliseconds, to wait after a prompt finishes playing accepting user input. |
| PROMPT_TO_SKIP |
Integer |
0 |
The system can skip over prompts initially. This is useful for applications like an e-mail reader, where a user may stop in the middle of
a long message and return. By setting this value to where the user was, the user will not have to listen to the entire prompt again. This
value is specified in milliseconds, and if the value is longer than the first prompt, the system will move through multiple prompts. |
| ENTER_KEY |
String |
"#" |
The specified digit acts as an enter key for DTMF input. When this digit is detected, the system will return immediately when the
enter key is received (the enter key itself is not returned). |
| ENTER_KEY_MODE |
Integer |
1500 |
Specifies how the enter key should behave.
If set to 0, the digit specified as the enter key will be returned if it is the first digit entered, meaning it will function as the
enter key only if it is not the first character entered.
If set to a value greater than zero, the value represents the time, in milliseconds, before it acts as an enter key (i.e. it will be a normal
digit until this time has passed).
If set to -1, it will always act as an enter key.
|
| VOLUME_UP_DTMF |
String |
"" |
A DTMF sequence (may be one or more characters) that will cause the Platform to increase the volume at which prompts are played
during the call. Prompts will continue to play when this sequence is entered. Use a value of an empty string to disable this feature. |
| VOLUME_DOWN_DTMF |
String |
"" |
A DTMF sequence (may be one or more characters) that will cause the Platform to decrease the volume at which prompts are played during
the call. Prompts will continue to play when this sequence is entered. Use a value of an empty string to disable this feature. |
| FAST_FORWARD_DTMF |
String |
"" |
A DTMF sequence that will make the Platform fast forward a prompt by the amount specified in FAST_FORWARD_TIME. |
| FAST_FORWARD_TIME |
Integer |
4000 |
The amount of time, in milliseconds, that the Platform should fast forward if the FAST_FORWARD_DTMF sequence is entered. |
| REWIND_DTMF |
String |
"" |
A DTMF sequence that will make the Platform rewind a prompt by the amount specified in REWIND_TIME. |
| REWIND_TIME |
Integer |
4000 |
The amount of time, in milliseconds, that the Platform should rewindif the REWIND_DTMF sequence is entered. |
| CLEAR_DIGIT_BUFFER |
Integer |
0 |
Controls whether the system should discard any queued digits when the interaction begins. If set to 1, the system will discard
queued DTMF digits. If set to 0, it will process them (if there are digits, the prompt will not be played). |
Digit Mask
Each time the system receives DTMF input from a user, the system checks the digits against the DTMF mask (DTMF_MATCH_MASK). If there is a match against
the mask, the DTMF string as received at that time is immediately returned.
The format of the mask consists of digits or ranges of digits, separated by commas. For example, the mask 1,2,33,5-9 is matched if the
user presses 1, 2, 5, 6, 7, 8, or 9. It would also be matched if the user entered 33. If a user just
enters 4, the mask will not be matched and thus the system will continue waiting for digits (until the inter-digit timeout is reached).
Ranges are based on characters, nut numbers, so 70-79 will not return if 079 is entered. To allow for that to return,
two ranges would need to be specified: 070-079,70-79.
The order of the items in the mask does not matter, and each item is compared independently to the DTMF digits entered to check for a match. The star
and pound key can be entered in the mask, but not as part of a range.
This can be particularly useful in systems where 0 entered by itself should immediately return so that a user can be transferred to
an operator. If a prompt requires a user to enter a five digit code, the mask 0,00000-99999 would allow for 0 entered
as the first digit to return immediately, but it could be still used as part of the longer code (so long as the code did not start with 0).