Extended Get Key Async

This Telephony tool works much like the Extended Get Key tool, except that it will not pause the handler to wait for the digits to be received. This tool will also recognize a fax tone. Once this tool exits, no further processing will be done on the call by the handler. When the requested keys are received, the Get Digits Ex Async initiator will launch a separate handler to continue call processing.

Inputs

Call Identifier

The unique identifier for the call.

Valid Keys

0,1,2,3,4,5,6,7,8,9 are the keys a caller may enter. You can change these keys using the Expression Editor Assistant.

Escape Keys

"*" is the escape key. When a caller presses the escape key, this step stops accepting caller input and takes the Escape exit path. Change these keys using the Expression Editor Assistant.

Termination Keys

"#" is the termination key for this step. This step immediately stops waiting for key input when this key is pressed and exits through the Success exit path. If the caller presses the termination key before entering any other keys, this tool takes the Success exit path and the Digits output variable is empty.

Maximum Number of Keys

The maximum number of keys this step accepts before taking the Successful exit path.

Maximum Inter-Digit Delay (seconds)

The number of seconds to allow between key presses before this step takes the Success exit path. The default is 2.5 seconds. The Inter-Digit delay is not counted until the caller presses the first key. If the inter-digit delay expires, the Get Digits Ex Async initiator will then launch with a Termination Code of Success.

Note for the following Tone Detection parameters: The default values for the next 8 settings recognize a standard fax tone. In almost all cases, you do not need to change the default settings. If you want to detect a tone other than a fax device, refer to the documentation for the device generating the tone. Also see the topic on Tones.

Tone Detection Frequency 1 in Hertz (0:disable)

1100 To disable Fax tone detection, set this to 0.

Permissible deviation in Tone Detection Frequency 1 (Hz)

50

Tone Detection Frequency 2 in Hertz (0:disable)

0

Permissible deviation in Tone Detection Frequency 2 (Hz)

50

Timeout (seconds)

The total number of seconds to wait for any input after audio is played before the get key operation terminates. The Get Digits Ex Async initiator will then launch with a Termination Code of Timeout. The default for this parameter is 20 seconds.

Attribute to monitor as a termination event

This optional parameter specifies the name of an attribute to be monitored during the operation of this tool. If the value of this attribute changes during the Extended Get Key operation, the Get Digits Ex Async initiator will launch with a Termination Code of Attribute Changed.

Correlation ID

Specifies which handler this tool is in. The Get Digits Ex Async initiator will use this information to resume processing once get digits operation ends.

No Response Timeout (seconds)

The number of seconds to wait for any response before the get key operation terminates. The Get Digits Ex Async initiator will then launch with a Termination Code of No Response. The default for this parameter is 20 seconds.

Interaction ID for the attribute monitor

This optional parameter specifies the interaction ID associated with the attribute to monitor.

Exit Paths

Next

This tool always takes the Next exit path.