<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2172/18/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_Read">Asterisk 11 Application_Read</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~wikibot">Wiki Bot</a>
</h4>
<br/>
<div class="notificationGreySide">
<h1><a name="Asterisk11Application_Read-Read%28%29"></a>Read()</h1>
<h3><a name="Asterisk11Application_Read-Synopsis"></a>Synopsis</h3>
<p>Read a variable.</p>
<h3><a name="Asterisk11Application_Read-Description"></a>Description</h3>
<p>Reads a #-terminated string of digits a certain number of times from the user in to the given <em>variable</em>.</p>
<p>This application sets the following channel variable upon completion:</p>
<ul>
<li>READSTATUS - This is the status of the read operation.
<ul>
<li>OK</li>
<li>ERROR</li>
<li>HANGUP</li>
<li>INTERRUPTED</li>
<li>SKIPPED</li>
<li>TIMEOUT</li>
</ul>
</li>
</ul>
<h3><a name="Asterisk11Application_Read-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Read(variablefilename&filename2[&...],maxdigits,options,attempts,timeout)</pre>
</div></div>
<h5><a name="Asterisk11Application_Read-Arguments"></a>Arguments</h5>
<ul>
<li>variable - The input digits will be stored in the given <em>variable</em> name.</li>
<li>filenames
<ul>
<li>filename - file(s) to play before reading digits or tone with option i</li>
<li>filename2</li>
</ul>
</li>
<li>maxdigits - Maximum acceptable number of digits. Stops reading after <em>maxdigits</em> have been entered (without requiring the user to press the <tt>#</tt> key).Defaults to <tt>0</tt> - no limit - wait for the user press the <tt>#</tt> key. Any value below <tt>0</tt> means the same. Max accepted value is <tt>255</tt>.</li>
<li>options
<ul>
<li>s - to return immediately if the line is not up.</li>
<li>i - to play filename as an indication tone from your <tt>indications.conf</tt>.</li>
<li>n - to read digits even if the line is not up.</li>
</ul>
</li>
<li>attempts - If greater than <tt>1</tt>, that many <em>attempts</em> will be made in the event no data is entered.</li>
<li>timeout - The number of seconds to wait for a digit response. If greater than <tt>0</tt>, that value will override the default timeout. Can be floating point.</li>
</ul>
<h3><a name="Asterisk11Application_Read-SeeAlso"></a>See Also</h3>
<ul>
<li><a href="/wiki/pages/createpage.action?spaceKey=AST&title=Asterisk+11+Application_SendDTMF&linkCreation=true&fromPageId=20187083" class="createlink">Asterisk 11 Application_SendDTMF</a></li>
</ul>
<h3><a name="Asterisk11Application_Read-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk Version SVN-trunk-r370322</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_Read">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_Read?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>