AMI Events: Cheat Sheet
184 entries, compact print-friendly format
AMI Events | AsteriskRecipes.com Cheat Sheet
| Name | Syntax | Synopsis | Since |
|---|---|---|---|
| AGIExecEnd | AGIExecEnd |
Raised when a received AGI command completes processing. | 12.0.0 |
| AGIExecStart | AGIExecStart |
Raised when a received AGI command starts processing. | 12.0.0 |
| AOC-D | AOC-D |
Raised when an Advice of Charge message is sent during a call. | 12.0.0 |
| AOC-E | AOC-E |
Raised when an Advice of Charge message is sent at the end of a call. | 12.0.0 |
| AOC-S | AOC-S |
Raised when an Advice of Charge message is sent at the beginning of a call. | 12.0.0 |
| AgentCalled | AgentCalled |
Raised when an queue member is notified of a caller in the queue. | 12.0.0 |
| AgentComplete | AgentComplete |
Raised when a queue member has finished servicing a caller in the queue. | 12.0.0 |
| AgentConnect | AgentConnect |
Raised when a queue member answers and is bridged to a caller in the queue. | 12.0.0 |
| AgentDump | AgentDump |
Raised when a queue member hangs up on a caller in the queue. | 12.0.0 |
| AgentLogin | AgentLogin |
Raised when an Agent has logged in. | 12.0.0 |
| AgentLogoff | AgentLogoff |
Raised when an Agent has logged off. | 12.0.0 |
| AgentRingNoAnswer | AgentRingNoAnswer |
Raised when a queue member is notified of a caller in the queue and fails to answer. | 12.0.0 |
| Agents | Agents |
Response event in a series to the Agents AMI action containing information about a defined agent. | 12.0.0 |
| AgentsComplete | AgentsComplete |
Final response event in a series of events to the Agents AMI action. | 12.0.0 |
| Alarm | Alarm |
Raised when an alarm is set on a DAHDI channel. | 12.0.0 |
| AlarmClear | AlarmClear |
Raised when an alarm is cleared on a DAHDI channel. | 12.0.0 |
| AorDetail | AorDetail |
Provide details about an Address of Record (AoR) section. | 13.12.0, 14.1.0 |
| AorList | AorList |
Provide details about an Address of Record (AoR) section. | 16.0.0 |
| AorListComplete | AorListComplete |
Provide final information about an aor list. | 16.0.0 |
| AsyncAGIEnd | AsyncAGIEnd |
Raised when a channel stops AsyncAGI command processing. | 12.0.0 |
| AsyncAGIExec | AsyncAGIExec |
Raised when AsyncAGI completes an AGI command. | 12.0.0 |
| AsyncAGIStart | AsyncAGIStart |
Raised when a channel starts AsyncAGI command processing. | 12.0.0 |
| AttendedTransfer | AttendedTransfer |
Raised when an attended transfer is complete. | 12.0.0 |
| AuthDetail | AuthDetail |
Provide details about an authentication section. | 12.0.0 |
| AuthList | AuthList |
Provide details about an Address of Record (Auth) section. | 16.0.0 |
| AuthListComplete | AuthListComplete |
Provide final information about an auth list. | 16.0.0 |
| AuthMethodNotAllowed | AuthMethodNotAllowed |
Raised when a request used an authentication method not allowed by the service. | 12.1.0 |
| BlindTransfer | BlindTransfer |
Raised when a blind transfer is complete. | 12.0.0 |
| BridgeCreate | BridgeCreate |
Raised when a bridge is created. | 12.0.0 |
| BridgeDestroy | BridgeDestroy |
Raised when a bridge is destroyed. | 12.0.0 |
| BridgeEnter | BridgeEnter |
Raised when a channel enters a bridge. | 12.0.0 |
| BridgeInfoChannel | BridgeInfoChannel |
Information about a channel in a bridge. | 13.0.0 |
| BridgeInfoComplete | BridgeInfoComplete |
Information about a bridge. | 13.0.0 |
| BridgeLeave | BridgeLeave |
Raised when a channel leaves a bridge. | 12.0.0 |
| BridgeMerge | BridgeMerge |
Raised when two bridges are merged. | 16.24.0, 18.10.0, 19.2.0 |
| BridgeVideoSourceUpdate | BridgeVideoSourceUpdate |
Raised when the channel that is the source of video in a bridge changes. | 13.13.0, 14.2.0 |
| CEL | CEL |
Raised when a Channel Event Log is generated for a channel. | 13.2.0 |
| Cdr | Cdr |
Raised when a CDR is generated. | 13.2.0 |
| ChallengeResponseFailed | ChallengeResponseFailed |
Raised when a request's attempt to authenticate has been challenged, and the request failed the authentication challenge... | 12.1.0 |
| ChallengeSent | ChallengeSent |
Raised when an Asterisk service sends an authentication challenge to a request. | 12.1.0 |
| ChanSpyStart | ChanSpyStart |
Raised when one channel begins spying on another channel. | 12.0.0 |
| ChanSpyStop | ChanSpyStop |
Raised when a channel has stopped spying. | 12.0.0 |
| ChannelTalkingStart | ChannelTalkingStart |
Raised when talking is detected on a channel. | 12.4.0 |
| ChannelTalkingStop | ChannelTalkingStop |
Raised when talking is no longer detected on a channel. | 12.4.0 |
| ConfbridgeEnd | ConfbridgeEnd |
Raised when a conference ends. | 12.0.0 |
| ConfbridgeJoin | ConfbridgeJoin |
Raised when a channel joins a Confbridge conference. | 12.0.0 |
| ConfbridgeLeave | ConfbridgeLeave |
Raised when a channel leaves a Confbridge conference. | 12.0.0 |
| ConfbridgeList | ConfbridgeList |
Raised as part of the ConfbridgeList action response list. | 13.20.0, 15.3.0 |
| ConfbridgeListRooms | ConfbridgeListRooms |
Raised as part of the ConfbridgeListRooms action response list. | 16.29.0, 18.15.0, 19.7.0 |
| ConfbridgeMute | ConfbridgeMute |
Raised when a Confbridge participant mutes. | 12.0.0 |
| ConfbridgeRecord | ConfbridgeRecord |
Raised when a conference starts recording. | 12.0.0 |
| ConfbridgeStart | ConfbridgeStart |
Raised when a conference starts. | 12.0.0 |
| ConfbridgeStopRecord | ConfbridgeStopRecord |
Raised when a conference that was recording stops recording. | 12.0.0 |
| ConfbridgeTalking | ConfbridgeTalking |
Raised when a confbridge participant begins or ends talking. | 12.0.0 |
| ConfbridgeUnmute | ConfbridgeUnmute |
Raised when a confbridge participant unmutes. | 12.0.0 |
| ContactList | ContactList |
Provide details about a contact section. | 16.0.0 |
| ContactListComplete | ContactListComplete |
Provide final information about a contact list. | 16.0.0 |
| ContactStatus | ContactStatus |
Raised when the state of a contact changes. | 13.5.0 |
| ContactStatusDetail | ContactStatusDetail |
Provide details about a contact's status. | 13.0.0 |
| CoreShowChannel | CoreShowChannel |
Raised in response to a CoreShowChannels command. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| CoreShowChannelMapComplete | CoreShowChannelMapComplete |
Raised at the end of the CoreShowChannelMap list produced by the CoreShowChannelMap command. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| CoreShowChannelsComplete | CoreShowChannelsComplete |
Raised at the end of the CoreShowChannel list produced by the CoreShowChannels command. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| DAHDIChannel | DAHDIChannel |
Raised when a DAHDI channel is created or an underlying technology is associated with a DAHDI channel. | 12.0.0 |
| DNDState | DNDState |
Raised when the Do Not Disturb state is changed on a DAHDI channel. | 12.0.0 |
| DTMFBegin | DTMFBegin |
Raised when a DTMF digit has started on a channel. | 16.24.0, 18.10.0, 19.2.0 |
| DTMFEnd | DTMFEnd |
Raised when a DTMF digit has ended on a channel. | 16.24.0, 18.10.0, 19.2.0 |
| DeadlockStart | DeadlockStart |
Raised when a probable deadlock has started. Delivery of this event is attempted but not guaranteed, and could fail for ... | 16.29.0, 18.15.0, 19.7.0 |
| DeviceStateChange | DeviceStateChange |
Raised when a device state changes | 13.0.0 |
| DeviceStateListComplete | DeviceStateListComplete |
Indicates the end of the list the current known extension states. | 13.0.0 |
| DialBegin | DialBegin |
Raised when a dial action has started. | 12.0.0 |
| DialEnd | DialEnd |
Raised when a dial action has completed. | 12.0.0 |
| DialState | DialState |
Raised when dial status has changed. | 14.0.0 |
| EndpointDetail | EndpointDetail |
Provide details about an endpoint section. | 12.0.0 |
| EndpointDetailComplete | EndpointDetailComplete |
Provide final information about endpoint details. | 12.0.0 |
| EndpointList | EndpointList |
Provide details about a contact's status. | 12.0.0 |
| EndpointListComplete | EndpointListComplete |
Provide final information about an endpoint list. | 12.0.0 |
| ExtensionStateListComplete | ExtensionStateListComplete |
Indicates the end of the list the current known extension states. | 13.0.0 |
| ExtensionStatus | ExtensionStatus |
Raised when a hint changes due to a device state change. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| FAXSession | FAXSession |
Raised in response to FAXSession manager command | 13.0.0 |
| FAXSessionsComplete | FAXSessionsComplete |
Raised when all FAXSession events are completed for a FAXSessions command | 13.0.0 |
| FAXSessionsEntry | FAXSessionsEntry |
A single list item for the FAXSessions AMI command | 13.0.0 |
| FAXStats | FAXStats |
Raised in response to FAXStats manager command | 13.0.0 |
| FAXStatus | FAXStatus |
Raised periodically during a fax transmission. | 12.0.0 |
| FailedACL | FailedACL |
Raised when a request violates an ACL check. | 12.1.0 |
| Flash | Flash |
Raised when a hook flash occurs on a channel. | 16.24.0, 18.10.0, 19.2.0 |
| FullyBooted | FullyBooted |
Raised when all Asterisk initialization procedures have finished. | 12.0.0 |
| Hangup | Hangup |
Raised when a channel is hung up. | 12.0.0 |
| HangupHandlerPop | HangupHandlerPop |
Raised when a hangup handler is removed from the handler stack by the CHANNEL() function. | 12.0.0 |
| HangupHandlerPush | HangupHandlerPush |
Raised when a hangup handler is added to the handler stack by the CHANNEL() function. | 12.0.0 |
| HangupHandlerRun | HangupHandlerRun |
Raised when a hangup handler is about to be called. | 12.0.0 |
| HangupRequest | HangupRequest |
Raised when a hangup is requested. | 12.0.0 |
| Hold | Hold |
Raised when a channel goes on hold. | 12.0.0 |
| IdentifyDetail | IdentifyDetail |
Provide details about an identify section. | 13.20.0, 15.3.0 |
| InboundRegistrationDetail | InboundRegistrationDetail |
Provide details about the Address of Record (AoR) associated with a registration. | 12.0.0 |
| InboundSubscriptionDetail | InboundSubscriptionDetail |
Provides details about an inbound subscription - one in which Asterisk handles SUBSCRIBE requests and periodically sends... | 12.0.0 |
| InvalidAccountID | InvalidAccountID |
Raised when a request fails an authentication check due to an invalid account ID. | 12.1.0 |
| InvalidPassword | InvalidPassword |
Raised when a request provides an invalid password during an authentication attempt. | 12.1.0 |
| InvalidTransport | InvalidTransport |
Raised when a request attempts to use a transport not allowed by the Asterisk service. | 12.1.0 |
| Load | Load |
Raised when a module has been loaded in Asterisk. | 16.0.0 |
| LoadAverageLimit | LoadAverageLimit |
Raised when a request fails because a configured load average limit has been reached. | 12.1.0 |
| LocalBridge | LocalBridge |
Raised when two halves of a Local Channel form a bridge. | 12.0.0 |
| LocalOptimizationBegin | LocalOptimizationBegin |
Raised when two halves of a Local Channel begin to optimize themselves out of the media path. | 12.0.0 |
| LocalOptimizationEnd | LocalOptimizationEnd |
Raised when two halves of a Local Channel have finished optimizing themselves out of the media path. | 12.0.0 |
| LogChannel | LogChannel |
Raised when a logging channel is re-enabled after a reload operation. | 16.24.0, 18.10.0, 19.2.0 |
| MCID | MCID |
Published when a malicious call ID request arrives. | 12.0.0 |
| MWIGet | MWIGet |
Raised in response to a MWIGet command. | 12.1.0 |
| MWIGetComplete | MWIGetComplete |
Raised in response to a MWIGet command. | 12.1.0 |
| MeetmeEnd | MeetmeEnd |
Raised when a MeetMe conference ends. | 12.0.0 |
| MeetmeJoin | MeetmeJoin |
Raised when a user joins a MeetMe conference. | 12.0.0 |
| MeetmeLeave | MeetmeLeave |
Raised when a user leaves a MeetMe conference. | 12.0.0 |
| MeetmeList | MeetmeList |
Raised in response to a MeetmeList command. | 16.29.0, 18.15.0, 19.7.0 |
| MeetmeListRooms | MeetmeListRooms |
Raised in response to a MeetmeListRooms command. | 16.29.0, 18.15.0, 19.7.0 |
| MeetmeMute | MeetmeMute |
Raised when a MeetMe user is muted or unmuted. | 12.0.0 |
| MeetmeTalkRequest | MeetmeTalkRequest |
Raised when a MeetMe user has started talking. | 12.0.0 |
| MeetmeTalking | MeetmeTalking |
Raised when a MeetMe user begins or ends talking. | 12.0.0 |
| MemoryLimit | MemoryLimit |
Raised when a request fails due to an internal memory allocation failure. | 12.1.0 |
| MessageWaiting | MessageWaiting |
Raised when the state of messages in a voicemail mailbox has changed or when a channel has finished interacting with a m... | 16.24.0, 18.10.0, 19.2.0 |
| MiniVoiceMail | MiniVoiceMail |
Raised when a notification is sent out by a MiniVoiceMail application | 12.0.0 |
| MixMonitorMute | MixMonitorMute |
Raised when monitoring is muted or unmuted on a channel. | 16.17.0, 18.3.0 |
| MixMonitorStart | MixMonitorStart |
Raised when monitoring has started on a channel. | 16.17.0, 18.3.0 |
| MixMonitorStop | MixMonitorStop |
Raised when monitoring has stopped on a channel. | 16.17.0, 18.3.0 |
| MonitorStart | Event: MonitorStart |
Raised when monitoring has started on a channel. | N/A |
| MonitorStop | Event: MonitorStop |
Raised when monitoring has stopped on a channel. | N/A |
| MusicOnHoldStart | MusicOnHoldStart |
Raised when music on hold has started on a channel. | 12.0.0 |
| MusicOnHoldStop | MusicOnHoldStop |
Raised when music on hold has stopped on a channel. | 12.0.0 |
| NewAccountCode | NewAccountCode |
Raised when a Channel's AccountCode is changed. | 12.0.0 |
| NewCallerid | NewCallerid |
Raised when a channel receives new Caller ID information. | 12.0.0 |
| NewConnectedLine | NewConnectedLine |
Raised when a channel's connected line information is changed. | 13.13.0, 14.2.0 |
| NewExten | NewExten |
Raised when a channel enters a new context, extension, priority. | 12.0.0 |
| Newchannel | Newchannel |
Raised when a new channel is created. | 12.0.0 |
| Newstate | Newstate |
Raised when a channel's state changes. | 12.0.0 |
| OriginateResponse | OriginateResponse |
Raised in response to an Originate command. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| OutboundRegistrationDetail | OutboundRegistrationDetail |
Provides configuration details and status information about an outbound registration. | 12.0.0 |
| OutboundSubscriptionDetail | OutboundSubscriptionDetail |
Provides details about an outbound subscription - one in which Asterisk sends SUBSCRIBE requests and periodically receiv... | 12.0.0 |
| ParkedCall | ParkedCall |
Raised when a channel is parked. | 12.0.0 |
| ParkedCallGiveUp | ParkedCallGiveUp |
Raised when a channel leaves a parking lot because it hung up without being answered. | 12.0.0 |
| ParkedCallSwap | ParkedCallSwap |
Raised when a channel takes the place of a previously parked channel | 13.5.0 |
| ParkedCallTimeOut | ParkedCallTimeOut |
Raised when a channel leaves a parking lot due to reaching the time limit of being parked. | 12.0.0 |
| PeerStatus | PeerStatus |
Raised when the state of a peer changes. | 12.0.0 |
| Pickup | Pickup |
Raised when a call pickup occurs. | 12.0.0 |
| PresenceStateChange | PresenceStateChange |
Raised when a presence state changes | 13.0.0 |
| PresenceStateListComplete | PresenceStateListComplete |
Indicates the end of the list the current known extension states. | 13.0.0 |
| PresenceStatus | PresenceStatus |
Raised when a hint changes due to a presence state change. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| QueueCallerAbandon | QueueCallerAbandon |
Raised when a caller abandons the queue. | 12.0.0 |
| QueueCallerJoin | QueueCallerJoin |
Raised when a caller joins a Queue. | 12.0.0 |
| QueueCallerLeave | QueueCallerLeave |
Raised when a caller leaves a Queue. | 12.0.0 |
| QueueEntry | QueueEntry |
Raised in response to the QueueStatus action. | 16.24.0, 18.10.0, 19.2.0 |
| QueueMemberAdded | QueueMemberAdded |
Raised when a member is added to the queue. | 12.0.0 |
| QueueMemberPause | QueueMemberPause |
Raised when a member is paused/unpaused in the queue. | 12.2.0 |
| QueueMemberPenalty | QueueMemberPenalty |
Raised when a member's penalty is changed. | 12.0.0 |
| QueueMemberRemoved | QueueMemberRemoved |
Raised when a member is removed from the queue. | 12.0.0 |
| QueueMemberRinginuse | QueueMemberRinginuse |
Raised when a member's ringinuse setting is changed. | 12.0.0 |
| QueueMemberStatus | QueueMemberStatus |
Raised when a Queue member's status has changed. | 12.0.0 |
| QueueParams | QueueParams |
Raised in response to the QueueStatus action. | 16.24.0, 18.10.0, 19.2.0 |
| RTCPReceived | RTCPReceived |
Raised when an RTCP packet is received. | 12.0.0 |
| RTCPSent | RTCPSent |
Raised when an RTCP packet is sent. | 12.0.0 |
| ReceiveFAX | ReceiveFAX |
Raised when a receive fax operation has completed. | 12.0.0 |
| Registry | Registry |
Raised when an outbound registration completes. | 12.0.0 |
| Reload | Reload |
Raised when a module has been reloaded in Asterisk. | 12.0.0 |
| Rename | Rename |
Raised when the name of a channel is changed. | 16.24.0, 18.10.0, 19.2.0 |
| RequestBadFormat | RequestBadFormat |
Raised when a request is received with bad formatting. | 12.1.0 |
| RequestNotAllowed | RequestNotAllowed |
Raised when a request is not allowed by the service. | 12.1.0 |
| RequestNotSupported | RequestNotSupported |
Raised when a request fails due to some aspect of the requested item not being supported by the service. | 12.1.0 |
| ResourceListDetail | ResourceListDetail |
Provides details about a resource list. | 13.0.0 |
| SIPQualifyPeerDone | Event: SIPQualifyPeerDone |
Raised when SIPQualifyPeer has finished qualifying the specified peer. | N/A |
| SendFAX | SendFAX |
Raised when a send fax operation has completed. | 12.0.0 |
| SessionLimit | SessionLimit |
Raised when a request fails due to exceeding the number of allowed concurrent sessions for that service. | 12.1.0 |
| SessionTimeout | Event: SessionTimeout |
Raised when a SIP session times out. | N/A |
| Shutdown | Shutdown |
Raised when Asterisk is shutdown or restarted. | 12.0.0 |
| SoftHangupRequest | SoftHangupRequest |
Raised when a soft hangup is requested with a specific cause code. | 12.0.0 |
| SpanAlarm | SpanAlarm |
Raised when an alarm is set on a DAHDI span. | 12.0.0 |
| SpanAlarmClear | SpanAlarmClear |
Raised when an alarm is cleared on a DAHDI span. | 12.0.0 |
| Status | Status |
Raised in response to a Status command. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| StatusComplete | StatusComplete |
Raised in response to a Status command. | 18.26.0, 20.11.0, 21.6.0, 22.1.0 |
| SuccessfulAuth | SuccessfulAuth |
Raised when a request successfully authenticates with a service. | 12.1.0 |
| TransportDetail | TransportDetail |
Provide details about an authentication section. | 12.6.0 |
| UnParkedCall | UnParkedCall |
Raised when a channel leaves a parking lot because it was retrieved from the parking lot and reconnected. | 12.0.0 |
| UnexpectedAddress | UnexpectedAddress |
Raised when a request has a different source address then what is expected for a session already in progress with a serv... | 12.1.0 |
| Unhold | Unhold |
Raised when a channel goes off hold. | 12.0.0 |
| Unload | Unload |
Raised when a module has been unloaded in Asterisk. | 16.0.0 |
| UserEvent | UserEvent |
A user defined event raised from the dialplan. | 12.3.0 |
| VarSet | VarSet |
Raised when a variable local to the gosub stack frame is set due to a subroutine call. | 12.0.0 |
| VoicemailPasswordChange | VoicemailPasswordChange |
Raised in response to a mailbox password change. | 18.21.0, 20.6.0, 21.1.0 |
| Wink | Wink |
Raised when a wink occurs on a channel. | 16.24.0, 18.10.0, 19.2.0 |