AMI Actions 167

A

AGI Add an AGI command to execute by Async AGI. AOCMessage Generate an Advice of Charge message on a channel. AbsoluteTimeout Set absolute timeout. AgentLogoff Sets an agent as no longer logged in. Agents Lists agents and their status. Atxfer Attended transfer.

B

BlindTransfer Blind transfer channel(s) to the given destination Bridge Bridge two channels already in the PBX. BridgeDestroy Destroy a bridge. BridgeInfo Get information about a bridge. BridgeKick Kick a channel from a bridge. BridgeList Get a list of bridges in the system. BridgeTechnologyList List available bridging technologies and their statuses. BridgeTechnologySuspend Suspend a bridging technology. BridgeTechnologyUnsuspend Unsuspend a bridging technology.

C

Command Execute Asterisk CLI Command. CancelAtxfer Cancel an attended transfer. Note, this uses the configured cancel attended transfer feature option ... Challenge Generate Challenge for MD5 Auth. ChangeMonitor May be used to change the file started by a previous 'Monitor' action. Asterisk AMI action reference... ConfbridgeKick ### Syntax Action: ConfbridgeKick ActionID: <value> Conference: <value> Channel: <value>. Asterisk A... ConfbridgeList Lists all users in a particular ConfBridge conference. ConfbridgeList will follow as separate events... ConfbridgeListRooms Lists data about all active conferences. ConfbridgeListRooms will follow as separate events, followe... ConfbridgeLock Lock a Confbridge conference. ConfbridgeMute ### Syntax Action: ConfbridgeMute ActionID: <value> Conference: <value> Channel: <value>. Asterisk A... ConfbridgeSetSingleVideoSrc Set a conference user as the single video source distributed to all other participants. ConfbridgeStartRecord Start recording a Confbridge conference. ConfbridgeStopRecord Stop recording a Confbridge conference. ConfbridgeUnlock Unlock a Confbridge conference. ConfbridgeUnmute ### Syntax Action: ConfbridgeUnmute ActionID: <value> Conference: <value> Channel: <value>. Asterisk... ControlPlayback Control the playback of a file being played to a channel. CoreSettings Show PBX core settings (version etc). CoreShowChannelMap List all channels connected to the specified channel. CoreShowChannels List currently active channels. CoreStatus Show PBX core status variables. CreateConfig Creates an empty file in the configuration directory.

D

DAHDIDNDoff Toggle DAHDI channel Do Not Disturb status OFF. DAHDIDNDon Toggle DAHDI channel Do Not Disturb status ON. DAHDIDialOffhook Dial over DAHDI channel while offhook. DAHDIHangup Simulate an on-hook event by the user connected to the channel. Valid only for analog channels. ///.... DAHDIRestart Fully Restart DAHDI channels (terminates calls). DAHDIShowChannels Show status of DAHDI channels. DAHDIShowStatus Show status of DAHDI spans. DAHDITransfer Transfer DAHDI Channel. DBDel Delete DB entry. DBDelTree Delete DB Tree. DBGet Get DB Entry. DBGetTree Get DB entries, optionally at a particular family/key DBPut Put DB entry. DeviceStateList This will list out all known device states in a sequence of DeviceStateChange events. When finished,... DialplanExtensionAdd ### Syntax Action: DialplanExtensionAdd ActionID: <value> Context: <value> Extension: <value> Priori... DialplanExtensionRemove Remove an extension from the dialplan

E

Events Control Event Flow. ExtensionState Report the extension state for given extension. If the extension has a hint, will use devicestate to... ExtensionStateList This will list out all known extension states in a sequence of ExtensionStatus events. When finished...

F

FAXSession Responds with a detailed description of a single FAX session FAXSessions Lists active FAX sessions FAXStats Provides FAX statistics including the number of active sessions, reserved sessions, completed sessio... Filter Dynamically add filters for the current manager session.

G

GetConfig Retrieve configuration. GetConfigJSON Will dump the contents of a configuration file by category and contents in JSON format or optionally... Getvar Get the value of a channel variable or function return. If a channel name is not provided then the v...

