Call Us Today! 877.742.2583




Page tree
Skip to end of metadata
Go to start of metadata

playback_terminators

dtmf digit

0. About

Allows you to set which DTMF tones will terminate

The default terminator is * (star).

1. Syntax

Syntax
playback_terminators=123456789*0# | any | none
  • none - undefines the terminator digit, meaning no DTMF tone will interrupt playback
  • any - any DTMF will interrupt playback

Digits not specified as terminators will be collected, but won't interrupt playback.

2. Modifiers

  • + (plus) - includes the following terminator digit along with the other DTMF digits in the returned string
  • x (letter ex) - includes the following terminator digit in the returned string and also returns SWITCH_STATUS_RESTART

See last example below on what these modifiers do.

TODO Add use cases.

3. Examples

Make either * (star) or # (bar/pound/square) interrupt the subsequent playback, tone_stream, say, recording, etc. operation:

<action application="set" data="playback_terminators=#*"/>

If DTMF 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if * is dialed it will only interrupt playback without being included in the DTMF string returned:

<action application="set" data="playback_terminators=*+9"/>