<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/25/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/Some+Standard+AMI+Headers">Some Standard AMI Headers</a></h2>
<h4>Page <b>edited</b> by <a href="https://wiki.asterisk.org/wiki/display/~mdavenport">Malcolm Davenport</a>
</h4>
<br/>
<h4>Changes (1)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >{note} <br> <br></td></tr>
<tr><td class="diff-changed-lines" >Read <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">the CODING-GUIDELINES</span> <span class="diff-added-words"style="background-color: #dfd;">[AST:Coding Guidelines]</span> if you develop new manager commands or events. <br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<ul>
<li>Account: – Account Code (Status)</li>
<li>AccountCode: – Account Code (cdr_manager)</li>
<li>ACL: <Y | N> – Does ACL exist for object ?</li>
<li>Action: <action> – Request or notification of a particular action</li>
<li>Address-IP: – IPaddress</li>
<li>Address-Port: – IP port number</li>
<li>Agent: <string> – Agent name</li>
<li>AMAflags: – AMA flag (cdr_manager, sippeers)</li>
<li>AnswerTime: – Time of answer (cdr_manager)</li>
<li>Append: <bool> – CDR userfield Append flag</li>
<li>Application: – Application to use</li>
<li>Async: – Whether or not to use fast setup</li>
<li>AuthType: – Authentication type (for login or challenge) "md5"</li>
<li>BillableSeconds: – Billable seconds for call (cdr_manager)</li>
<li>CallerID: – Caller id (name and number in Originate & cdr_manager)</li>
<li>CallerID: – CallerID number Number or "<unknown>" or "unknown" (should change to "<unknown>" in app_queue)</li>
<li>CallerID1: – Channel 1 CallerID (Link event)</li>
<li>CallerID2: – Channel 2 CallerID (Link event)</li>
<li>CallerIDName: – CallerID name Name or "<unknown>" or "unknown" (should change to "<unknown>" in app_queue)</li>
<li>Callgroup: – Call group for peer/user</li>
<li>CallsTaken: <num> – Queue status variable</li>
<li>Cause: <value> – Event change cause - "Expired"</li>
<li>Cause: <value> – Hangupcause (channel.c)</li>
<li>CID-CallingPres: – Caller ID calling presentation</li>
<li>Channel: <channel> – Channel specifier</li>
<li>Channel: <dialstring> – Dialstring in Originate</li>
<li>Channel: <tech/[peer/username]> – Channel in Registry events (SIP, IAX2)</li>
<li>Channel: <tech> – Technology (SIP/IAX2 etc) in Registry events</li>
<li>ChannelType: – Tech: SIP, IAX2, DAHDI, MGCP etc</li>
<li>Channel1: – Link channel 1</li>
<li>Channel2: – Link channel 2</li>
<li>ChanObjectType: – "peer", "user"</li>
<li>Codecs: – Codec list</li>
<li>CodecOrder: – Codec order, separated with comma ","</li>
<li>Command: – Cli command to run</li>
<li>Context: – Context</li>
<li>Count: <num> – Number of callers in queue</li>
<li>Data: – Application data</li>
<li>Default-addr-IP: – IP address to use before registration</li>
<li>Default-Username: – Username part of URI to use before registration</li>
<li>Destination: – Destination for call (Dialstring ) (dial, cdr_manager)</li>
<li>DestinationContext: – Destination context (cdr_manager)</li>
<li>DestinationChannel: – Destination channel (cdr_manager)</li>
<li>DestUniqueID: – UniqueID of destination (dial event)</li>
<li>Direction: <type> – Audio to mute (read | write | both)</li>
<li>Disposition: – Call disposition (CDR manager)</li>
<li>Domain: <domain> – DNS domain</li>
<li>Duration: <secs> – Duration of call (cdr_manager)</li>
<li>Dynamic: <Y | N> – Device registration supported?</li>
<li>Endtime: – End time stamp of call (cdr_manager)</li>
<li>EventList: <flag> – Flag being "Start", "End", "Cancelled" or "ListObject"</li>
<li>Events: <eventmask> – Eventmask filter ("on", "off", "system", "call", "log")</li>
<li>Exten: – Extension (Redirect command)</li>
<li>Extension: – Extension (Status)</li>
<li>Family: <string> – ASTdb key family</li>
<li>File: <filename> – Filename (monitor)</li>
<li>Format: <format> – Format of sound file (monitor)</li>
<li>From: <time> – Parking time (ParkedCall event)</li>
<li>Hint: – Extension hint</li>
<li>Incominglimit: – SIP Peer incoming limit</li>
<li>Key: Key: – ASTdb Database key</li>
<li>LastApplication: – Last application executed (cdr_manager)</li>
<li>LastCall: <num> – Last call in queue</li>
<li>LastData: – Data for last application (cdr_manager)</li>
<li>Link: – (Status)</li>
<li>ListItems: <number> – Number of items in Eventlist (Optionally sent in "end" packet)</li>
<li>Location: – Interface (whatever that is -maybe tech/name in app_queue )</li>
<li>Loginchan: – Login channel for agent</li>
<li>Logintime: <number> – Login time for agent</li>
<li>Mailbox: – VM Mailbox (id@vmcontext) (mailboxstatus, mailboxcount)</li>
<li>MD5SecretExist: <Y | N> – Whether secret exists in MD5 format</li>
<li>Membership: <string> – "Dynamic" or "static" member in queue</li>
<li>Message: <text> – Text message in ACKs, errors (explanation)</li>
<li>Mix: <bool> – Boolean parameter (monitor)</li>
<li>MOHSuggest: – Suggested music on hold class for peer (mohsuggest)</li>
<li>NewMessages: <count> – Count of new Mailbox messages (mailboxcount)</li>
<li>Newname:</li>
<li>ObjectName: – Name of object in list</li>
<li>OldName: – Something in Rename (channel.c)</li>
<li>OldMessages: <count> – Count of old mailbox messages (mailboxcount)</li>
<li>Outgoinglimit: – SIP Peer outgoing limit</li>
<li>Paused: <num> – Queue member paused status</li>
<li>Peer: <tech/name> – "channel" specifier</li>
<li>PeerStatus: <tech/name> – Peer status code "Unregistered", "Registered", "Lagged", "Reachable"</li>
<li>Penalty: <num> – Queue penalty</li>
<li>Priority: – Extension priority</li>
<li>Privilege: <privilege> – AMI authorization class (system, call, log, verbose, command, agent, user)</li>
<li>Pickupgroup: – Pickup group for peer</li>
<li>Position: <num> – Position in Queue</li>
<li>Queue: – Queue name</li>
<li>Reason: – "Autologoff"</li>
<li>Reason: – "Chanunavail"</li>
<li>Response: <response> – response code, like "200 OK" "Success", "Error", "Follows"</li>
<li>Restart: – "True", "False"</li>
<li>RegExpire: – SIP registry expire</li>
<li>RegExpiry: – SIP registry expiry</li>
<li>Reason: – Originate reason code</li>
<li>Seconds: – Seconds (Status)</li>
<li>Secret: <password> – Authentication secret (for login)</li>
<li>SecretExist: <Y | N> – Whether secret exists</li>
<li>Shutdown: – "Uncleanly", "Cleanly"</li>
<li>SIP-AuthInsecure:</li>
<li>SIP-FromDomain: – Peer FromDomain</li>
<li>SIP-FromUser: – Peer FromUser</li>
<li>SIP-NatSupport:</li>
<li>SIPLastMsg:</li>
<li>Source: – Source of call (dial event, cdr_manager)</li>
<li>SrcUniqueID: – UniqueID of source (dial event)</li>
<li>StartTime: – Start time of call (cdr_manager)</li>
<li>State: – Channel state</li>
<li>State: <1 | 0> – Mute flag</li>
<li>Status: – Registration status (Registry events SIP)</li>
<li>Status: – Extension status (Extensionstate)</li>
<li>Status: – Peer status (if monitored) ** Will change name ** "unknown", "lagged", "ok"</li>
<li>Status: <num> – Queue Status</li>
<li>Status: – DND status (DNDState)</li>
<li>Time: <sec> – Roundtrip time (latency)</li>
<li>Timeout: – Parking timeout time</li>
<li>Timeout: – Timeout for call setup (Originate)</li>
<li>Timeout: <seconds> – Timeout for call</li>
<li>Uniqueid: – Channel Unique ID</li>
<li>Uniqueid1: – Channel 1 Unique ID (Link event)</li>
<li>Uniqueid2: – Channel 2 Unique ID (Link event)</li>
<li>User: – Username (SIP registry)</li>
<li>UserField: – CDR userfield (cdr_manager)</li>
<li>Val: – Value to set/read in ASTdb</li>
<li>Variable: – Variable AND value to set (multiple separated with | in Originate)</li>
<li>Variable: <name> – For channel variables</li>
<li>Value: <value> – Value to set</li>
<li>VoiceMailbox: – VM Mailbox in SIPpeers</li>
<li>Waiting: – Count of mailbox messages (mailboxstatus)</li>
</ul>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/wiki/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Please try to re-use existing headers to simplify manager message parsing in clients.*</td></tr></table></div>
<p>Read <a href="/wiki/display/AST/Coding+Guidelines" title="Coding Guidelines">Coding Guidelines</a> if you develop new manager commands or events.</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/Some+Standard+AMI+Headers">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/pages/diffpagesbyversion.action?pageId=4817253&revisedVersion=3&originalVersion=2">View Changes</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Some+Standard+AMI+Headers?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>