AMI Actions: Cheat Sheet

167 entries, compact print-friendly format

AMI Actions | AsteriskRecipes.com Cheat Sheet
Name Syntax Synopsis Since
Command Command Execute Asterisk CLI Command. 0.3.0
AGI AGI Add an AGI command to execute by Async AGI. 1.6.0
AOCMessage AOCMessage Generate an Advice of Charge message on a channel. 1.8.0
AbsoluteTimeout AbsoluteTimeout Set absolute timeout. 0.5.0
AgentLogoff AgentLogoff Sets an agent as no longer logged in. 1.2.0
Agents Agents Lists agents and their status. 1.2.0
Atxfer Atxfer Attended transfer. 1.6.1.0
BlindTransfer BlindTransfer Blind transfer channel(s) to the given destination 12.0.0
Bridge Bridge Bridge two channels already in the PBX. 1.6.0
BridgeDestroy BridgeDestroy Destroy a bridge. 12.0.0
BridgeInfo BridgeInfo Get information about a bridge. 12.0.0
BridgeKick BridgeKick Kick a channel from a bridge. 12.0.0
BridgeList BridgeList Get a list of bridges in the system. 12.0.0
BridgeTechnologyList BridgeTechnologyList List available bridging technologies and their statuses. 12.0.0
BridgeTechnologySuspend BridgeTechnologySuspend Suspend a bridging technology. 12.0.0
BridgeTechnologyUnsuspend BridgeTechnologyUnsuspend Unsuspend a bridging technology. 12.0.0
CancelAtxfer CancelAtxfer Cancel an attended transfer. 15.1.0, 14.7.0, 13.18.0
Challenge Challenge Generate Challenge for MD5 Auth. 0.4.0
ChangeMonitor Action: ChangeMonitor Change monitoring filename of a channel. N/A
ConfbridgeKick ConfbridgeKick Kick a Confbridge user. 10.0.0
ConfbridgeList ConfbridgeList List participants in a conference. 10.0.0
ConfbridgeListRooms ConfbridgeListRooms List active conferences. 10.0.0
ConfbridgeLock ConfbridgeLock Lock a Confbridge conference. 10.0.0
ConfbridgeMute ConfbridgeMute Mute a Confbridge user. 10.0.0
ConfbridgeSetSingleVideoSrc ConfbridgeSetSingleVideoSrc Set a conference user as the single video source distributed to all other participants. 10.0.0
ConfbridgeStartRecord ConfbridgeStartRecord Start recording a Confbridge conference. 10.0.0
ConfbridgeStopRecord ConfbridgeStopRecord Stop recording a Confbridge conference. 10.0.0
ConfbridgeUnlock ConfbridgeUnlock Unlock a Confbridge conference. 10.0.0
ConfbridgeUnmute ConfbridgeUnmute Unmute a Confbridge user. 10.0.0
ControlPlayback ControlPlayback Control the playback of a file being played to a channel. 12.0.0
CoreSettings CoreSettings Show PBX core settings (version etc). 1.6.0
CoreShowChannelMap CoreShowChannelMap List all channels connected to the specified channel. 20.4.0, 18.19.0
CoreShowChannels CoreShowChannels List currently active channels. 1.6.0
CoreStatus CoreStatus Show PBX core status variables. 1.6.0
CreateConfig CreateConfig Creates an empty file in the configuration directory. 1.6.0
DAHDIDNDoff DAHDIDNDoff Toggle DAHDI channel Do Not Disturb status OFF. 1.4.22
DAHDIDNDon DAHDIDNDon Toggle DAHDI channel Do Not Disturb status ON. 1.4.22
DAHDIDialOffhook DAHDIDialOffhook Dial over DAHDI channel while offhook. 1.4.22
DAHDIHangup DAHDIHangup Hangup DAHDI Channel. 1.4.22
DAHDIRestart DAHDIRestart Fully Restart DAHDI channels (terminates calls). 1.4.22
DAHDIShowChannels DAHDIShowChannels Show status of DAHDI channels. 1.4.22
DAHDIShowStatus DAHDIShowStatus Show status of DAHDI spans. 21.3.0, 20.8.0, 18.23.0
DAHDITransfer DAHDITransfer Transfer DAHDI Channel. 1.4.22
DBDel DBDel Delete DB entry. 1.6.0
DBDelTree DBDelTree Delete DB Tree. 1.6.0
DBGet DBGet Get DB Entry. 1.2.0
DBGetTree DBGetTree Get DB entries, optionally at a particular family/key 19.6.0, 18.14.0, 16.28.0
DBPut DBPut Put DB entry. 1.2.0
DeviceStateList DeviceStateList List the current known device states. 13.0.0
DialplanExtensionAdd DialplanExtensionAdd Add an extension to the dialplan 13.0.0
DialplanExtensionRemove DialplanExtensionRemove Remove an extension from the dialplan 13.0.0
Events Events Control Event Flow. 0.9.0
ExtensionState ExtensionState Check Extension Status. 0.4.0
ExtensionStateList ExtensionStateList List the current known extension states. 13.0.0
FAXSession FAXSession Responds with a detailed description of a single FAX session 13.0.0
FAXSessions FAXSessions Lists active FAX sessions 13.0.0
FAXStats FAXStats Responds with fax statistics 13.0.0
Filter Filter Dynamically add filters for the current manager session. 10.0.0
GetConfig GetConfig Retrieve configuration. 1.4.0
GetConfigJSON GetConfigJSON Retrieve configuration (JSON format). 1.6.0
Getvar Getvar Gets a channel variable or function value. 1.0.0
Hangup Hangup Hangup channel. 0.2.0
IAXnetstats IAXnetstats Show IAX Netstats. 1.2.0
IAXpeerlist IAXpeerlist List IAX Peers. 1.6.0
IAXpeers IAXpeers List IAX peers. 0.3.0
IAXregistry IAXregistry Show IAX registrations. 1.6.2.0
JabberSend JabberSend Sends a message to a Jabber Client. 1.4.0
ListCategories ListCategories List categories in configuration file. 1.6.0
ListCommands ListCommands List available manager commands. 1.0.0
LocalOptimizeAway LocalOptimizeAway Optimize away a local channel when possible. 1.8.0
LoggerRotate LoggerRotate Reload and rotate the Asterisk logger. 13.0.0
Login Login Login Manager. 0.2.0
Logoff Logoff Logoff Manager. 0.2.0
MWIDelete MWIDelete Delete selected mailboxes. 12.1.0
MWIGet MWIGet Get selected mailboxes with message counts. 12.1.0
MWIUpdate MWIUpdate Update the mailbox message counts. 12.1.0
MailboxCount MailboxCount Check Mailbox Message Count. 0.5.0
MailboxStatus MailboxStatus Check mailbox. 0.4.0
MeetmeList MeetmeList List participants in a conference. 1.6.0
MeetmeListRooms MeetmeListRooms List active conferences. 10.0.0
MeetmeMute MeetmeMute Mute a Meetme user. 1.4.0
MeetmeUnmute MeetmeUnmute Unmute a Meetme user. 1.4.0
MessageSend MessageSend Send an out of call message to an endpoint. 11.0.0
MixMonitor MixMonitor Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee the audio file is a... 11.0.0
MixMonitorMute MixMonitorMute Mute / unMute a Mixmonitor recording. 1.8.0
ModuleCheck ModuleCheck Check if module is loaded. 1.6.0
ModuleLoad ModuleLoad Module management. 1.6.0
Monitor Action: Monitor Monitor a channel. N/A
MuteAudio MuteAudio Mute an audio stream. 1.8.0
Originate Originate Originate a call. 0.2.0
PJSIPHangup PJSIPHangup Hangup an incoming PJSIP channel with a SIP response code 21.1.0, 20.6.0, 18.21.0
PJSIPNotify PJSIPNotify Send a NOTIFY to either an endpoint, an arbitrary URI, or inside a SIP dialog. 12.0.0
PJSIPQualify PJSIPQualify Qualify a chan_pjsip endpoint. 12.0.0
PJSIPRegister PJSIPRegister Register an outbound registration. 13.2.0
PJSIPShowAors PJSIPShowAors Lists PJSIP AORs. 16.0.0
PJSIPShowAuths PJSIPShowAuths Lists PJSIP Auths. 16.0.0
PJSIPShowContacts PJSIPShowContacts Lists PJSIP Contacts. 16.0.0
PJSIPShowEndpoint PJSIPShowEndpoint Detail listing of an endpoint and its objects. 12.0.0
PJSIPShowEndpoints PJSIPShowEndpoints Lists PJSIP endpoints. 12.0.0
PJSIPShowRegistrationInboundContactStatuses PJSIPShowRegistrationInboundContactStatuses Lists ContactStatuses for PJSIP inbound registrations. 14.3.0, 13.14.0
PJSIPShowRegistrationsInbound PJSIPShowRegistrationsInbound Lists PJSIP inbound registrations. 12.0.0
PJSIPShowRegistrationsOutbound PJSIPShowRegistrationsOutbound Lists PJSIP outbound registrations. 12.0.0
PJSIPShowResourceLists PJSIPShowResourceLists Displays settings for configured resource lists. 13.0.0
PJSIPShowSubscriptionsInbound PJSIPShowSubscriptionsInbound Lists inbound subscriptions. 12.0.0
PJSIPShowSubscriptionsOutbound PJSIPShowSubscriptionsOutbound Lists outbound subscriptions. 12.0.0
PJSIPUnregister PJSIPUnregister Unregister an outbound registration. 12.0.0
PRIDebugFileSet PRIDebugFileSet Set the file used for PRI debug message output 13.0.0
PRIDebugFileUnset PRIDebugFileUnset Disables file output for PRI debug messages 13.0.0
PRIDebugSet PRIDebugSet Set PRI debug levels for a span 13.0.0
PRIShowSpans PRIShowSpans Show status of PRI spans. 10.0.0
Park Park Park a channel. 1.4.0
ParkedCalls ParkedCalls List parked calls. 0.7.2
Parkinglots Parkinglots Get a list of parking lots 11.0.0
PauseMonitor Action: PauseMonitor Pause monitoring of a channel. N/A
Ping Ping Keepalive command. 0.2.0
PlayDTMF PlayDTMF Play DTMF signal on a specific channel. 1.4.0
PlayMF PlayMF Play MF digit on a specific channel. 16.21.0, 18.7.0, 19.0.0
PresenceState PresenceState Check Presence State 11.0.0
PresenceStateList PresenceStateList List the current known presence states. 13.0.0
QueueAdd QueueAdd Add interface to queue. 1.0.0
QueueChangePriorityCaller QueueChangePriorityCaller Change priority of a caller on queue. 15.0.0
QueueLog QueueLog Adds custom entry in queue_log. 1.6.0
QueueMemberRingInUse QueueMemberRingInUse Set the ringinuse value for a queue member. 11.0.0
QueuePause QueuePause Makes a queue member temporarily unavailable. 1.2.0
QueuePenalty QueuePenalty Set the penalty for a queue member. 1.6.0
QueueReload QueueReload Reload a queue, queues, or any sub-section of a queue or queues. 1.6.2.0
QueueRemove QueueRemove Remove interface from queue. 1.0.0
QueueReset QueueReset Reset queue statistics. 1.6.2.0
QueueRule QueueRule Queue Rules. 1.6.0
QueueStatus QueueStatus Show queue status. 0.5.0
QueueSummary QueueSummary Show queue summary. 1.6.0
QueueWithdrawCaller QueueWithdrawCaller Request to withdraw a caller from the queue back to the dialplan. 19.3.0, 18.11.0, 16.25.0
Redirect Redirect Redirect (transfer) a call. 0.2.0
Reload Reload Send a reload event. 1.6.0
SIPnotify Action: SIPnotify Send a SIP notify. N/A
SIPpeers Action: SIPpeers List SIP peers (text format). N/A
SIPpeerstatus Action: SIPpeerstatus Show the status of one or all of the sip peers. N/A
SIPqualifypeer Action: SIPqualifypeer Qualify SIP peers. N/A
SIPshowpeer Action: SIPshowpeer show SIP peer (text format). N/A
SIPshowregistry Action: SIPshowregistry Show SIP registrations (text format). N/A
SKINNYdevices Action: SKINNYdevices List SKINNY devices (text format). N/A
SKINNYlines Action: SKINNYlines List SKINNY lines (text format). N/A
SKINNYshowdevice Action: SKINNYshowdevice Show SKINNY device (text format). N/A
SKINNYshowline Action: SKINNYshowline Show SKINNY line (text format). N/A
SendFlash SendFlash Send a hook flash on a specific channel. 20.3.0, 18.18.0
SendText SendText Sends a text message to channel. A content type can be optionally specified. If not set it is set to an empty string all... 1.6.0
Setvar Setvar Sets a channel variable or function value. 1.0.0
ShowDialPlan ShowDialPlan Show dialplan contexts and extensions 1.6.0
SorceryMemoryCacheExpire SorceryMemoryCacheExpire Expire (remove) ALL objects from a sorcery memory cache. 13.5.0
SorceryMemoryCacheExpireObject SorceryMemoryCacheExpireObject Expire (remove) an object from a sorcery memory cache. 13.5.0
SorceryMemoryCachePopulate SorceryMemoryCachePopulate Expire all objects from a memory cache and populate it with all objects from the backend. 13.7.0
SorceryMemoryCacheStale SorceryMemoryCacheStale Marks ALL objects in a sorcery memory cache as stale. 13.5.0
SorceryMemoryCacheStaleObject SorceryMemoryCacheStaleObject Mark an object in a sorcery memory cache as stale. 13.5.0
Status Status List channel status. 0.2.0
StopMixMonitor StopMixMonitor Stop recording a call through MixMonitor, and free the recording's file handle. 11.0.0
StopMonitor Action: StopMonitor Stop monitoring a channel. N/A
UnpauseMonitor Action: UnpauseMonitor Unpause monitoring of a channel. N/A
UpdateConfig UpdateConfig Update basic configuration. 1.4.0
UserEvent UserEvent Send an arbitrary event. 1.4.0
VoicemailBoxSummary VoicemailBoxSummary Show the mailbox contents of given voicemail user. 20.5.0, 18.20.0
VoicemailForward VoicemailForward Forward Voicemail from one mailbox folder to another between given users. 20.5.0, 18.20.0
VoicemailMove VoicemailMove Move Voicemail between mailbox folders of given user. 20.5.0, 18.20.0
VoicemailRefresh VoicemailRefresh Tell Asterisk to poll mailboxes for a change 12.0.0
VoicemailRemove VoicemailRemove Remove Voicemail from mailbox folder. 20.5.0, 18.20.0
VoicemailUserStatus VoicemailUserStatus Show the status of given voicemail user's info. 16.0.0
VoicemailUsersList VoicemailUsersList List All Voicemail User Information. 1.6.0
WaitEvent WaitEvent Wait for an event to occur. 1.4.0