Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

AMI Reference

Events (181 typed variants)

VariantDescription
NewChannelnew channel created
Hangupchannel hung up
Newstatechannel state changed
DialBegindial begin
DialEnddial end
DtmfBeginDTMF digit received
DtmfEndDTMF digit ended
FullyBootedasterisk has finished booting
PeerStatuspeer registration/status change
BridgeCreatebridge created
BridgeDestroybridge destroyed
BridgeEnterchannel entered bridge
BridgeLeavechannel left bridge
VarSetchannel variable set
Holdchannel placed on hold
Unholdchannel taken off hold
HangupRequesthangup requested
SoftHangupRequestsoft hangup requested
NewExtenchannel entered new dialplan extension
NewCalleridcaller id changed
NewConnectedLineconnected line info changed
NewAccountCodeaccount code changed
Renamechannel renamed
OriginateResponseoriginate result
DialStatedial state changed
Flashflash hook detected
Winkwink detected
UserEventuser-defined event
AttendedTransferattended transfer completed
BlindTransferblind transfer completed
BridgeMergetwo bridges merged
BridgeInfoChannelchannel info in bridge listing
BridgeInfoCompletebridge info listing complete
BridgeVideoSourceUpdatebridge video source changed
LocalBridgelocal channel bridged
LocalOptimizationBeginlocal optimization started
LocalOptimizationEndlocal optimization ended
Cdrcall detail record
Celchannel event logging
QueueCallerAbandoncaller abandoned queue
QueueCallerJoincaller joined queue
QueueCallerLeavecaller left queue
QueueMemberAddedmember added to queue
QueueMemberRemovedmember removed from queue
QueueMemberPausemember paused/unpaused
QueueMemberStatusmember status changed
QueueMemberPenaltymember penalty changed
QueueMemberRinginusemember ringinuse changed
QueueParamsqueue parameters
QueueEntryqueue entry
AgentCalledagent called from queue
AgentConnectagent connected
AgentCompleteagent completed call
AgentDumpagent dumped call
AgentLoginagent logged in
AgentLogoffagent logged off
AgentRingNoAnsweragent did not answer
Agentsagent list entry
AgentsCompleteagent list complete
ConfbridgeStartconfbridge started
ConfbridgeEndconfbridge ended
ConfbridgeJoinuser joined confbridge
ConfbridgeLeaveuser left confbridge
ConfbridgeListconfbridge list entry
ConfbridgeMuteconfbridge user muted
ConfbridgeUnmuteconfbridge user unmuted
ConfbridgeTalkingconfbridge talking status changed
ConfbridgeRecordconfbridge recording started
ConfbridgeStopRecordconfbridge recording stopped
ConfbridgeListRoomsconfbridge room list entry
MixMonitorStartmixmonitor started
MixMonitorStopmixmonitor stopped
MixMonitorMutemixmonitor mute state changed
MusicOnHoldStartmusic on hold started
MusicOnHoldStopmusic on hold stopped
ParkedCallcall parked
ParkedCallGiveUpparked caller gave up
ParkedCallTimeOutparked call timed out
ParkedCallSwapparked call swapped
UnParkedCallparked call retrieved
Pickupcall pickup
ChanSpyStartchannel spy started
ChanSpyStopchannel spy stopped
ChannelTalkingStartchannel started talking
ChannelTalkingStopchannel stopped talking
DeviceStateChangedevice state changed
ExtensionStatusextension status changed
PresenceStateChangepresence state changed
PresenceStatuspresence status
ContactStatuscontact status changed
Registryregistration status
MessageWaitingmessage waiting indication
VoicemailPasswordChangevoicemail password changed
RTCPReceivedrtcp packet received
RTCPSentrtcp packet sent
FailedACLacl check failed
InvalidAccountIDinvalid account id
InvalidPasswordinvalid password
ChallengeResponseFailedchallenge-response failed
ChallengeSentchallenge sent
SuccessfulAuthauthentication succeeded
SessionLimitsession limit reached
UnexpectedAddressunexpected source address
RequestBadFormatbad request format
RequestNotAllowedrequest not allowed
RequestNotSupportedrequest not supported
InvalidTransportinvalid transport
AuthMethodNotAllowedauth method not allowed
Shutdownasterisk shutting down
Reloadmodule reloaded
Loadmodule loaded
Unloadmodule unloaded
LogChannellog channel toggled
LoadAverageLimitload average exceeded limit
MemoryLimitmemory usage exceeded limit
AsyncAGIStartasync agi session started
AsyncAGIExecasync agi command executed
AsyncAGIEndasync agi session ended
AGIExecStartagi command execution started
AGIExecEndagi command execution ended
HangupHandlerPushhangup handler pushed
HangupHandlerPophangup handler popped
HangupHandlerRunhangup handler running
Statuschannel status entry
StatusCompletestatus listing complete
CoreShowChannelcore show channel entry
CoreShowChannelsCompletecore show channels complete
CoreShowChannelMapCompletecore show channel map complete
DAHDIChanneldahdi channel info
Alarmdahdi alarm
AlarmCleardahdi alarm cleared
SpanAlarmdahdi span alarm
SpanAlarmCleardahdi span alarm cleared
AocDadvice of charge — during call
AocEadvice of charge — end of call
AocSadvice of charge — setup
FAXStatusfax status update
ReceiveFAXfax received
SendFAXfax sent
MeetmeJoinmeetme user joined
MeetmeLeavemeetme user left
MeetmeEndmeetme conference ended
MeetmeMutemeetme user muted/unmuted
MeetmeTalkingmeetme user talking
MeetmeTalkRequestmeetme talk request
MeetmeListmeetme list entry
MeetmeListRoomsmeetme room list entry
DeviceStateListCompletedevice state list complete
ExtensionStateListCompleteextension state list complete
PresenceStateListCompletepresence state list complete
AorDetailaor detail
AorListaor list entry
AorListCompleteaor list complete
AuthDetailauth detail
AuthListauth list entry
AuthListCompleteauth list complete
ContactListcontact list entry
ContactListCompletecontact list complete
ContactStatusDetailcontact status detail
EndpointDetailendpoint detail
EndpointDetailCompleteendpoint detail complete
EndpointListendpoint list entry
EndpointListCompleteendpoint list complete
IdentifyDetailidentify detail
TransportDetailtransport detail
ResourceListDetailresource list detail
InboundRegistrationDetailinbound registration detail
OutboundRegistrationDetailoutbound registration detail
InboundSubscriptionDetailinbound subscription detail
OutboundSubscriptionDetailoutbound subscription detail
MWIGetmwi get response
MWIGetCompletemwi get complete
MiniVoiceMailminivm voicemail notification
FAXSessionfax session info
FAXSessionsEntryfax sessions list entry
FAXSessionsCompletefax sessions list complete
FAXStatsfax statistics
DNDStatedo not disturb state changed
DeadlockStartdeadlock detected
MCIDmalicious call id
Unknownunrecognized event — carries all raw headers

