dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Application_AgentLogin</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_AgentLogin
                        </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_AgentLogin-AgentLogin()">AgentLogin()</h1>

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

<p>Login an agent.</p>

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

<p>Login an agent to the system. Any agent authentication is assumed to already be done by dialplan. While logged in, the agent can receive calls and will hear the sound file specified by the config option custom_beep when a new call comes in for the agent. Login failures will continue in the dialplan with <code>AGENT_STATUS</code> set.</p>

<p>Before logging in, you can setup on the real agent channel the CHANNEL(dtmf-features) an agent will have when talking to a caller and you can setup on the channel running this application the CONNECTEDLINE() information the agent will see while waiting for a caller.</p>

<p>AGENT_STATUS enumeration values:</p>

<ul>
	<li><code>INVALID</code> - The specified agent is invalid.</li>
	<li><code>ALREADY_LOGGED_IN</code> - The agent is already logged in.
    <div class="aui-message hint shadowed information-macro">
                    <p class="title">Note</p>
                            <span class="aui-icon icon-hint">Icon</span>
                <div class="message-content">
                            
<p>The Agents:<em>AgentId</em> device state is available to monitor the status of the agent.</p>

                    </div>
    </div>
</li>
</ul>


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


<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>AgentLogin(AgentId,[options])</pre>
</div></div>

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

<ul>
	<li><code>AgentId</code></li>
	<li><code>options</code>
	<ul>
		<li><code>s</code> - silent login - do not announce the login ok segment after agent logged on.</li>
	</ul>
	</li>
</ul>


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

<ul>
	<li><a href="Asterisk-13-Application_Authenticate_29394377.html">Asterisk 13 Application_Authenticate</a></li>
	<li><a href="Asterisk-13-Application_Queue_29394417.html">Asterisk 13 Application_Queue</a></li>
	<li><a href="Asterisk-13-Application_AddQueueMember_29394418.html">Asterisk 13 Application_AddQueueMember</a></li>
	<li><a href="Asterisk-13-Application_RemoveQueueMember_29394419.html">Asterisk 13 Application_RemoveQueueMember</a></li>
	<li><a href="Asterisk-13-Application_PauseQueueMember_29394420.html">Asterisk 13 Application_PauseQueueMember</a></li>
	<li><a href="Asterisk-13-Application_UnpauseQueueMember_29394421.html">Asterisk 13 Application_UnpauseQueueMember</a></li>
	<li><a href="Asterisk-13-Function_AGENT_29394503.html">Asterisk 13 Function_AGENT</a></li>
	<li><a class="createlink" href="/wiki/pages/createpage.action?spaceKey=AST&amp;title=Asterisk+13+Function_CHANNEL%28dtmf-features%29&amp;linkCreation=true&amp;fromPageId=29394501">Asterisk 13 Function_CHANNEL(dtmf-features)</a></li>
	<li><a class="createlink" href="/wiki/pages/createpage.action?spaceKey=AST&amp;title=Asterisk+13+Function_CONNECTEDLINE%28%29&amp;linkCreation=true&amp;fromPageId=29394501">Asterisk 13 Function_CONNECTEDLINE()</a></li>
	<li><code>agents.conf</code></li>
	<li><code>queues.conf</code></li>
</ul>


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