Read()
Synopsis
Read a variable.
Description
Reads a #-terminated string of digits a certain number of times from the user in to the given variable.
This application sets the following channel variable upon completion:
READSTATUS
- This is the status of the read operation.- OK
- ERROR
- HANGUP
- INTERRUPTED
- SKIPPED
- TIMEOUT
Syntax
Read(variable,filename&[filename2[&...]],[maxdigits,[options,[attempts,[timeout]]]]])
Arguments
variable
- The input digits will be stored in the given variable name.filenames
filename
- file(s) to play before reading digits or tone with option ifilename2
[,filename2
...]
maxdigits
- Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the#
key).
Defaults to0
- no limit - wait for the user press the#
key. Any value below0
means the same. Max accepted value is255
.options
s
- to return immediately if the line is not up.i
- to play filename as an indication tone from yourindications.conf
.n
- to read digits even if the line is not up.t
- Terminator digit(s) to use for ending input. Default is#
. If you need to read the digit#
literally, you should remove or change the terminator character. Multiple terminator characters may be specified. If no terminator digit is present, input cannot be ended using digits and you will need to rely on duration and max digits for ending input.e
- to read the terminator as the digit string if the only digit read is the terminator. This is for cases where the terminator is a valid digit, but only by itself. ie;1234
and#
are valid, but1234#
is not.
attempts
- If greater than1
, that many attempts will be made in the event no data is entered.timeout
- The number of seconds to wait for a digit response. If greater than0
, that value will override the default timeout. Can be floating point.
See Also
Import Version
This documentation was imported from Asterisk Version GIT-20-200dc7d