dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 ManagerEvent_FAXSession</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-AMI-Events_29394281.html">Asterisk 13 AMI Events</a></span>
                            </li>
                                                </ol>
                    </div>
                    <h1 id="title-heading" class="pagetitle">
                                                <span id="title-text">
                            Asterisk Project : Asterisk 13 ManagerEvent_FAXSession
                        </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="Asterisk13ManagerEvent_FAXSession-FAXSession">FAXSession</h1>

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

<p>Raised in response to FAXSession manager command</p>

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

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


<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Event: FAXSession
[ActionID:] &lt;value&gt;
SessionNumber: &lt;value&gt;
Operation: &lt;value&gt;
State: &lt;value&gt;
[ErrorCorrectionMode:] &lt;value&gt;
[DataRate:] &lt;value&gt;
[ImageResolution:] &lt;value&gt;
[PageNumber:] &lt;value&gt;
[FileName:] &lt;value&gt;
[PagesTransmitted:] &lt;value&gt;
[PagesReceived:] &lt;value&gt;
[TotalBadLines:] &lt;value&gt;
</pre>
</div></div>

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

<ul>
	<li><code>ActionID</code></li>
	<li><code>SessionNumber</code> - The numerical identifier for this particular session</li>
	<li><code>Operation</code> - FAX session operation type
	<ul>
		<li><code>gateway</code></li>
		<li><code>V.21</code></li>
		<li><code>send</code></li>
		<li><code>receive</code></li>
		<li><code>none</code></li>
	</ul>
	</li>
	<li><code>State</code> - Current state of the FAX session
	<ul>
		<li><code>Uninitialized</code></li>
		<li><code>Initialized</code></li>
		<li><code>Open</code></li>
		<li><code>Active</code></li>
		<li><code>Complete</code></li>
		<li><code>Reserved</code></li>
		<li><code>Inactive</code></li>
		<li><code>Unknown</code></li>
	</ul>
	</li>
	<li><code>ErrorCorrectionMode</code> - Whether error correcting mode is enabled for the FAX session. This field is not included when operation is 'V.21 Detect' or if operation is 'gateway' and state is 'Uninitialized'
	<ul>
		<li><code>yes</code></li>
		<li><code>no</code></li>
	</ul>
	</li>
	<li><code>DataRate</code> - Bit rate of the FAX. This field is not included when operation is 'V.21 Detect' or if operation is 'gateway' and state is 'Uninitialized'.</li>
	<li><code>ImageResolution</code> - Resolution of each page of the FAX. Will be in the format of X_RESxY_RES. This field is not included if the operation is anything other than Receive/Transmit.</li>
	<li><code>PageNumber</code> - Current number of pages transferred during this FAX session. May change as the FAX progresses. This field is not included when operation is 'V.21 Detect' or if operation is 'gateway' and state is 'Uninitialized'.</li>
	<li><code>FileName</code> - Filename of the image being sent/recieved for this FAX session. This field is not included if Operation isn't 'send' or 'receive'.</li>
	<li><code>PagesTransmitted</code> - Total number of pages sent during this session. This field is not included if Operation isn't 'send' or 'receive'. Will always be 0 for 'receive'.</li>
	<li><code>PagesReceived</code> - Total number of pages received during this session. This field is not included if Operation is not 'send' or 'receive'. Will be 0 for 'send'.</li>
	<li><code>TotalBadLines</code> - Total number of bad lines sent/recieved during this session. This field is not included if Operation is not 'send' or 'received'.</li>
</ul>


<h3 id="Asterisk13ManagerEvent_FAXSession-Class">Class</h3>

<p>REPORTING</p>
<h3 id="Asterisk13ManagerEvent_FAXSession-SeeAlso">See Also</h3>

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