H

Hangup Hangup channel.

I

IAXnetstats Show IAX Netstats. IAXpeerlist List IAX Peers. IAXpeers List IAX peers. IAXregistry Show IAX registrations.

J

JabberSend Sends a message to a Jabber Client.

L

ListCategories List categories in configuration file. ListCommands List available manager commands. LocalOptimizeAway A local channel created with "/n" will not automatically optimize away. Calling this command on the ... LoggerRotate Reload and rotate the Asterisk logger. Login Authenticate a manager connection to the Asterisk Manager Interface. Required before sending any oth... Logoff Logoff Manager.

M

MWIDelete Delete selected mailboxes. MWIGet Get selected mailboxes with message counts. MWIUpdate Update the mailbox message counts. MailboxCount Checks a voicemail account for new messages. Returns number of urgent, new and old messages. Asteris... MailboxStatus Checks a voicemail account for status. Returns whether there are messages waiting. Message: Mailbox ... MeetmeList Lists all users in a particular MeetMe conference. MeetmeList will follow as separate events, follow... MeetmeListRooms Lists data about all active conferences. MeetmeListRooms will follow as separate events, followed by... MeetmeMute Mute a Meetme user. MeetmeUnmute Unmute a Meetme user. MessageSend ### Syntax Action: MessageSend ActionID: <value> [Destination: <value>] [To: <value>] From: <value> ... MixMonitor Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee... MixMonitorMute Mute / unMute a Mixmonitor recording. ModuleCheck Checks if Asterisk module is loaded. Will return Success/Failure. An empty Version header is also re... ModuleLoad Module management. Monitor May be used to record the audio on a specified channel. Asterisk AMI action reference. MuteAudio Mute an audio stream.

O

Originate Originate a call.

P

PJSIPHangup Hangup an incoming PJSIP channel with a SIP response code PJSIPNotify Send a NOTIFY to either an endpoint, an arbitrary URI, or inside a SIP dialog. PJSIPQualify Qualify a chan_pjsip endpoint. PJSIPRegister Unregisters the specified (or all) outbound registration(s) then starts registration and schedules r... PJSIPShowAors Provides a listing of all AORs. For each AOR an 'AorList' event is raised that contains relevant att... PJSIPShowAuths Provides a listing of all Auths. For each Auth an 'AuthList' event is raised that contains relevant ... PJSIPShowContacts Provides a listing of all Contacts. For each Contact a 'ContactList' event is raised that contains r... PJSIPShowEndpoint Provides a detailed listing of options for a given endpoint. Events are issued showing the configura... PJSIPShowEndpoints Provides a listing of all endpoints. For each endpoint an 'EndpointList' event is raised that contai... PJSIPShowRegistrationInboundContactStatuses Lists ContactStatuses for PJSIP inbound registrations. PJSIPShowRegistrationsInbound In response, 'InboundRegistrationDetail' events showing configuration and status information are rai... PJSIPShowRegistrationsOutbound In response 'OutboundRegistrationDetail' events showing configuration and status information are rai... PJSIPShowResourceLists Displays settings for configured resource lists. PJSIPShowSubscriptionsInbound Provides a listing of all inbound subscriptions. An event 'InboundSubscriptionDetail' is issued for ... PJSIPShowSubscriptionsOutbound Provides a listing of all outbound subscriptions. An event 'OutboundSubscriptionDetail' is issued fo... PJSIPUnregister Unregisters the specified (or all) outbound registration(s) and stops future registration attempts. ... PRIDebugFileSet Set the file used for PRI debug message output PRIDebugFileUnset Disables file output for PRI debug messages PRIDebugSet Set PRI debug levels for a span PRIShowSpans Show status of PRI spans. Park Park an arbitrary channel with optional arguments for specifying the parking lot used, how long the ... ParkedCalls List parked calls. Parkinglots Get a list of parking lots PauseMonitor May be used to temporarily stop the recording of a channel. Asterisk AMI action reference. Ping Keepalive command. PlayDTMF Play DTMF signal on a specific channel. PlayMF Play MF digit on a specific channel. PresenceState Report the presence state for the given presence provider. Will return a 'Presence State' message. A... PresenceStateList This will list out all known presence states in a sequence of PresenceStateChange events. When finis...

