ReceiveMF()

Since 16.24.0, 18.10.0 Applications

Detects MF digits on a channel and saves them to a variable.

Last reviewed 2026-04-14

ReceiveMF(variable[,timeout,options])

Dialplan Builder -- build your ReceiveMF() command

variable

The input digits will be stored in the given *variable* name.

timeout (optional)

The number of seconds to wait for all digits, if greater than `0`. Can be floating point. Default is no timeout.

options

d: Delay audio by a frame to try to extra quelch.

Delay audio by a frame to try to extra quelch.

k: Do not return a character for the KP digit.

Do not return a character for the KP digit.

l: Receive digits even if a key pulse (KP) has not yet been received.

Receive digits even if a key pulse (KP) has not yet been received. By default, this application will ignore all other digits until a KP has been received.

m: Mute conference.

Mute conference.

n: Maximum number of digits, regardless of the sequence.

Maximum number of digits, regardless of the sequence.

o: Enable override. Repeated KPs will clear all previous digits.

Enable override. Repeated KPs will clear all previous digits.

q: Quelch MF from in-band.

Quelch MF from in-band.

r: "Radio" mode (relaxed MF).

"Radio" mode (relaxed MF).

s: Do not return a character for ST digits.

Do not return a character for ST digits.

Full arguments reference

variable required - The input digits will be stored in the given variable name.
timeout - The number of seconds to wait for all digits, if greater than 0. Can be floating point. Default is no timeout.
options
- d - Delay audio by a frame to try to extra quelch.
- l - Receive digits even if a key pulse (KP) has not yet been received. By default, this application will ignore all other digits until a KP has been received.
- k - Do not return a character for the KP digit.
- m - Mute conference.
- n - Maximum number of digits, regardless of the sequence.
- o - Enable override. Repeated KPs will clear all previous digits.
- q - Quelch MF from in-band.
- r - "Radio" mode (relaxed MF).
- s - Do not return a character for ST digits.

Description

Reads a ST, STP, ST2P, or ST3P-terminated string of MF digits from the user in to the given variable.

This application does not automatically answer the channel and should be preceded with Answer or Progress as needed.

RECEIVEMFSTATUS - This is the status of the read operation.
- START
- ERROR
- HANGUP
- MAXDIGITS
- TIMEOUT

Arguments

variable required - The input digits will be stored in the given variable name.
timeout - The number of seconds to wait for all digits, if greater than 0. Can be floating point. Default is no timeout.
options
- d - Delay audio by a frame to try to extra quelch.
- l - Receive digits even if a key pulse (KP) has not yet been received. By default, this application will ignore all other digits until a KP has been received.
- k - Do not return a character for the KP digit.
- m - Mute conference.
- n - Maximum number of digits, regardless of the sequence.
- o - Enable override. Repeated KPs will clear all previous digits.
- q - Quelch MF from in-band.
- r - "Radio" mode (relaxed MF).
- s - Do not return a character for ST digits.

User Notes

No notes yet. Be the first to contribute a tip or example.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.