Asterisk Reference
Searchable reference for Asterisk dialplan applications, functions, AGI commands, and AMI actions/events. Sourced directly from Asterisk source XML, with syntax, arguments, and usage notes for every entry.
Popular reference groups
Applications
226
View all
Dialplan applications are the actions executed at each priority in the dialplan.
ADSIProg()
AELSub()
AGI()
AMD()
AddQueueMember()
AgentLogin()
AgentRequest()
AlarmReceiver()
Answer()
AttendedTransfer()
AudioSocket()
Authenticate()
Background()
BackgroundDetect()
BlindTransfer()
Bridge()
BridgeAdd()
BridgeWait()
Broadcast()
Busy()
CELGenUserEvent()
CallCompletionCancel()
CallCompletionRequest()
ChanIsAvail()
ChanSpy()
ChangeMonitor()
ChannelRedirect()
ClearHash()
ConfBridge()
ConfKick()
Congestion()
ContinueWhile()
ControlPlayback()
DAHDIAcceptR2Call()
DAHDIRAS()
DAHDIScan()
DAHDISendCallreroutingFacility()
DAHDISendKeypadFacility()
DBdeltree()
DISA()
DateTime()
DeadAGI()
Dial()
Dictate()
Directory()
DumpChan()
EAGI()
Echo()
Else()
ElseIf()
EndIf()
EndWhile()
Exec()
ExecIf()
ExecIfTime()
ExitIf()
ExitWhile()
ExtenSpy()
ExternalIVR()
Festival()
Flash()
FollowMe()
ForkCDR()
GetCPEID()
Gosub()
GosubIf()
Goto()
GotoIf()
GotoIfTime()
Hangup()
HangupCauseClear()
IAX2Provision()
ICES()
IVRDemo()
If()
ImportVar()
Incomplete()
JACK()
JabberJoin()
JabberLeave()
JabberSend()
JabberSendGroup()
JabberStatus()
Log()
MP3Player()
MSet()
Macro()
MacroExclusive()
MacroExit()
MacroIf()
MailboxExists()
MeetMe()
MeetMeAdmin()
MeetMeChannelAdmin()
MeetMeCount()
MessageSend()
Milliwatt()
MinivmAccMess()
MinivmDelete()
MinivmGreet()
MinivmMWI()
MinivmNotify()
MinivmRecord()
MixMonitor()
Monitor()
Morsecode()
MusicOnHold()
NBScat()
NoCDR()
NoOp()
ODBCFinish()
ODBC_Commit()
ODBC_Rollback()
OSPAuth()
OSPFinish()
OSPLookup()
OSPNext()
Originate()
PJSIPHangup()
PJSIPNotify()
Page()
Park()
ParkAndAnnounce()
ParkedCall()
PauseMonitor()
PauseQueueMember()
Pickup()
PickupChan()
PlayTones()
Playback()
PrivacyManager()
Proceeding()
Progress()
Queue()
QueueLog()
QueueUpdate()
RaiseException()
Read()
ReadExten()
ReceiveFAX()
ReceiveMF()
ReceiveSF()
ReceiveText()
Record()
Reload()
RemoveQueueMember()
ResetCDR()
RetryDial()
Return()
Ringing()
SIPAddHeader()
SIPDtmfMode()
SIPRemoveHeader()
SIPSendCustomINFO()
SLAStation()
SLATrunk()
SMS()
SayAlpha()
SayAlphaCase()
SayCountedAdj()
SayCountedNoun()
SayDigits()
SayMoney()
SayNumber()
SayOrdinal()
SayPhonetic()
SayUnixTime()
SendDTMF()
SendFAX()
SendImage()
SendMF()
SendSF()
SendText()
SendURL()
Set()
SetAMAFlags()
Signal()
SkelGuessNumber()
SoftHangup()
SpeechActivateGrammar()
SpeechBackground()
SpeechCreate()
SpeechDeactivateGrammar()
SpeechDestroy()
SpeechLoadGrammar()
SpeechProcessingSound()
SpeechStart()
SpeechUnloadGrammar()
StackPop()
StartMusicOnHold()
Stasis()
StatsD()
StopMixMonitor()
StopMonitor()
StopMusicOnHold()
StopPlayTones()
StoreDTMF()
StreamEcho()
System()
TestClient()
TestServer()
ToneScan()
Transfer()
TryExec()
TrySystem()
UnpauseMonitor()
UnpauseQueueMember()
UserEvent()
VMAuthenticate()
VMSayName()
Verbose()
VoiceMail()
VoiceMailMain()
VoiceMailPlayMsg()
Wait()
WaitDigit()
WaitExten()
WaitForCondition()
WaitForNoise()
WaitForRing()
WaitForSignal()
WaitForSilence()
WaitForTone()
WaitUntil()
While()
Zapateller()
Functions
224
View all
Dialplan functions return or set values and are used inside expressions, Set(), and GotoIf() conditions.
ABS()
AES_DECRYPT()
AES_ENCRYPT()
AGC()
AGENT()
AMI_CLIENT()
ARRAY()
AST_CONFIG()
AST_SORCERY()
BASE64_DECODE()
BASE64_ENCODE()
BASENAME()
BLACKLIST()
CALENDAR_BUSY()
CALENDAR_EVENT()
CALENDAR_QUERY()
CALENDAR_QUERY_RESULT()
CALENDAR_WRITE()
CALLCOMPLETION()
CALLERID()
CALLERPRES()
CDR()
CDR_PROP()
CHANNEL()
CHANNELS()
CHANNEL_EXISTS()
CHECKSIPDOMAIN()
CONFBRIDGE()
CONFBRIDGE_CHANNELS()
CONFBRIDGE_INFO()
CONNECTEDLINE()
CSV_QUOTE()
CURL()
CURLOPT()
CUT()
DAHDI_CHANNEL()
DB()
DB_DELETE()
DB_EXISTS()
DB_KEYCOUNT()
DB_KEYS()
DEC()
DELETE()
DENOISE()
DEVICE_STATE()
DIALGROUP()
DIALPLAN_EXISTS()
DIGIT_SUM()
DIRNAME()
DUNDILOOKUP()
DUNDIQUERY()
DUNDIRESULT()
ENUMLOOKUP()
ENUMQUERY()
ENUMRESULT()
ENV()
EVAL()
EVAL_EXTEN()
EVAL_SUB()
EXCEPTION()
EXISTS()
EXPORT()
EXTENSION_STATE()
FAXOPT()
FEATURE()
FEATUREMAP()
FIELDNUM()
FIELDQTY()
FILE()
FILE_COUNT_LINE()
FILE_FORMAT()
FILTER()
FRAME_DROP()
FRAME_TRACE()
GEOLOC_PROFILE()
GLOBAL()
GLOBAL_DELETE()
GLOBAL_EXISTS()
GROUP()
GROUP_COUNT()
GROUP_LIST()
GROUP_MATCH_COUNT()
HANGUPCAUSE()
HANGUPCAUSE_KEYS()
HASH()
HASHKEYS()
HINT()
HOLD_INTERCEPT()
IAXPEER()
IAXVAR()
ICONV()
IF()
IFMODULE()
IFTIME()
IMPORT()
INC()
ISNULL()
JABBER_RECEIVE()
JABBER_STATUS()
JITTERBUFFER()
JSON_DECODE()
KEYPADHASH()
LEN()
LISTFILTER()
LOCAL()
LOCAL_PEEK()
LOCK()
LOG_GROUP()
LTRIM()
MAILBOX_EXISTS()
MASTER_CHANNEL()
MATH()
MAX()
MD5()
MEETME_INFO()
MESSAGE()
MESSAGE_DATA()
MIN()
MINIVMACCOUNT()
MINIVMCOUNTER()
MIXMONITOR()
MUTEAUDIO()
ODBC()
ODBC_FETCH()
PARK_GET_CHANNEL()
PASSTHRU()
PERIODIC_HOOK()
PITCH_SHIFT()
PJSIP_AOR()
PJSIP_CONTACT()
PJSIP_DIAL_CONTACTS()
PJSIP_DTMF_MODE()
PJSIP_ENDPOINT()
PJSIP_HEADER()
PJSIP_HEADERS()
PJSIP_HEADER_PARAM()
PJSIP_INHERITABLE_HEADER()
PJSIP_MEDIA_OFFER()
PJSIP_MOH_PASSTHROUGH()
PJSIP_PARSE_URI()
PJSIP_PARSE_URI_FROM()
PJSIP_RESPONSE_HEADER()
PJSIP_RESPONSE_HEADERS()
PJSIP_SEND_SESSION_REFRESH()
PJSIP_TRANSFER_HANDLING()
POLARITY()
POP()
PP_EACH_EXTENSION()
PP_EACH_USER()
PRESENCE_STATE()
PUSH()
QUEUE_EXISTS()
QUEUE_GET_CHANNEL()
QUEUE_MEMBER()
QUEUE_MEMBER_COUNT()
QUEUE_MEMBER_LIST()
QUEUE_MEMBER_PENALTY()
QUEUE_VARIABLES()
QUEUE_WAITING_COUNT()
QUOTE()
RAND()
REALTIME()
REALTIME_DESTROY()
REALTIME_FIELD()
REALTIME_HASH()
REALTIME_STORE()
RECORDING_INFO()
REDIRECTING()
REGEX()
REPLACE()
RTRIM()
SAYFILES()
SCRAMBLE()
SET()
SHA1()
SHARED()
SHELL()
SHIFT()
SIPPEER()
SIP_HEADER()
SIP_HEADERS()
SMDI_MSG()
SMDI_MSG_RETRIEVE()
SORT()
SPEECH()
SPEECH_ENGINE()
SPEECH_GRAMMAR()
SPEECH_RESULTS_TYPE()
SPEECH_SCORE()
SPEECH_TEXT()
SPRINTF()
SQL_ESC()
SQL_ESC_BACKSLASHES()
SRVQUERY()
SRVRESULT()
STACK_PEEK()
STAT()
STIR_SHAKEN()
STIR_SHAKEN_ATTESTATION()
STRBETWEEN()
STRFTIME()
STRPTIME()
STRREPLACE()
SYSINFO()
TALK_DETECT()
TESTTIME()
TIMEOUT()
TOLOWER()
TONE_DETECT()
TOUPPER()
TRIM()
TRYLOCK()
TXTCIDNAME()
UNLOCK()
UNSHIFT()
URIDECODE()
URIENCODE()
UUID()
VALID_EXTEN()
VARIABLE_EXISTS()
VERSION()
VMCOUNT()
VM_INFO()
VOLUME()
CLI Commands
1
View all
Quick reference for commonly used Asterisk CLI commands.
AGI Commands
47
View all
Asterisk Gateway Interface commands for external call control programs.
ANSWER
ASYNCAGI BREAK
CHANNEL STATUS
CONTROL STREAM FILE
DATABASE DEL
DATABASE DELTREE
DATABASE GET
DATABASE PUT
EXEC
GET DATA
GET FULL VARIABLE
GET OPTION
GET VARIABLE
GOSUB
HANGUP
NOOP
RECEIVE CHAR
RECEIVE TEXT
RECORD FILE
SAY ALPHA
SAY DATE
SAY DATETIME
SAY DIGITS
SAY NUMBER
SAY PHONETIC
SAY TIME
SEND IMAGE
SEND TEXT
SET AUTOHANGUP
SET CALLERID
SET CONTEXT
SET EXTENSION
SET MUSIC
SET PRIORITY
SET VARIABLE
SPEECH ACTIVATE GRAMMAR
SPEECH CREATE
SPEECH DEACTIVATE GRAMMAR
SPEECH DESTROY
SPEECH LOAD GRAMMAR
SPEECH RECOGNIZE
SPEECH SET
SPEECH UNLOAD GRAMMAR
STREAM FILE
TDD MODE
VERBOSE
WAIT FOR DIGIT
AMI Actions
167
View all
Asterisk Manager Interface actions for remote system control.
AGI
AOCMessage
AbsoluteTimeout
AgentLogoff
Agents
Atxfer
BlindTransfer
Bridge
BridgeDestroy
BridgeInfo
BridgeKick
BridgeList
BridgeTechnologyList
BridgeTechnologySuspend
BridgeTechnologyUnsuspend
CancelAtxfer
Challenge
ChangeMonitor
Command
ConfbridgeKick
ConfbridgeList
ConfbridgeListRooms
ConfbridgeLock
ConfbridgeMute
ConfbridgeSetSingleVideoSrc
ConfbridgeStartRecord
ConfbridgeStopRecord
ConfbridgeUnlock
ConfbridgeUnmute
ControlPlayback
CoreSettings
CoreShowChannelMap
CoreShowChannels
CoreStatus
CreateConfig
DAHDIDNDoff
DAHDIDNDon
DAHDIDialOffhook
DAHDIHangup
DAHDIRestart
DAHDIShowChannels
DAHDIShowStatus
DAHDITransfer
DBDel
DBDelTree
DBGet
DBGetTree
DBPut
DeviceStateList
DialplanExtensionAdd
DialplanExtensionRemove
Events
ExtensionState
ExtensionStateList
FAXSession
FAXSessions
FAXStats
Filter
GetConfig
GetConfigJSON
Getvar
Hangup
IAXnetstats
IAXpeerlist
IAXpeers
IAXregistry
JabberSend
ListCategories
ListCommands
LocalOptimizeAway
LoggerRotate
Login
Logoff
MWIDelete
MWIGet
MWIUpdate
MailboxCount
MailboxStatus
MeetmeList
MeetmeListRooms
MeetmeMute
MeetmeUnmute
MessageSend
MixMonitor
MixMonitorMute
ModuleCheck
ModuleLoad
Monitor
MuteAudio
Originate
PJSIPHangup
PJSIPNotify
PJSIPQualify
PJSIPRegister
PJSIPShowAors
PJSIPShowAuths
PJSIPShowContacts
PJSIPShowEndpoint
PJSIPShowEndpoints
PJSIPShowRegistrationInboundContactStatuses
PJSIPShowRegistrationsInbound
PJSIPShowRegistrationsOutbound
PJSIPShowResourceLists
PJSIPShowSubscriptionsInbound
PJSIPShowSubscriptionsOutbound
PJSIPUnregister
PRIDebugFileSet
PRIDebugFileUnset
PRIDebugSet
PRIShowSpans
Park
ParkedCalls
Parkinglots
PauseMonitor
Ping
PlayDTMF
PlayMF
PresenceState
PresenceStateList
QueueAdd
QueueChangePriorityCaller
QueueLog
QueueMemberRingInUse
QueuePause
QueuePenalty
QueueReload
QueueRemove
QueueReset
QueueRule
QueueStatus
QueueSummary
QueueWithdrawCaller
Redirect
Reload
SIPnotify
SIPpeers
SIPpeerstatus
SIPqualifypeer
SIPshowpeer
SIPshowregistry
SKINNYdevices
SKINNYlines
SKINNYshowdevice
SKINNYshowline
SendFlash
SendText
Setvar
ShowDialPlan
SorceryMemoryCacheExpire
SorceryMemoryCacheExpireObject
SorceryMemoryCachePopulate
SorceryMemoryCacheStale
SorceryMemoryCacheStaleObject
Status
StopMixMonitor
StopMonitor
UnpauseMonitor
UpdateConfig
UserEvent
VoicemailBoxSummary
VoicemailForward
VoicemailMove
VoicemailRefresh
VoicemailRemove
VoicemailUserStatus
VoicemailUsersList
WaitEvent
AMI Events
184
View all
Asterisk Manager Interface events for real-time system monitoring.
AGIExecEnd
AGIExecStart
AOC-D
AOC-E
AOC-S
AgentCalled
AgentComplete
AgentConnect
AgentDump
AgentLogin
AgentLogoff
AgentRingNoAnswer
Agents
AgentsComplete
Alarm
AlarmClear
AorDetail
AorList
AorListComplete
AsyncAGIEnd
AsyncAGIExec
AsyncAGIStart
AttendedTransfer
AuthDetail
AuthList
AuthListComplete
AuthMethodNotAllowed
BlindTransfer
BridgeCreate
BridgeDestroy
BridgeEnter
BridgeInfoChannel
BridgeInfoComplete
BridgeLeave
BridgeMerge
BridgeVideoSourceUpdate
CEL
Cdr
ChallengeResponseFailed
ChallengeSent
ChanSpyStart
ChanSpyStop
ChannelTalkingStart
ChannelTalkingStop
ConfbridgeEnd
ConfbridgeJoin
ConfbridgeLeave
ConfbridgeList
ConfbridgeListRooms
ConfbridgeMute
ConfbridgeRecord
ConfbridgeStart
ConfbridgeStopRecord
ConfbridgeTalking
ConfbridgeUnmute
ContactList
ContactListComplete
ContactStatus
ContactStatusDetail
CoreShowChannel
CoreShowChannelMapComplete
CoreShowChannelsComplete
DAHDIChannel
DNDState
DTMFBegin
DTMFEnd
DeadlockStart
DeviceStateChange
DeviceStateListComplete
DialBegin
DialEnd
DialState
EndpointDetail
EndpointDetailComplete
EndpointList
EndpointListComplete
ExtensionStateListComplete
ExtensionStatus
FAXSession
FAXSessionsComplete
FAXSessionsEntry
FAXStats
FAXStatus
FailedACL
Flash
FullyBooted
Hangup
HangupHandlerPop
HangupHandlerPush
HangupHandlerRun
HangupRequest
Hold
IdentifyDetail
InboundRegistrationDetail
InboundSubscriptionDetail
InvalidAccountID
InvalidPassword
InvalidTransport
Load
LoadAverageLimit
LocalBridge
LocalOptimizationBegin
LocalOptimizationEnd
LogChannel
MCID
MWIGet
MWIGetComplete
MeetmeEnd
MeetmeJoin
MeetmeLeave
MeetmeList
MeetmeListRooms
MeetmeMute
MeetmeTalkRequest
MeetmeTalking
MemoryLimit
MessageWaiting
MiniVoiceMail
MixMonitorMute
MixMonitorStart
MixMonitorStop
MonitorStart
MonitorStop
MusicOnHoldStart
MusicOnHoldStop
NewAccountCode
NewCallerid
NewConnectedLine
NewExten
Newchannel
Newstate
OriginateResponse
OutboundRegistrationDetail
OutboundSubscriptionDetail
ParkedCall
ParkedCallGiveUp
ParkedCallSwap
ParkedCallTimeOut
PeerStatus
Pickup
PresenceStateChange
PresenceStateListComplete
PresenceStatus
QueueCallerAbandon
QueueCallerJoin
QueueCallerLeave
QueueEntry
QueueMemberAdded
QueueMemberPause
QueueMemberPenalty
QueueMemberRemoved
QueueMemberRinginuse
QueueMemberStatus
QueueParams
RTCPReceived
RTCPSent
ReceiveFAX
Registry
Reload
Rename
RequestBadFormat
RequestNotAllowed
RequestNotSupported
ResourceListDetail
SIPQualifyPeerDone
SendFAX
SessionLimit
SessionTimeout
Shutdown
SoftHangupRequest
SpanAlarm
SpanAlarmClear
Status
StatusComplete
SuccessfulAuth
TransportDetail
UnParkedCall
UnexpectedAddress
Unhold
Unload
UserEvent
VarSet
VoicemailPasswordChange
Wink
Module Configuration
37
View all
Configuration reference for Asterisk modules and resource drivers.
app_agent_pool
app_confbridge
app_skel
cdr
cel
chan_motif
chan_websocket
codec_opus
core
features
named_acl
res_aeap
res_ari
res_geolocation
res_hep
res_http_media_cache
res_mwi_external
res_parking
res_pjproject
res_pjsip
res_pjsip_acl
res_pjsip_config_wizard
res_pjsip_endpoint_identifier_ip
res_pjsip_notify
res_pjsip_outbound_publish
res_pjsip_outbound_registration
res_pjsip_phoneprov_provider
res_pjsip_publish_asterisk
res_pjsip_pubsub
res_prometheus
res_resolver_unbound
res_statsd
res_stir_shaken
res_websocket_client
res_xmpp
stasis
udptl
Compliance
1
View all
Legal and regulatory reference for VoIP and telephony systems.