dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Function_FAXOPT_res_fax</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-Functions_29394287.html">Asterisk 13 Dialplan Functions</a></span>
                            </li>
                                                </ol>
                    </div>
                    <h1 id="title-heading" class="pagetitle">
                                                <span id="title-text">
                            Asterisk Project : Asterisk 13 Function_FAXOPT_res_fax
                        </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="Asterisk13Function_FAXOPT_res_fax-FAXOPT()-[res_fax]">FAXOPT() - [res_fax]</h1>

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

<p>Gets/sets various pieces of information about a fax session.</p>

<h3 id="Asterisk13Function_FAXOPT_res_fax-Description">Description</h3>

<p>FAXOPT can be used to override the settings for a FAX session listed in <code>res_fax.conf</code>, it can also be used to retreive information about a FAX session that has finished eg. pages/status.</p>


<h3 id="Asterisk13Function_FAXOPT_res_fax-Syntax">Syntax</h3>


<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>FAXOPT(item)</pre>
</div></div>

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

<ul>
	<li><code>item</code>
	<ul>
		<li><code>ecm</code> - R/W Error Correction Mode (ECM) enable with 'yes', disable with 'no'.</li>
		<li><code>error</code> - R/O FAX transmission error code upon failure.</li>
		<li><code>filename</code> - R/O Filename of the first file of the FAX transmission.</li>
		<li><code>filenames</code> - R/O Filenames of all of the files in the FAX transmission (comma separated).</li>
		<li><code>headerinfo</code> - R/W FAX header information.</li>
		<li><code>localstationid</code> - R/W Local Station Identification.</li>
		<li><code>minrate</code> - R/W Minimum transfer rate set before transmission.</li>
		<li><code>maxrate</code> - R/W Maximum transfer rate set before transmission.</li>
		<li><code>modem</code> - R/W Modem type (v17/v27/v29).</li>
		<li><code>gateway</code> - R/W T38 fax gateway, with optional fax activity timeout in seconds (yes[,timeout]/no)</li>
		<li><code>faxdetect</code> - R/W Enable FAX detect with optional timeout in seconds (yes,t38,cng[,timeout]/no)</li>
		<li><code>pages</code> - R/O Number of pages transferred.</li>
		<li><code>rate</code> - R/O Negotiated transmission rate.</li>
		<li><code>remotestationid</code> - R/O Remote Station Identification after transmission.</li>
		<li><code>resolution</code> - R/O Negotiated image resolution after transmission.</li>
		<li><code>sessionid</code> - R/O Session ID of the FAX transmission.</li>
		<li><code>status</code> - R/O Result Status of the FAX transmission.</li>
		<li><code>statusstr</code> - R/O Verbose Result Status of the FAX transmission.</li>
	</ul>
	</li>
</ul>


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

<ul>
	<li><a class="createlink" href="/wiki/pages/createpage.action?spaceKey=AST&amp;title=Asterisk+13+Application_ReceiveFax&amp;linkCreation=true&amp;fromPageId=29394867">Asterisk 13 Application_ReceiveFax</a></li>
	<li><a class="createlink" href="/wiki/pages/createpage.action?spaceKey=AST&amp;title=Asterisk+13+Application_SendFax&amp;linkCreation=true&amp;fromPageId=29394867">Asterisk 13 Application_SendFax</a></li>
</ul>


<h3 id="Asterisk13Function_FAXOPT_res_fax-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:46</p>
                </section>
            </div>
        </div>     </body>
</html>