Q

QueueAdd ### Syntax Action: QueueAdd ActionID: <value> Queue: <value> Interface: <value> Penalty: <value> Pau... QueueChangePriorityCaller ### Syntax Action: QueueChangePriorityCaller ActionID: <value> Queue: <value> Caller: <value> Priori... QueueLog ### Syntax Action: QueueLog ActionID: <value> Queue: <value> Event: <value> Uniqueid: <value> Interf... QueueMemberRingInUse Set the ringinuse value for a queue member. QueuePause Makes a queue member temporarily unavailable. QueuePenalty Set the penalty for a queue member. QueueReload Reload a queue, queues, or any sub-section of a queue or queues. QueueRemove Remove interface from queue. QueueReset Reset queue statistics. QueueRule Queue Rules. QueueStatus Show queue status. QueueSummary Show queue summary. QueueWithdrawCaller Request to withdraw a caller from the queue back to the dialplan.

R

Redirect Redirect (transfer) a call. Reload Send a reload event.

S

SIPnotify Sends a SIP Notify event. All parameters for this event must be specified in the body of this reques... SIPpeers Lists SIP peers in text format with details on current status. 'Peerlist' will follow as separate ev... SIPpeerstatus Retrieves the status of one or all of the sip peers. If no peer name is specified, status for all of... SIPqualifypeer Asterisk SIPqualifypeer AMI action reference. Complete documentation with syntax, arguments, and usa... SIPshowpeer Show one SIP peer with details on current status. Asterisk AMI action reference. SIPshowregistry Lists all registration requests and status. Registrations will follow as separate events followed by... SKINNYdevices Lists Skinny devices in text format with details on current status. Devicelist will follow as separa... SKINNYlines Lists Skinny lines in text format with details on current status. Linelist will follow as separate e... SKINNYshowdevice Show one SKINNY device with details on current status. Asterisk AMI action reference. SKINNYshowline Show one SKINNY line with details on current status. Asterisk AMI action reference. SendFlash Send a hook flash on a specific channel. SendText Sends a text message to channel. A content type can be optionally specified. If not set it is set to... Setvar Can be used to set the value of channel variables or dialplan functions. If a channel name is not pr... ShowDialPlan Show dialplan contexts and extensions SorceryMemoryCacheExpire Expire (remove) ALL objects from a sorcery memory cache. SorceryMemoryCacheExpireObject Expire (remove) an object from a sorcery memory cache. SorceryMemoryCachePopulate Expire all objects from a memory cache and populate it with all objects from the backend. SorceryMemoryCacheStale Marks ALL objects in a sorcery memory cache as stale. SorceryMemoryCacheStaleObject Mark an object in a sorcery memory cache as stale. Status List channel status. StopMixMonitor Stop recording a call through MixMonitor, and free the recording's file handle. StopMonitor May be used to end a previously started 'Monitor' action. Asterisk AMI action reference.

U

UnpauseMonitor May be used to re-enable recording of a channel after calling PauseMonitor. Asterisk AMI action refe... UpdateConfig Update basic configuration. UserEvent Send an arbitrary event.

V

VoicemailBoxSummary Show the mailbox contents of given voicemail user. VoicemailForward Forward Voicemail from one mailbox folder to another between given users. VoicemailMove Move Voicemail between mailbox folders of given user. VoicemailRefresh Normally, MWI indicators are only sent when Asterisk itself changes a mailbox. With external program... VoicemailRemove Remove Voicemail from mailbox folder. VoicemailUserStatus Show the status of given voicemail user's info. VoicemailUsersList List All Voicemail User Information.

W

WaitEvent Will elicit a 'Success' response. Whenever a manager event is queued. Once WaitEvent has been called...