Configurable Barge-In for Play Files

This feature allows a single call session to have multiple announcements that can perform differently when subscribers press digits. This functionality increases the flexibility for application development.

This feature does not apply to conferences or child conferences.

API Call Control Messages

The following messages support this feature:

Play File Start (0x011B)

DSP Service Request (0x00BD)

Description

During a single call session, an Interactive Voice Response Service (IVRS) calls various announcements during the call flow. A single call session has some announcements that will terminate when the subscriber presses digits and other announcement that will not terminate when the subscriber presses digits.

Because each announcement can act differently during a single call session, this behavior is not controlled by the DSP Service Request message with service type 0xE1 (DTMF Receiver with Termination of Tone/Announcement).

Instead, the Play File Start (0x011B) message is used with the DSP Service Request (0x00BD) message to control the barge-in behavior for play file to channel.

Enabling this Feature

The Play Continue on Digit Detection (0x0751) TLV supports this feature. Refer to TLV chapter in the API Reference.

The Play File Start message for playing to a channel includes the Play Continue on Digit Detection (0x0751) TLV set to 1 (Continue play on digit detection). In addition, attach the DTMF receiver using the service type 0xE1. Even if the digits are detected, the play file is not cancelled.

If you do not want to enable this feature, set the Play Continue on Digit Detection TLV to 0 (Cancel on digit detection). Attach a DTMF receiver using service type 0xE1. The play file is cancelled when digits are detected.