DTMF Receive Component

:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:

Description

Waits for the subscriber to enter DTMF characters from the telephone keyboard. Supports delivery of characters via RFC-2833 and via SIP-INFO.

Table 1. System characteristics

Index

206

Short name

dtmf

Script types

IVR

Start module

r_sip_ivr_script_component_dtmf

Mode

Asynchronous

Icon

206

Branching type

Branching, closing

Properties

Table 2. Properties
Specification Description

Name: Inband detector

Code: inband

Visibility condition: no

Default: disable

Inband dtmf detector operating mode.

Possible values:

  • Disable (disable, 0) - DTif it was previously enabled.

  • Enable (enable, 1).

  • Turn on and off (turn, 2).

Features of Inband-DTMF detector:

  • Consumes additional computing resources - both for detection itself and for turning it on and off, which can lead to a decrease in overall performance in loaded systems.

*Creates a risk of duplication of signals transmitted simultaneously in audio and in another protocol. * If there are several DTMF analysis components in the scenario, then it is optimal to turn it on in the first component and not turn it off until the end.

  • If you need to catch Inband-DTMF in other components, for example interrupting playback, then you should execute the DTMF Input component with a zero timeout and enable Inband mode.

Unless absolutely necessary, you should not activate the Inband-DTMF mode.

Name: Timeout, s

Code: timeoutSec

Visibility condition: no Default: — 

General timeout waiting for the full value to be entered.

Name: Intercharacter timeout, s

Code: symbolTimeoutSec

Visibility condition: no

Default: — 

Timeout for waiting for the next character to be entered, starting from the first, in seconds.

Name: Buffer for DTMF Code: dtmfBuffer Visibility condition: no

Default: — 

Variable for storing received DTMF characters.

Name: Clear DTMF buffer

Code: clearDtmfBuffer

Visibility condition: yes

Default: Yes

DTMF buffer pre-clear switch.

Name: Number of characters

Code: maxSymbolCount

Visibility condition: no

Default: — 

An argument containing a limit on the number of characters entered.

After receiving the specified number of DTMF characters during the execution of a component, the recording is automatically completed and the last portion of voice data is sent to the recognition service.

Name: Interrupt characters Code: interruptSymbols Visibility condition: no

Default: — 

A string containing sequences of break characters separated by commas.

After detecting a character sequence at the end of the DTMF buffer that matches one of the specified interrupt sequences, the recording is automatically completed and the last portion of data is sent to the recognition service.

For example, *, 7, 123, 9395.

Name: Cut interrupt characters Code: clearInterrupt Visibility condition: yes

Default: Yes

Switch for the operation of removing interrupt characters from the DTMF buffer after detecting an interrupt sequence.

Name: Transition

Code: transfer

Visibility condition: no

Default: — 

The component to which control is transferred upon completion of the operation of typing the required number of characters.

Name: Transition, time

Code: transferTimeout

Visibility condition: no

Default: — 

The component to which control is transferred upon completion due to a timeout.

See also