dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Application_Read</title>
        <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    </head>

    <body class="theme-default aui-theme-default">
        <div id="page">
            <div id="main" class="aui-page-panel">
                <div id="main-header">
                    <div id="breadcrumb-section">
                        <ol id="breadcrumbs">
                            <li class="first">
                                <span><a href="index.html">Asterisk Project</a></span>
                            </li>
                                                    <li>
                                <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
                            </li>
                                                    <li>
                                <span><a href="Asterisk-13-Dialplan-Applications_29394285.html">Asterisk 13 Dialplan Applications</a></span>
                            </li>
                                                </ol>
                    </div>
                    <h1 id="title-heading" class="pagetitle">
                                                <span id="title-text">
                            Asterisk Project : Asterisk 13 Application_Read
                        </span>
                    </h1>
                </div>

                <div id="content" class="view">
                    <div class="page-metadata">
                        
        
            Created by <span class='author'> wikibot</span> on Aug 08, 2014
                        </div>
                    <div id="main-content" class="wiki-content group">
                    <h1 id="Asterisk13Application_Read-Read()">Read()</h1>

<h3 id="Asterisk13Application_Read-Synopsis">Synopsis</h3>

<p>Read a variable.</p>

<h3 id="Asterisk13Application_Read-Description">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><code>READSTATUS</code> - 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 id="Asterisk13Application_Read-Syntax">Syntax</h3>


<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Read(variable,filename&amp;[filename2[&amp;...]],[maxdigits,[options,[attempts,[timeout]]]]])</pre>
</div></div>

<h5 id="Asterisk13Application_Read-Arguments">Arguments</h5>

<ul>
	<li><code>variable</code> - The input digits will be stored in the given <em>variable</em> name.</li>
	<li><code>filenames</code>
	<ul>
		<li><code>filename</code> - file(s) to play before reading digits or tone with option i</li>
		<li><code>filename2</code></li>
	</ul>
	</li>
	<li><code>maxdigits</code> - Maximum acceptable number of digits. Stops reading after <em>maxdigits</em> have been entered (without requiring the user to press the <code>#</code> key).<br />
Defaults to <code>0</code> - no limit - wait for the user press the <code>#</code> key. Any value below <code>0</code> means the same. Max accepted value is <code>255</code>.</li>
	<li><code>options</code>
	<ul>
		<li><code>s</code> - to return immediately if the line is not up.</li>
		<li><code>i</code> - to play filename as an indication tone from your <code>indications.conf</code>.</li>
		<li><code>n</code> - to read digits even if the line is not up.</li>
	</ul>
	</li>
	<li><code>attempts</code> - If greater than <code>1</code>, that many <em>attempts</em> will be made in the event no data is entered.</li>
	<li><code>timeout</code> - The number of seconds to wait for a digit response. If greater than <code>0</code>, that value will override the default timeout. Can be floating point.</li>
</ul>


<h3 id="Asterisk13Application_Read-SeeAlso">See Also</h3>

<ul>
	<li><a href="Asterisk-13-Application_SendDTMF_29394546.html">Asterisk 13 Application_SendDTMF</a></li>
</ul>


<h3 id="Asterisk13Application_Read-ImportVersion">Import Version</h3>

<p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
                    </div>

                    
                </div>             </div> 
            <div id="footer">
                <section class="footer-body">
                    <p>Document generated by Confluence on Aug 11, 2014 13:45</p>
                </section>
            </div>
        </div>     </body>
</html>