Actions (150 typed structs)

ActionDescription
LogoffActionlogoff from AMI
PingActionping the server (keep-alive)
OriginateActionoriginate a call
HangupActionhangup a channel
RedirectActionredirect (transfer) a channel
CommandActionexecute a CLI command
GetVarActionget a channel variable
SetVarActionset a channel variable
StatusActionquery channel status
CoreStatusActionquery core system status
CoreSettingsActionquery core settings
CoreShowChannelsActionlist active channels
CoreShowChannelMapActionshow channel map for a given channel
ListCommandsActionlist available AMI commands
EventsActioncontrol event output
FilterActionmanage event filters
WaitEventActionwait for an event to occur
ReloadActionreload asterisk modules
LoggerRotateActionrotate logger files
ModuleCheckActioncheck if a module is loaded
ModuleLoadActionload, unload, or reload a module
UserEventActionsend a user-defined event
AbsoluteTimeoutActionset absolute timeout on a channel
MuteAudioActionmute or unmute audio on a channel
SendTextActionsend text to a channel
PlayDTMFActionplay a DTMF digit on a channel
AGIActionexecute an AGI command on a channel
DBGetActionget a value from the asterisk database
DBPutActionput a value into the asterisk database
DBDelActiondelete a key from the asterisk database
DBDelTreeActiondelete a family or subtree from the asterisk database
DBGetTreeActionget a tree of values from the asterisk database
AtxferActionattended transfer a channel
BlindTransferActionblind transfer a channel
CancelAtxferActioncancel an attended transfer
BridgeActionbridge two channels together
BridgeDestroyActiondestroy a bridge
BridgeInfoActionget information about a bridge
BridgeKickActionkick a channel from a bridge
BridgeListActionlist active bridges
QueueAddActionadd a member to a queue
QueueRemoveActionremove a member from a queue
QueuePauseActionpause or unpause a queue member
QueuePenaltyActionset penalty for a queue member
QueueStatusActionquery queue status
QueueSummaryActionquery queue summary
QueueReloadActionreload queue configuration
QueueResetActionreset queue statistics
QueueLogActionadd a custom entry to the queue log
MixMonitorActionstart recording a channel with mixmonitor
MixMonitorMuteActionmute or unmute a mixmonitor recording
StopMixMonitorActionstop recording a channel with mixmonitor
ControlPlaybackActioncontrol playback on a channel
ConfbridgeListActionlist participants in a conference
ConfbridgeListRoomsActionlist active conference rooms
ConfbridgeKickActionkick a participant from a conference
ConfbridgeMuteActionmute a participant in a conference
ConfbridgeUnmuteActionunmute a participant in a conference
ConfbridgeLockActionlock a conference
ConfbridgeUnlockActionunlock a conference
ConfbridgeStartRecordActionstart recording a conference
ConfbridgeStopRecordActionstop recording a conference
ParkActionpark a channel
ParkedCallsActionlist parked calls
ParkinglotsActionlist parking lots
GetConfigActionretrieve configuration file
GetConfigJSONActionretrieve configuration as JSON
UpdateConfigActionupdate a configuration file
CreateConfigActioncreate an empty configuration file
ListCategoriesActionlist categories in a configuration file
ShowDialPlanActionshow dialplan
PJSIPShowEndpointsActionlist all pjsip endpoints
PJSIPShowEndpointActionshow details for a pjsip endpoint
PJSIPQualifyActionqualify a pjsip endpoint
PJSIPRegisterActionregister a pjsip outbound registration
PJSIPUnregisterActionunregister a pjsip outbound registration
PJSIPShowRegistrationsInboundActionlist inbound pjsip registrations
PJSIPShowRegistrationsOutboundActionlist outbound pjsip registrations
PJSIPShowContactsActionlist pjsip contacts
PJSIPShowAorsActionlist pjsip address of records
PJSIPShowAuthsActionlist pjsip authentication objects
PJSIPNotifyActionsend a notify to a pjsip endpoint
PJSIPHangupActionhangup a pjsip channel
ExtensionStateActionquery extension state
ExtensionStateListActionlist all extension states
DeviceStateListActionlist all device states
PresenceStateActionquery presence state for a provider
PresenceStateListActionlist all presence states
DialplanExtensionAddActionadd an extension to the dialplan
DialplanExtensionRemoveActionremove an extension from the dialplan
LocalOptimizeAwayActionrequest local channel optimization
MailboxCountActionget mailbox message count
MailboxStatusActionget mailbox status
MWIGetActionget message waiting indicator state
MWIUpdateActionupdate message waiting indicator
MWIDeleteActiondelete message waiting indicator
MessageSendActionsend a text message
VoicemailUsersListActionlist voicemail users
VoicemailUserStatusActionget voicemail user status
VoicemailRefreshActionrefresh voicemail state
VoicemailBoxSummaryActionget voicemail box summary
MeetmeListActionlist meetme conference participants
MeetmeListRoomsActionlist active meetme rooms
MeetmeMuteActionmute a meetme participant
MeetmeUnmuteActionunmute a meetme participant
AgentLogoffActionlog off an agent
AgentsActionlist agents
FAXSessionActionget info about a fax session
FAXSessionsActionlist active fax sessions
FAXStatsActionget fax statistics
AOCMessageActionsend an advice of charge message
SendFlashActionsend a flash signal on a channel
PlayMFActionplay an MF digit on a channel
DAHDIDNDoffActiondisable do not disturb on a DAHDI channel
DAHDIDNDonActionenable do not disturb on a DAHDI channel
DAHDIDialOffhookActiondial a number on a DAHDI channel that is off hook
DAHDIHangupActionhangup a DAHDI channel
DAHDIRestartActionrestart the DAHDI channels
DAHDIShowChannelsActionshow DAHDI channel information
DAHDIShowStatusActionshow DAHDI status
DAHDITransferActiontransfer a DAHDI channel
IAXnetstatsActionshow IAX2 network statistics
IAXpeerlistActionlist IAX2 peers
IAXpeersActionlist IAX2 peers (compact)
IAXregistryActionlist IAX2 registrations
PRIDebugFileSetActionset the PRI debug log file
PRIDebugFileUnsetActionunset the PRI debug log file
PRIDebugSetActionset the PRI debug level for a span
PRIShowSpansActionshow PRI spans
BridgeTechnologyListActionlist available bridge technologies
BridgeTechnologySuspendActionsuspend a bridge technology
BridgeTechnologyUnsuspendActionunsuspend a bridge technology
PJSIPShowRegistrationInboundContactStatusesActionshow PJSIP inbound registration contact statuses
PJSIPShowResourceListsActionshow PJSIP resource lists
PJSIPShowSubscriptionsInboundActionshow PJSIP inbound subscriptions
PJSIPShowSubscriptionsOutboundActionshow PJSIP outbound subscriptions
QueueChangePriorityCallerActionchange priority of a caller in a queue
QueueMemberRingInUseActionset ring in use for a queue member
QueueRuleActionshow a queue rule
QueueWithdrawCallerActionwithdraw a caller from a queue
SorceryMemoryCacheExpireActionexpire all objects in a sorcery memory cache
SorceryMemoryCacheExpireObjectActionexpire a specific object in a sorcery memory cache
SorceryMemoryCachePopulateActionpopulate a sorcery memory cache
SorceryMemoryCacheStaleActionmark all objects in a sorcery memory cache as stale
SorceryMemoryCacheStaleObjectActionmark a specific object in a sorcery memory cache as stale
VoicemailForwardActionforward a voicemail message
VoicemailMoveActionmove a voicemail message
VoicemailRemoveActionremove a voicemail message
ConfbridgeSetSingleVideoSrcActionset the single video source in a conference bridge
JabberSendActionsend a jabber (XMPP) message