ReadExten()

Since 1.6.0 Applications

Read an extension into a variable.

Last reviewed 2026-04-14

ReadExten(variable[,filename,context,option,timeout])

Dialplan Builder -- build your ReadExten() command

variable

filename (optional)

File to play before reading digits or tone with option `i`

context (optional)

Context in which to match extensions.

options

i: Play filename as an indication tone from your *indications.

Play *filename* as an indication tone from your `indications.conf` or a directly specified list of frequencies and durations.

n: Read digits even if the channel is not answered.

Read digits even if the channel is not answered.

p: The extension entered will be considered complete when a '#' is entered.

The extension entered will be considered complete when a `#` is entered.

s: Return immediately if the channel is not answered.

Return immediately if the channel is not answered.

timeout (optional)

An integer number of seconds to wait for a digit response. If greater than `0`, that value will override the default timeout.

Full arguments reference

variable required
filename - File to play before reading digits or tone with option i
context - Context in which to match extensions.
option
- s - Return immediately if the channel is not answered.
- i - Play filename as an indication tone from your indications.conf or a directly specified list of frequencies and durations.
- n - Read digits even if the channel is not answered.
- p - The extension entered will be considered complete when a # is entered.
timeout - An integer number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout.

Description

Reads a # terminated string of digits from the user into the given variable.

Will set READEXTENSTATUS on exit with one of the following statuses:

READEXTENSTATUS
- OK - A valid extension exists in ${variable}.
- TIMEOUT - No extension was entered in the specified time. Also sets ${variable} to "t".
- INVALID - An invalid extension, ${INVALID_EXTEN}, was entered. Also sets ${variable} to "i".
- SKIP - Line was not up and the option 's' was specified.
- ERROR - Invalid arguments were passed.

Arguments

variable required
filename - File to play before reading digits or tone with option i
context - Context in which to match extensions.
option
- s - Return immediately if the channel is not answered.
- i - Play filename as an indication tone from your indications.conf or a directly specified list of frequencies and durations.
- n - Read digits even if the channel is not answered.
- p - The extension entered will be considered complete when a # is entered.
timeout - An integer number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout.

User Notes

Know a tip or gotcha for this topic? Share it below and help others.

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.