2016-10-05 06:38:17 +00:00
|
|
|
|
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AsterNET.Manager.Action Namespace</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="AsterNET.Manager.Action namespace" /><meta name="Microsoft.Help.F1" content="AsterNET.Manager.Action" /><meta name="Microsoft.Help.Id" content="N:AsterNET.Manager.Action" /><meta name="Description" content="AsterNet Manager Action" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Action" /><meta name="file" content="N_AsterNET_Manager_Action" /><meta name="guid" content="N_AsterNET_Manager_Action" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_Manager_Action.htm" title="AsterNET.Manager.Action" tocid="N_AsterNET_Manager_Action">AsterNET.Manager.Action</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_AbsoluteTimeoutAction.htm" title="AbsoluteTimeoutAction Class" tocid="T_AsterNET_Manager_Action_AbsoluteTimeoutAction">AbsoluteTimeoutAction Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_AgentCallbackLoginAction.htm" title="AgentCallbackLoginAction Class" tocid="T_AsterNET_Manager_Action_AgentCallbackLoginAction">AgentCallbackLoginAction Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_AgentLogoffAction.htm" title="AgentLogoffAction Class" tocid="T_AsterNET_Manager_Action_AgentLogoffAction">AgentLogoffAction Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_AgentsAction.htm" title="AgentsAction Class" tocid="T_AsterNET_Manager_Action_AgentsAction">AgentsAction Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_AgiAction.htm" title="AgiAction Class" tocid="T_AsterNET_Manager_Action_AgiAction">AgiAction Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a>
|
2016-10-03 09:15:07 +00:00
|
|
|
|
|
|
|
|
|
|
</th><th>Class</th><th>Description</th></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AbsoluteTimeoutAction.htm">AbsoluteTimeoutAction</a></td><td><div class="summary">
|
|
|
|
|
|
The AbsoluteTimeoutAction sets the absolute maximum amount of time permitted for a call on a given channel.<br />
|
|
|
|
|
|
Note that the timeout is set from the current time forward, not counting the number of seconds the call has already
|
|
|
|
|
|
been up.<br />
|
|
|
|
|
|
When setting a new timeout all previous absolute timeouts are cancelled.<br />
|
|
|
|
|
|
When the timeout is reached the call is returned to the T extension so that
|
|
|
|
|
|
you can playback an explanatory note to the calling party (the called party will not hear that).<br />
|
|
|
|
|
|
This action corresponds the the AbsoluteTimeout command used in the dialplan.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AgentCallbackLoginAction.htm">AgentCallbackLoginAction</a></td><td><div class="summary">
|
|
|
|
|
|
The AgentCallbackLoginAction sets an agent as logged in with callback.<br />
|
|
|
|
|
|
You can pass an extentsion (and optionally a context) to specify the
|
|
|
|
|
|
destination of the callback.<br />
|
|
|
|
|
|
In contrast to the AgentCallbackLogin application that you can use within
|
|
|
|
|
|
Asterisk's dialplan, you don't need to know the agent's password when logging
|
|
|
|
|
|
in an agent.<br />
|
|
|
|
|
|
Available since Asterisk 1.2
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AgentLogoffAction.htm">AgentLogoffAction</a></td><td><div class="summary">
|
|
|
|
|
|
The AgentLogoffAction sets an agent as no longer logged in.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AgentsAction.htm">AgentsAction</a></td><td><div class="summary">
|
|
|
|
|
|
The AgentsAction requests the state of all agents.<br />
|
|
|
|
|
|
For each agent an AgentsEvent is generated.
|
|
|
|
|
|
After the state of all agents has been reported an AgentsCompleteEvent is generated.<br />
|
|
|
|
|
|
Available since Asterisk 1.2
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AgiAction.htm">AgiAction</a></td><td><div class="summary">
|
|
|
|
|
|
This action lets you execute any AGI command through the Manager interface
|
|
|
|
|
|
For example, check the AsterNET.Test project
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AOCMessageAction.htm">AOCMessageAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_AtxferAction.htm">AtxferAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_BridgeAction.htm">BridgeAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ChallengeAction.htm">ChallengeAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ChallengeAction requests a challenge from the server to use when logging
|
|
|
|
|
|
in using challenge/response. Sending this action to the asterisk server
|
|
|
|
|
|
results in a ChallengeResponse being received from the server.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ChangeMonitorAction.htm">ChangeMonitorAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ChangeMonitorAction changes the monitoring filename of a channel.
|
|
|
|
|
|
It has no effect if the channel is not monitored.<br />
|
|
|
|
|
|
It is implemented in res/res_monitor.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_CommandAction.htm">CommandAction</a></td><td><div class="summary">
|
|
|
|
|
|
The CommandAction sends a command line interface (CLI) command to the asterisk server.<br />
|
|
|
|
|
|
For a list of supported commands type help on asterisk's command line.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeKickAction.htm">ConfbridgeKickAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeListAction.htm">ConfbridgeListAction</a></td><td><div class="summary">
|
|
|
|
|
|
Lists all users in a particular ConfBridge conference. ConfbridgeList will follow as separate events,
|
|
|
|
|
|
followed by a final event called ConfbridgeListComplete
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeListRoomsAction.htm">ConfbridgeListRoomsAction</a></td><td><div class="summary">
|
|
|
|
|
|
Lists data about all active conferences. ConfbridgeListRooms will follow as separate events,
|
|
|
|
|
|
followed by a final event called ConfbridgeListRoomsComplete.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeLockAction.htm">ConfbridgeLockAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeMuteAction.htm">ConfbridgeMuteAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeSetSingleVideoSrcAction.htm">ConfbridgeSetSingleVideoSrcAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeStartRecordAction.htm">ConfbridgeStartRecordAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeStopRecordAction.htm">ConfbridgeStopRecordAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeUnlockAction.htm">ConfbridgeUnlockAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ConfbridgeUnmuteAction.htm">ConfbridgeUnmuteAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_CoreSettingsAction.htm">CoreSettingsAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_CoreShowChannelsAction.htm">CoreShowChannelsAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_CoreStatusAction.htm">CoreStatusAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_CreateConfigAction.htm">CreateConfigAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_DBDelAction.htm">DBDelAction</a></td><td><div class="summary" /></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_DBDelTreeAction.htm">DBDelTreeAction</a></td><td><div class="summary" /></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_DBGetAction.htm">DBGetAction</a></td><td><div class="summary">
|
|
|
|
|
|
Retrieves an entry in the Asterisk database for a given family and key.<br />
|
|
|
|
|
|
If an entry is found a DBGetResponseEvent is sent by Asterisk containing the
|
|
|
|
|
|
value, otherwise a ManagerError indicates that no entry matches.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_DBPutAction.htm">DBPutAction</a></td><td><div class="summary">
|
|
|
|
|
|
Adds or updates an entry in the Asterisk database for a given family, key, and value.<br />
|
|
|
|
|
|
Available since Asterisk 1.2
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_EventsAction.htm">EventsAction</a></td><td><div class="summary">
|
|
|
|
|
|
With the EventsAction you can specify what kind of events should be sent to this manager connection.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ExtensionStateAction.htm">ExtensionStateAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ExtensionStateAction queries the state of an extension in a given context.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_GetConfigAction.htm">GetConfigAction</a></td><td><div class="summary">
|
|
|
|
|
|
The GetConfigAction sends a GetConfig command to the asterisk server.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_GetVarAction.htm">GetVarAction</a></td><td><div class="summary">
|
|
|
|
|
|
The GetVarAction queries for a channel variable.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_HangupAction.htm">HangupAction</a></td><td><div class="summary">
|
|
|
|
|
|
The HangupAction causes the pbx to hang up a given channel.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_LoginAction.htm">LoginAction</a></td><td><div class="summary">
|
|
|
|
|
|
The LoginAction authenticates the connection.<br />
|
|
|
|
|
|
A successful login is the precondition for sending any other action except
|
|
|
|
|
|
for the ChallengeAction.<br />
|
|
|
|
|
|
An unsuccessful login results in an ManagerError being received from the
|
|
|
|
|
|
server with a message set to "Authentication failed" and the socket being
|
|
|
|
|
|
closed by Asterisk.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_LogoffAction.htm">LogoffAction</a></td><td><div class="summary">
|
|
|
|
|
|
The LogoffAction causes the server to close the connection.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_MailboxCountAction.htm">MailboxCountAction</a></td><td><div class="summary">
|
|
|
|
|
|
The MailboxCountAction queries the number of unread and read messages in a mailbox.<br />
|
|
|
|
|
|
The MailboxCountAction returns a MailboxStatusResponse.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_MailboxStatusAction.htm">MailboxStatusAction</a></td><td><div class="summary">
|
|
|
|
|
|
The MailboxStatusAction checks if a mailbox contains waiting messages.<br />
|
|
|
|
|
|
The MailboxStatusAction returns a MailboxStatusResponse.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a></td><td><div class="summary">
|
|
|
|
|
|
This class implements the ManagerAction interface
|
|
|
|
|
|
and can serve as base class for your concrete Action implementations.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ManagerActionEvent.htm">ManagerActionEvent</a></td><td><div class="summary">
|
|
|
|
|
|
The ManagerActionEvent is implemented by ManagerActions that
|
|
|
|
|
|
return their result not in a ManagerResponse but by sending a series of events.<br />
|
|
|
|
|
|
The event type that indicates that Asterisk is finished is returned by the
|
|
|
|
|
|
ActionCompleteEventClass property.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ManagerActionResponse.htm">ManagerActionResponse</a></td><td><div class="summary">
|
|
|
|
|
|
The ManagerActionResponse is implemented by ManagerActions that
|
|
|
|
|
|
return their result in a custom ManagerResponse<br />
|
|
|
|
|
|
The response type that indicates that Asterisk is finished is returned by the
|
|
|
|
|
|
ActionCompleteResponseClass property.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_MonitorAction.htm">MonitorAction</a></td><td><div class="summary">
|
|
|
|
|
|
The MonitorAction starts monitoring (recording) a channel.<br />
|
|
|
|
|
|
It is implemented in res/res_monitor.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_OriginateAction.htm">OriginateAction</a></td><td><div class="summary">
|
|
|
|
|
|
The OriginateAction generates an outgoing call to the extension in the given
|
|
|
|
|
|
context with the given priority or to a given application with optional
|
|
|
|
|
|
parameters.<br />
|
|
|
|
|
|
If you want to connect to an extension use the properties context, exten and
|
|
|
|
|
|
priority. If you want to connect to an application use the properties
|
|
|
|
|
|
application and data if needed. Note that no call detail record will be
|
|
|
|
|
|
written when directly connecting to an application, so it may be better to
|
|
|
|
|
|
connect to an extension that starts the application you wish to connect to.<br />
|
|
|
|
|
|
The response to this action is sent when the channel has been answered and
|
|
|
|
|
|
asterisk starts connecting it to the given extension. So be careful not to
|
|
|
|
|
|
choose a too short timeout when waiting for the response.<br />
|
|
|
|
|
|
If you set async to true Asterisk reports an OriginateSuccess-
|
|
|
|
|
|
and OriginateFailureEvents. The action id of these events equals the action
|
|
|
|
|
|
id of this OriginateAction.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ParkAction.htm">ParkAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ParkAction allows to send a Channel to a Parking lot.<br />
|
|
|
|
|
|
A successful login is the precondition for sending for that
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ParkedCallsAction.htm">ParkedCallsAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ParkedCallsAction requests a list of all currently parked calls.<br />
|
|
|
|
|
|
For each active channel a ParkedCallEvent is generated. After all parked
|
|
|
|
|
|
calls have been reported a ParkedCallsCompleteEvent is generated.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_PingAction.htm">PingAction</a></td><td><div class="summary">
|
|
|
|
|
|
The PingAction will ellicit a 'Pong' response, it is used to keep the manager
|
|
|
|
|
|
connection open and performs no operation.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ProxyAction.htm">ProxyAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueAddAction.htm">QueueAddAction</a></td><td><div class="summary">
|
|
|
|
|
|
The QueueAddAction adds a new member to a queue.<br />
|
|
|
|
|
|
It is implemented in apps/app_queue.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueLogAction.htm">QueueLogAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueuePauseAction.htm">QueuePauseAction</a></td><td><div class="summary">
|
|
|
|
|
|
The QueuePauseAction makes a queue member temporarily unavailabe (or available again).<br />
|
|
|
|
|
|
It is implemented in apps/app_queue.c<br />
|
|
|
|
|
|
Available since Asterisk 1.2.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueuePenaltyAction.htm">QueuePenaltyAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueReloadAction.htm">QueueReloadAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueRemoveAction.htm">QueueRemoveAction</a></td><td><div class="summary">
|
|
|
|
|
|
The QueueRemoveAction removes a member from a queue.<br />
|
|
|
|
|
|
It is implemented in apps/app_queue.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueResetAction.htm">QueueResetAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueRuleAction.htm">QueueRuleAction</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_QueueStatusAction.htm">QueueStatusAction</a></td><td><div class="summary">
|
|
|
|
|
|
The QueueStatusAction requests the state of all defined queues their members (agents) and entries (callers).<br />
|
|
|
|
|
|
For each queue a QueueParamsEvent is generated, followed by a
|
|
|
|
|
|
QueueMemberEvent for each member of that queue and a QueueEntryEvent for each
|
|
|
|
|
|
entry in the queue.<br />
|
|
|
|
|
|
Since Asterisk 1.2 a QueueStatusCompleteEvent is sent to denote the end of the generated dump.<br />
|
|
|
|
|
|
This action is implemented in apps/app_queue.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_RedirectAction.htm">RedirectAction</a></td><td><div class="summary">
|
|
|
|
|
|
Redirects a given channel (and an optional additional channel) to a new extension.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_SetCDRUserFieldAction.htm">SetCDRUserFieldAction</a></td><td><div class="summary">
|
|
|
|
|
|
The SetCDRUserFieldAction causes the user field of the call detail record for the given channel to be changed.
|
|
|
|
|
|
<br />
|
|
|
|
|
|
Depending on the value of the append property the value is appended or overwritten.<br />
|
|
|
|
|
|
The SetCDRUserFieldAction is implemented in apps/app_setcdruserfield.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_SetVarAction.htm">SetVarAction</a></td><td><div class="summary">
|
|
|
|
|
|
The SetVar action sets the value of a channel variable for a given channel.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_SIPPeersAction.htm">SIPPeersAction</a></td><td><div class="summary">
|
|
|
|
|
|
Retrieves a list of all defined SIP peers.<br />
|
|
|
|
|
|
For each peer that is found a PeerEntryEvent is sent by Asterisk containing
|
|
|
|
|
|
the details. When all peers have been reported a PeerlistCompleteEvent is sent.<br />
|
|
|
|
|
|
Available since Asterisk 1.2
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_SIPShowPeerAction.htm">SIPShowPeerAction</a></td><td><div class="summary">
|
|
|
|
|
|
Retrieves a the details about a given SIP peer.<br />
|
|
|
|
|
|
For a PeerEntryEvent is sent by Asterisk containing the details of the peer
|
|
|
|
|
|
followed by a PeerlistCompleteEvent.<br />
|
|
|
|
|
|
Available since Asterisk 1.2
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_StatusAction.htm">StatusAction</a></td><td><div class="summary">
|
|
|
|
|
|
The StatusAction requests the state of all active channels.<br />
|
|
|
|
|
|
For each active channel a StatusEvent is generated. After the state of all
|
|
|
|
|
|
channels has been reported a StatusCompleteEvent is generated.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_StopMonitorAction.htm">StopMonitorAction</a></td><td><div class="summary">
|
|
|
|
|
|
The StopMonitorAction ends monitoring (recording) a channel.<br />
|
|
|
|
|
|
It is implemented in res/res_monitor.c
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_UpdateConfigAction.htm">UpdateConfigAction</a></td><td><div class="summary">
|
|
|
|
|
|
The UpdateConfigAction sends an UpdateConfig command to the asterisk server.
|
|
|
|
|
|
Please take note that unlike the manager documentation, this command does not
|
|
|
|
|
|
dump back the config file upon success -- it only tells you it succeeded. You
|
|
|
|
|
|
should use the handy addCommand method this class provides for specifying
|
|
|
|
|
|
what actions you would like to take on the configuration file. It will
|
|
|
|
|
|
generate appropriate sequence numbers for the command. You may use the static
|
|
|
|
|
|
ACTION_* fields provided by this action to specify what action you would like
|
|
|
|
|
|
to take, while avoiding handling the strings required. Plain fields:<br />
|
|
|
|
|
|
SrcFilename: Configuration filename to read(e.g. foo.conf)<br />
|
|
|
|
|
|
DstFilename: Configuration filename to write(e.g. foo.conf)<br />
|
|
|
|
|
|
Reload: Whether or not a reload should take place (or name of specific module)<br />
|
|
|
|
|
|
Repeatable fields:<br />
|
|
|
|
|
|
Action-XXXXXX: Action to Take (NewCat,RenameCat,DelCat,Update,Delete,Append)<br />
|
|
|
|
|
|
Cat-XXXXXX: Category to operate on<br />
|
|
|
|
|
|
Var-XXXXXX: Variable to work on<br />
|
|
|
|
|
|
Value-XXXXXX: Value to work on<br />
|
|
|
|
|
|
Match-XXXXXX: Extra match required to match line
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ZapDialOffhookAction.htm">ZapDialOffhookAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ZapDialOffhookAction dials a number on a zap channel while offhook.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ZapDNDOffAction.htm">ZapDNDOffAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ZapDNDOnAction switches a zap channel "Do Not Disturb" status off.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ZapDNDOnAction.htm">ZapDNDOnAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ZapDNDOnAction switches a zap channel "Do Not Disturb" status on.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ZapHangupAction.htm">ZapHangupAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ZapHangupAction hangs up a zap channel.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ZapShowChannelsAction.htm">ZapShowChannelsAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ZapShowChannelsAction requests the state of all zap channels.<br />
|
|
|
|
|
|
For each zap channel a ZapShowChannelsEvent is generated. After all zap
|
|
|
|
|
|
channels have been listed a ZapShowChannelsCompleteEvent is generated.
|
|
|
|
|
|
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Action_ZapTransferAction.htm">ZapTransferAction</a></td><td><div class="summary">
|
|
|
|
|
|
The ZapTransferAction transfers a zap channel.
|
|
|
|
|
|
</div></td></tr></table></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
|
