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()
Execute the named subroutine, defined in AEL, from...
AGI()
Executes an Asterisk Gateway Interface compliant p...
AMD()
Attempts to detect answering machines at the begin...
AddQueueMember()
Dynamically adds queue members.
AgentLogin()
Login an agent to the system. Any agent authentica...
AgentRequest()
Request an agent to connect with the channel. Fail...
AlarmReceiver()
Provide support for receiving alarm reports from a...
Answer()
Answer a channel if ringing.
AttendedTransfer()
Attended transfer to the extension provided and TR...
AudioSocket()
Transmit and receive PCM audio between a channel a...
Authenticate()
Asks the caller to enter a given password in order...
Background()
Will play the given list of files (do not put exte...
BackgroundDetect()
Plays back filename, waiting for interruption from...
BlindTransfer()
Blind transfer channel(s) to the extension and con...
Bridge()
Allows the ability to bridge two channels via the ...
BridgeAdd()
Join a bridge that contains the specified channel.
BridgeWait()
Places the incoming channel into a holding bridge....
Broadcast()
Transmit or receive audio to or from multiple chan...
Busy()
Indicate the Busy condition.
CELGenUserEvent()
A CEL event will be immediately generated by this ...
CallCompletionCancel()
Cancel a Call Completion Request. This application...
CallCompletionRequest()
Request call completion service for a previously f...
ChanIsAvail()
Will check to see if any of the specified channels...
ChanSpy()
Listen to a channel, and optionally whisper into i...
ChangeMonitor()
Changes monitoring filename of a channel. Has no e...
ChannelRedirect()
Sends the specified channel to the specified exten...
ClearHash()
Clear the keys from a specified hashname.
ConfBridge()
Conference bridge application.
ConfKick()
Kicks the requested channel(s) from a conference b...
Congestion()
Indicate the Congestion condition.
ContinueWhile()
Restart a While loop.
ControlPlayback()
Will play back the given filename. It sets the fol...
DAHDIAcceptR2Call()
Accept an R2 call if its not already accepted (you...
DAHDIRAS()
Executes a RAS server using pppd on the given chan...
DAHDIScan()
Allows a call center manager to monitor DAHDI chan...
DAHDISendCallreroutingFacility()
Send an ISDN call rerouting/deflection facility me...
DAHDISendKeypadFacility()
Will send the given string of digits in a Keypad F...
DBdeltree()
Delete a family or keytree from the asterisk datab...
DISA()
The DISA, Direct Inward System Access, application...
DateTime()
Says a specified time in a custom format.
DeadAGI()
Is deprecated and may be removed in a future versi...
Dial()
Will place calls to one or more specified channels...
Dictate()
Virtual Dictation Machine.
Directory()
Will present the calling channel with a directory ...
DumpChan()
Displays information on channel and listing of all...
EAGI()
Using 'EAGI' provides enhanced AGI, with incoming ...
Echo()
Echos back any media or DTMF frames read from the ...
Else()
Define an optional else branch.
ElseIf()
Start an optional ElseIf branch. Execution will co...
EndIf()
End an if branch.
EndWhile()
End a while loop.
Exec()
ExecIf()
If expr is true, execute and return the result of ...
ExecIfTime()
Conditional application execution based on the cur...
ExitIf()
End an If branch.
ExitWhile()
End a While loop.
ExtenSpy()
Listen to a channel, and optionally whisper into i...
ExternalIVR()
Either forks a process to run given command or mak...
Festival()
Connect to Festival, send the argument, get back t...
Flash()
Performs a flash on a DAHDI trunk. This can be use...
FollowMe()
Performs Find-Me/Follow-Me functionality for the c...
ForkCDR()
Forks the current Call Data Record for this channe...
GetCPEID()
Get ADSI CPE ID.
Gosub()
Jump to label, saving return address.
GosubIf()
Conditionally jump to label, saving return address...
Goto()
Will set the current context, extension, and prior...
GotoIf()
Will set the current context, extension, and prior...
GotoIfTime()
Will set the context, extension, and priority in t...
Hangup()
Hang up the calling channel.
HangupCauseClear()
Clears hangup cause information from the channel t...
IAX2Provision()
Provisions the calling IAXy (assuming the calling ...
ICES()
Streams to an icecast server using ices (available...
IVRDemo()
This is a skeleton application that shows you the ...
If()
Start an if branch.
ImportVar()
Import a variable from a channel into a new variab...
Incomplete()
Signals the PBX routines that the previous matched...
JACK()
When executing this application, two jack ports wi...
JabberJoin()
Join a chat room
JabberLeave()
Leave a chat room
JabberSend()
Sends the content of message as text message from ...
JabberSendGroup()
Allows user to send a message to a chat room via X...
JabberStatus()
Is deprecated. Please use the JABBER\STATUS() func...
Log()
Send arbitrary text to a selected log level.
MP3Player()
Play an MP3 file or M3U playlist file or stream.
MSet()
Can be used to set the value of channel variables ...
Macro()
Executes a macro using the context macro- name, ju...
MacroExclusive()
Executes macro defined in the context macro- name....
MacroExit()
Causes the currently running macro to exit as if i...
MacroIf()
Executes macro defined in macroiftrue if expr is t...
MailboxExists()
DEPRECATED. Use VM\INFO(mailbox\[@context\],exists...
MeetMe()
MeetMe conference bridge.
MeetMeAdmin()
Run admin command for conference confno. Will addi...
MeetMeChannelAdmin()
MeetMe conference Administration (channel specific...
MeetMeCount()
Plays back the number of users in the specified Me...
MessageSend()
Send a text message. The body of the message that ...
Milliwatt()
Generates a 1004 Hz test tone. By default, this ap...
MinivmAccMess()
Is part of the Mini-Voicemail system, configured i...
MinivmDelete()
Is part of the Mini-Voicemail system, configured i...
MinivmGreet()
Is part of the Mini-Voicemail system, configured i...
MinivmMWI()
Send Message Waiting Notification to subscriber(s)...
MinivmNotify()
Is part of the Mini-Voicemail system, configured i...
MinivmRecord()
Is part of the Mini-Voicemail system, configured i...
MixMonitor()
Record a call and mix the audio during the recordi...
Monitor()
Used to start monitoring a channel. The channel's ...
Morsecode()
Plays the Morse code equivalent of the passed stri...
MusicOnHold()
Play hold music on a channel, blocking until the c...
NBScat()
Executes nbscat to listen to the local NBS stream....
NoCDR()
Tell Asterisk to not maintain a CDR for this chann...
NoOp()
Does nothing. However, it is useful for debugging ...
ODBCFinish()
Clear the resultset of a sucessful multirow query.
ODBC_Commit()
Commits a currently open database transaction.
ODBC_Rollback()
Rollback a currently open database transaction.
OSPAuth()
Authenticate a call by OSP. Input variables: OSPIN...
OSPFinish()
Report call state. Input variables: OSPINHANDLE - ...
OSPLookup()
Looks up destination via OSP. Input variables: OSP...
OSPNext()
Looks up the next destination via OSP. Input varia...
Originate()
Originates an outbound call and connects it to a s...
PJSIPHangup()
Hangup an incoming PJSIP channel with a SIP respon...
PJSIPNotify()
Send a NOTIFY to either an arbitrary URI, or insid...
Page()
Page series of phones
Park()
Park yourself.
ParkAndAnnounce()
Park a call into the parkinglot and announce the c...
ParkedCall()
Used to retrieve a parked call from a parking lot....
PauseMonitor()
Pauses monitoring of a channel until it is re-enab...
PauseQueueMember()
Pauses (blocks calls for) a queue member. The give...
Pickup()
Directed extension call pickup.
PickupChan()
Pickup a ringing channel.
PlayTones()
Plays a tone list. Execution will continue with th...
Playback()
Plays back given filenames (do not put extension o...
PrivacyManager()
Require phone number to be entered, if no CallerID...
Proceeding()
Indicate proceeding.
Progress()
Will request that in-band progress information be ...
Queue()
In addition to transferring the call, a call may b...
QueueLog()
Writes to the queue_log file.
QueueUpdate()
Writes to the queue_log file for outbound calls an...
RaiseException()
Will jump to the 'e' extension in the current cont...
Read()
Prompts the caller to enter DTMF digits into a dia...
ReadExten()
Reads a '#' terminated string of digits from the u...
ReceiveFAX()
Is provided by res\_fax, which is a FAX technology...
ReceiveMF()
Detects MF digits on a channel and saves them to a...
ReceiveSF()
Detects SF digits on a channel and saves them to a...
ReceiveText()
Waits for timeout seconds on the current channel t...
Record()
If filename contains '%d', these characters will b...
Reload()
Reloads an Asterisk module, blocking the channel u...
RemoveQueueMember()
If the interface is NOT in the queue it will retur...
ResetCDR()
Causes the Call Data Record to be reset. Depending...
RetryDial()
Place a call, retrying on failure allowing an opti...
Return()
Jumps to the last label on the stack, removing it....
Ringing()
Indicate ringing tone.
SIPAddHeader()
Adds a header to a SIP call placed with DIAL. Reme...
SIPDtmfMode()
Changes the dtmfmode for a SIP call. Asterisk dial...
SIPRemoveHeader()
Remove SIP headers previously added with SIPAddHea...
SIPSendCustomINFO()
SIPSendCustomINFO() allows you to send a custom IN...
SLAStation()
Should be executed by an SLA station. The argument...
SLATrunk()
Should be executed by an SLA trunk on an inbound c...
SMS()
Communicates with SMS service centres and SMS capa...
SayAlpha()
Will play the sounds that correspond to the letter...
SayAlphaCase()
Say Alpha.
SayCountedAdj()
Say a adjective in declined form in order to count...
SayCountedNoun()
Say a noun in declined form in order to count thin...
SayDigits()
Will play the sounds that correspond to the digits...
SayMoney()
Will play the currency sounds for the given floati...
SayNumber()
Will play the sounds that correspond to the given ...
SayOrdinal()
Say Ordinal Number.
SayPhonetic()
Will play the sounds from the phonetic alphabet th...
SayUnixTime()
Uses some of the sound files stored in /var/lib/as...
SendDTMF()
Sends arbitrary DTMF digits
SendFAX()
Is provided by res\_fax, which is a FAX technology...
SendImage()
Send an image file on a channel supporting it. Res...
SendMF()
Sends arbitrary MF digits on the current or specif...
SendSF()
Sends arbitrary SF digits on the current or specif...
SendText()
Sends text to the current channel. current channel...
SendURL()
Requests client go to URL (IAX2) or sends the URL ...
Set()
SetAMAFlags()
Will set the channel's AMA Flags for billing purpo...
Signal()
Sends a signal to any waiting channels.
SkelGuessNumber()
This simple number guessing application is a templ...
SoftHangup()
Hangs up the requested channel. If there are no ch...
SpeechActivateGrammar()
This activates the specified grammar to be recogni...
SpeechBackground()
Play a sound file and wait for speech to be recogn...
SpeechCreate()
Creates information to be used by all the other ap...
SpeechDeactivateGrammar()
This deactivates the specified grammar so that it ...
SpeechDestroy()
This destroys the information used by all the othe...
SpeechLoadGrammar()
Load a grammar.
SpeechProcessingSound()
This changes the processing sound that SpeechBackg...
SpeechStart()
Tell the speech recognition engine that it should ...
SpeechUnloadGrammar()
Unload a grammar. Hangs up the channel on failure....
StackPop()
Remove one address from gosub stack.
StartMusicOnHold()
Start background music on a channel without blocki...
Stasis()
Invoke a Stasis application. This application will...
StatsD()
Allow statistics to be passed to the StatsD server...
StopMixMonitor()
Stop recording a call through MixMonitor, and free...
StopMonitor()
Stops monitoring a channel. Has no effect if the c...
StopMusicOnHold()
Asterisk StopMusicOnHold dialplan application refe...
StopPlayTones()
Stop playing a tone list.
StoreDTMF()
Stores DTMF digits transmitted or received on a ch...
StreamEcho()
Echo media, up to 'N' streams of a type, and DTMF ...
System()
Execute a system command.
TestClient()
Execute Interface Test Client.
TestServer()
Execute Interface Test Server.
ToneScan()
Wait for period of time while scanning for call pr...
Transfer()
Requests the remote caller be transferred to a giv...
TryExec()
Allows an arbitrary application to be invoked even...
TrySystem()
Executes a command by using system(). Result of ex...
UnpauseMonitor()
Unpauses monitoring of a channel on which monitori...
UnpauseQueueMember()
Unpauses (resumes calls to) a queue member. This i...
UserEvent()
Send an arbitrary user-defined event to parties in...
VMAuthenticate()
Authenticate with Voicemail passwords.
VMSayName()
Will say the recorded name of the voicemail user s...
Verbose()
Send arbitrary text to verbose output.
VoiceMail()
Allows the calling party to leave a message for th...
VoiceMailMain()
Allows the calling party to check voicemail messag...
VoiceMailPlayMsg()
Play a single voice mail msg from a mailbox by msg...
Wait()
Waits for some time.
WaitDigit()
Waits for the user to press one of the accepted di...
WaitExten()
Pause the dialplan and wait for the caller to dial...
WaitForCondition()
Waits until expression evaluates to true, checking...
WaitForNoise()
Waits for up to noiserequired milliseconds of nois...
WaitForRing()
Returns '0' after waiting at least timeout seconds...
WaitForSignal()
Waits for signaltimeout seconds on the current cha...
WaitForSilence()
Waits for up to silencerequired milliseconds of si...
WaitForTone()
Waits for a single-frequency tone to be detected b...
WaitUntil()
Wait (sleep) until the current time is the given e...
While()
Start a while loop.
Zapateller()
Generates special information tone to block telema...
Functions
224
View all
Dialplan functions return or set values and are used inside expressions, Set(), and GotoIf() conditions.
ABS()
Returns absolute value of a number.
AES_DECRYPT()
Decrypt a string encoded in base64 with AES given ...
AES_ENCRYPT()
Encrypt a string with AES given a 16 character key...
AGC()
Apply automatic gain control to audio on a channel...
AGENT()
Gets information about an Agent
AMI_CLIENT()
Currently, the only supported parameter is "sessio...
ARRAY()
The comma-delimited list passed as a value to whic...
AST_CONFIG()
Retrieve a variable from a configuration file.
AST_SORCERY()
Get a field from a sorcery object
BASE64_DECODE()
Decode a base64 string.
BASE64_ENCODE()
Encode a string in base64.
BASENAME()
Return the name of a file.
BLACKLIST()
Uses astdb to check if the Caller*ID is in family ...
CALENDAR_BUSY()
Determine if the calendar is marked busy at this t...
CALENDAR_EVENT()
Get calendar event notification data from a notifi...
CALENDAR_QUERY()
Query a calendar server and store the data on a ch...
CALENDAR_QUERY_RESULT()
Retrieve data from a previously run CALENDAR_QUERY...
CALENDAR_WRITE()
Write event data to a calendar entry from the Aste...
CALLCOMPLETION()
Get or set a call completion configuration paramet...
CALLERID()
Gets or sets Caller*ID data on the channel.
CALLERPRES()
Gets or sets Caller*ID presentation on the channel...
CDR()
Read or set Call Detail Record fields in the dialp...
CDR_PROP()
Set a property on a channel's CDR.
CHANNEL()
Gets/sets various pieces of information about the ...
CHANNELS()
Gets the list of channels, optionally filtering by...
CHANNEL_EXISTS()
Checks if the specified channel exists.
CHECKSIPDOMAIN()
Checks if the domain in the argument is configured...
CONFBRIDGE()
Set a custom dynamic bridge, user, or menu profile...
CONFBRIDGE_CHANNELS()
Get a list of channels in a ConfBridge conference.
CONFBRIDGE_INFO()
Get information about a ConfBridge conference.
CONNECTEDLINE()
Gets or sets Connected Line data on the channel.
CSV_QUOTE()
Quotes a given string for use in a CSV file, escap...
CURL()
Retrieve content from a remote web or ftp server
CURLOPT()
Sets various options for future invocations of CUR...
CUT()
Slices and dices strings, based upon a named delim...
DAHDI_CHANNEL()
Set or get a property of a DAHDI channel.
DB()
Will read from or write a value to the Asterisk da...
DB_DELETE()
Will retrieve a value from the Asterisk database a...
DB_EXISTS()
Check to see if a key exists in the Asterisk datab...
DB_KEYCOUNT()
Obtain the number of keys at a prefix within the A...
DB_KEYS()
Obtain a list of keys within the Asterisk database...
DEC()
Decrements the value of a variable, while returnin...
DELETE()
Deletes a specified channel variable.
DENOISE()
The DENOISE function will apply noise reduction to...
DEVICE_STATE()
The DEVICE\STATE function can be used to retrieve ...
DIALGROUP()
Presents an interface meant to be used in concert ...
DIALPLAN_EXISTS()
Checks the existence of a dialplan target.
DIGIT_SUM()
Returns the sum of all the digits in a number.
DIRNAME()
Return the directory of a file.
DUNDILOOKUP()
This will do a DUNDi lookup of the given phone num...
DUNDIQUERY()
This will do a DUNDi lookup of the given phone num...
DUNDIRESULT()
Retrieve results from a DUNDIQUERY.
ENUMLOOKUP()
General or specific querying of NAPTR records for ...
ENUMQUERY()
Initiate an ENUM query.
ENUMRESULT()
Retrieve results from a ENUMQUERY.
ENV()
Variables starting with 'AST\_' are reserved to th...
EVAL()
Using EVAL basically causes a string to be evaluat...
EVAL_EXTEN()
Evaluates the contents of a dialplan extension and...
EVAL_SUB()
Executes a Gosub and provides its return value as ...
EXCEPTION()
Retrieve the details of the current dialplan excep...
EXISTS()
Test the existence of a value.
EXPORT()
Set variables or dialplan functions on any arbitra...
EXTENSION_STATE()
The EXTENSION\STATE function can be used to retrie...
FAXOPT()
Gets/sets various pieces of information about a fa...
FEATURE()
Get or set a feature option on a channel.
FEATUREMAP()
Get or set a feature map to a given value on a spe...
FIELDNUM()
Search the variable named varname for the string v...
FIELDQTY()
The delimiter may be specified as a special or ext...
FILE()
Read and write text files from the Asterisk dialpl...
FILE_COUNT_LINE()
Returns the number of lines, or '-1' on error. If ...
FILE_FORMAT()
Return the line terminator type: 'u' - Unix "\n" f...
FILTER()
Permits all characters listed in allowed-chars, fi...
FRAME_DROP()
Drops specific frame types in the TX or RX directi...
FRAME_TRACE()
View internal ast_frames as they are read and writ...
GEOLOC_PROFILE()
When used to set a parameter on a profile, if the ...
GLOBAL()
Gets or sets the global variable specified.
GLOBAL_DELETE()
Delete the global variable specified in varname. W...
GLOBAL_EXISTS()
Check if a global variable exists or not.
GROUP()
Category can be employed for more fine grained gro...
GROUP_COUNT()
Counts the number of channels in the specified gro...
GROUP_LIST()
Gets a list of the groups set on a channel.
GROUP_MATCH_COUNT()
Counts the number of channels in the groups matchi...
HANGUPCAUSE()
Gets per-channel hangupcause information from the ...
HANGUPCAUSE_KEYS()
Gets the list of channels for which hangup causes ...
HASH()
In two arguments mode, gets and sets values to cor...
HASHKEYS()
Retrieve the keys of the HASH() function.
HINT()
The HINT function can be used to retrieve the list...
HOLD_INTERCEPT()
Intercepts hold frames on a channel and raises an ...
IAXPEER()
Gets IAX peer information.
IAXVAR()
Sets or retrieves a remote variable.
ICONV()
Converts charsets of strings.
IF()
Check for an expression.
IFMODULE()
Checks if a module is loaded. Use the full module ...
IFTIME()
Temporal Conditional.
IMPORT()
Retrieve the value of a variable from another chan...
INC()
Increments the value of a variable, while returnin...
ISNULL()
Check if a value is NULL.
JABBER_RECEIVE()
Reads XMPP messages.
JABBER_STATUS()
Retrieves the numeric status associated with the b...
JITTERBUFFER()
Add a Jitterbuffer to the Read side of the channel...
JSON_DECODE()
Extract values from JSON strings in the Asterisk d...
KEYPADHASH()
Hash the letters in string into equivalent keypad ...
LEN()
Return the length of a string in the Asterisk dial...
LISTFILTER()
Remove value from the list contained in the varnam...
LOCAL()
Read and write a variable local to the gosub stack...
LOCAL_PEEK()
Retrieve variables hidden by the local gosub stack...
LOCK()
Attempts to grab a named lock exclusively, and pre...
LOG_GROUP()
Set the channel group name for log filtering on th...
LTRIM()
Trim leading whitespace in a string
MAILBOX_EXISTS()
DEPRECATED. Use VM\INFO(mailbox\[@context\],exists...
MASTER_CHANNEL()
Allows access to the oldest channel associated wit...
MATH()
Performs Mathematical Functions.
MAX()
Returns the maximum of two numbers.
MD5()
Computes an MD5 digest.
MEETME_INFO()
Query a given conference of various properties.
MESSAGE()
Will read from or write a value to a text message....
MESSAGE_DATA()
Will read from or write a value to a text message....
MIN()
Returns the minimum of two numbers.
MINIVMACCOUNT()
Gets MiniVoicemail account information.
MINIVMCOUNTER()
The operation is atomic and the counter is locked ...
MIXMONITOR()
Retrieve data pertaining to specific instances of ...
MUTEAUDIO()
The MUTEAUDIO function can be used to mute inbound...
ODBC()
Controls ODBC transaction properties.
ODBC_FETCH()
For queries which are marked as mode=multirow, the...
PARK_GET_CHANNEL()
Get the channel name of an occupied parking space ...
PASSTHRU()
Literally returns the given string. The intent is ...
PERIODIC_HOOK()
Execute a periodic dialplan hook into the audio of...
PITCH_SHIFT()
Pitch shift both tx and rx audio streams on a chan...
PJSIP_AOR()
Get information about a PJSIP AOR
PJSIP_CONTACT()
Get information about a PJSIP contact
PJSIP_DIAL_CONTACTS()
Return a dial string for dialing all contacts on a...
PJSIP_DTMF_MODE()
When read, returns the current DTMF mode When writ...
PJSIP_ENDPOINT()
Get information about a PJSIP endpoint
PJSIP_HEADER()
Read, add, update, or remove SIP headers on PJSIP ...
PJSIP_HEADERS()
Gets the list of SIP header names from an INVITE m...
PJSIP_HEADER_PARAM()
Get or set header/URI parameters on a PJSIP channe...
PJSIP_INHERITABLE_HEADER()
Adds, updates or removes the specified SIP header ...
PJSIP_MEDIA_OFFER()
Media and codec offerings to be set on an outbound...
PJSIP_MOH_PASSTHROUGH()
Get or change the on-hold behavior for a SIP call.
PJSIP_PARSE_URI()
Parse a URI and return a type part of the URI.
PJSIP_PARSE_URI_FROM()
Parse the contents of a variable as a URI and retu...
PJSIP_RESPONSE_HEADER()
Gets headers of 200 response from an outbound PJSI...
PJSIP_RESPONSE_HEADERS()
Gets the list of SIP header names from the 200 res...
PJSIP_SEND_SESSION_REFRESH()
W/O: Initiate a session refresh via an UPDATE or r...
PJSIP_TRANSFER_HANDLING()
Set how transfers are handled for a PJSIP channel.
POLARITY()
The POLARITY function can be used to set the polar...
POP()
Removes and returns the last item off of a variabl...
PP_EACH_EXTENSION()
Output the specified template for each extension a...
PP_EACH_USER()
Pass in a string, with phoneprov variables you wan...
PRESENCE_STATE()
The PRESENCE\STATE function can be used to retriev...
PUSH()
Appends one or more values to the end of a variabl...
QUEUE_EXISTS()
Check if a named queue exists on this server
QUEUE_GET_CHANNEL()
Return caller at the specified position in a queue...
QUEUE_MEMBER()
Provides a count of queue members based on the pro...
QUEUE_MEMBER_COUNT()
Returns the number of members currently associated...
QUEUE_MEMBER_LIST()
Returns a comma-separated list of members associat...
QUEUE_MEMBER_PENALTY()
Gets or sets queue members penalty.
QUEUE_VARIABLES()
Makes the following queue variables available. Ret...
QUEUE_WAITING_COUNT()
Count number of calls currently waiting in a queue...
QUOTE()
Quotes a given string, escaping embedded quotes as...
RAND()
Choose a random number between min and max. min de...
REALTIME()
Will read or write values from/to a RealTime repos...
REALTIME_DESTROY()
RealTime Destroy Function.
REALTIME_FIELD()
RealTime query function.
REALTIME_HASH()
Retrieves a single record from the RT engine, wher...
REALTIME_STORE()
Will insert a new set of values into the RealTime ...
RECORDING_INFO()
Retrieve information about a recording previously ...
REDIRECTING()
Gets or sets Redirecting data on the channel. The ...
REGEX()
Return '1' on regular expression match or '0' othe...
REPLACE()
Replace a set of characters in a given string with...
RTRIM()
Trim trailing whitespace in a string
SAYFILES()
Returns the ampersand-delimited file names that wo...
SCRAMBLE()
Scrambles audio on a channel using whole spectrum ...
SET()
SET assigns a value to a channel variable.
SHA1()
Computes a SHA1 digest.
SHARED()
Implements a shared variable area, in which you ma...
SHELL()
Executes a command using the system shell and capt...
SHIFT()
Removes and returns the first item off of a variab...
SIPPEER()
### Syntax SIPPEER(peername,item). Asterisk dialpl...
SIP_HEADER()
Reads a named SIP header from an incoming INVITE m...
SIP_HEADERS()
Gets the list of SIP header names from an incoming...
SMDI_MSG()
Is used to access details of an SMDI message that ...
SMDI_MSG_RETRIEVE()
Is used to retrieve an incoming SMDI message. It r...
SORT()
Sorts a list of key/vals into a list of keys, base...
SPEECH()
Gets information about speech recognition results.
SPEECH_ENGINE()
Get or change a speech engine specific attribute.
SPEECH_GRAMMAR()
Gets the matched grammar of a result if available.
SPEECH_RESULTS_TYPE()
Sets the type of results that will be returned. Va...
SPEECH_SCORE()
Gets the confidence score of a result.
SPEECH_TEXT()
Gets the recognized text of a result.
SPRINTF()
Parses the format string specified and returns a s...
SQL_ESC()
Escapes single ticks for use in SQL statements.
SQL_ESC_BACKSLASHES()
Escapes backslashes for use in SQL statements.
SRVQUERY()
Initiate an SRV query.
SRVRESULT()
Retrieve results from an SRVQUERY.
STACK_PEEK()
Read the calling 'c'ontext, 'e'xtension, 'p'riorit...
STAT()
> Note > > If 'live_dangerously' in 'asterisk.conf...
STIR_SHAKEN()
Gets the number of STIR/SHAKEN results or a specif...
STIR_SHAKEN_ATTESTATION()
Sets STIR/SHAKEN Attestation parameters on an outg...
STRBETWEEN()
Inserts a substring between each character in a st...
STRFTIME()
Returns the current date/time in the specified for...
STRPTIME()
Returns the epoch of the arbitrary date/time strin...
STRREPLACE()
Replace instances of a substring within a string w...
SYSINFO()
Returns system information specified by parameter.
TALK_DETECT()
Raises notifications when Asterisk detects silence...
TESTTIME()
Sets a time to be used with the channel to test lo...
TIMEOUT()
The timeouts that can be manipulated are: absolute...
TOLOWER()
Convert a string to lowercase in the Asterisk dial...
TONE_DETECT()
Asynchronously detects a tone
TOUPPER()
Convert a string to uppercase in the Asterisk dial...
TRIM()
Trim leading and trailing whitespace in a string
TRYLOCK()
Attempt to obtain a named mutex.
TXTCIDNAME()
Looks up the given phone number in DNS to retrieve...
UNLOCK()
Unlocks a previously locked mutex. Returns '1' if ...
UNSHIFT()
Inserts one or more values to the beginning of a v...
URIDECODE()
Decodes a URI-encoded string according to RFC 2396...
URIENCODE()
Encodes a string to URI-safe encoding according to...
UUID()
Generates an UUID.
VALID_EXTEN()
Returns a true value if the indicated context, ext...
VARIABLE_EXISTS()
Check if a dialplan variable exists or not.
VERSION()
Return the current Asterisk version string, or com...
VMCOUNT()
Count the voicemails in a specified mailbox or mai...
VM_INFO()
Returns the selected attribute from the specified ...
VOLUME()
The VOLUME function can be used to increase or dec...
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
Answer channel
ASYNCAGI BREAK
Interrupts Async AGI
CHANNEL STATUS
Returns the status of the specified channelname. I...
CONTROL STREAM FILE
Sends audio file on channel and allows the listene...
DATABASE DEL
Removes database key/value
DATABASE DELTREE
Deletes a family or specific keytree within a fami...
DATABASE GET
Gets database value
DATABASE PUT
Adds or updates an entry in the Asterisk database ...
EXEC
Executes application with given options. Returns w...
GET DATA
Prompts for DTMF on a channel
GET FULL VARIABLE
Evaluates the given expression against the channel...
GET OPTION
Stream file, prompt for DTMF, with timeout.
GET VARIABLE
Gets a channel variable.
GOSUB
Cause the channel to execute the specified dialpla...
HANGUP
Hangs up the specified channel. If no channel name...
NOOP
Does nothing.
RECEIVE CHAR
Receives one character from channels supporting it...
RECEIVE TEXT
Receives a string of text on a channel. Most chann...
RECORD FILE
Records to a given file.
SAY ALPHA
Says a given character string.
SAY DATE
Say a given date, returning early if any of the gi...
SAY DATETIME
Says a given time as specified by the format given...
SAY DIGITS
Says a given digit string.
SAY NUMBER
Say a given number, returning early if any of the ...
SAY PHONETIC
Say a given character string with phonetics, retur...
SAY TIME
Say a given time, returning early if any of the gi...
SEND IMAGE
Sends the given image on a channel. Most channels ...
SEND TEXT
Sends the given text on a channel. Most channels d...
SET AUTOHANGUP
Cause the channel to automatically hangup at time ...
SET CALLERID
Sets callerid for the current channel.
SET CONTEXT
Sets channel context.
SET EXTENSION
Changes channel extension.
SET MUSIC
Enables/Disables the music on hold generator. If c...
SET PRIORITY
Set channel dialplan priority.
SET VARIABLE
Sets a channel variable.
SPEECH ACTIVATE GRAMMAR
Activates a grammar.
SPEECH CREATE
Creates a speech object.
SPEECH DEACTIVATE GRAMMAR
Deactivates a grammar.
SPEECH DESTROY
Destroys a speech object.
SPEECH LOAD GRAMMAR
Loads a grammar.
SPEECH RECOGNIZE
Recognizes speech.
SPEECH SET
Sets a speech engine setting.
SPEECH UNLOAD GRAMMAR
Asterisk SPEECH UNLOAD GRAMMAR AGI command referen...
STREAM FILE
Sends audio file on channel.
TDD MODE
Enable/Disable TDD transmission/reception on a cha...
VERBOSE
Logs a message to the asterisk verbose log.
WAIT FOR DIGIT
AGI command that pauses execution and waits for th...
AMI Actions
167
View all
Asterisk Manager Interface actions for remote system control.
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.
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 sta...
BridgeTechnologySuspend
Suspend a bridging technology.
BridgeTechnologyUnsuspend
Unsuspend a bridging technology.
CancelAtxfer
Cancel an attended transfer. Note, this uses the c...
Challenge
Generate Challenge for MD5 Auth.
ChangeMonitor
May be used to change the file started by a previo...
Command
Execute Asterisk CLI Command.
ConfbridgeKick
### Syntax Action: ConfbridgeKick ActionID: <value...
ConfbridgeList
Lists all users in a particular ConfBridge confere...
ConfbridgeListRooms
Lists data about all active conferences. Confbridg...
ConfbridgeLock
Lock a Confbridge conference.
ConfbridgeMute
### Syntax Action: ConfbridgeMute ActionID: <value...
ConfbridgeSetSingleVideoSrc
Set a conference user as the single video source d...
ConfbridgeStartRecord
Start recording a Confbridge conference.
ConfbridgeStopRecord
Stop recording a Confbridge conference.
ConfbridgeUnlock
Unlock a Confbridge conference.
ConfbridgeUnmute
### Syntax Action: ConfbridgeUnmute ActionID: <val...
ControlPlayback
Control the playback of a file being played to a c...
CoreSettings
Show PBX core settings (version etc).
CoreShowChannelMap
List all channels connected to the specified chann...
CoreShowChannels
List currently active channels.
CoreStatus
Show PBX core status variables.
CreateConfig
Creates an empty file in the configuration directo...
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...
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/...
DBPut
Put DB entry.
DeviceStateList
This will list out all known device states in a se...
DialplanExtensionAdd
### Syntax Action: DialplanExtensionAdd ActionID: ...
DialplanExtensionRemove
Remove an extension from the dialplan
Events
Control Event Flow.
ExtensionState
Report the extension state for given extension. If...
ExtensionStateList
This will list out all known extension states in a...
FAXSession
Responds with a detailed description of a single F...
FAXSessions
Lists active FAX sessions
FAXStats
Provides FAX statistics including the number of ac...
Filter
Dynamically add filters for the current manager se...
GetConfig
Retrieve configuration.
GetConfigJSON
Will dump the contents of a configuration file by ...
Getvar
Get the value of a channel variable or function re...
Hangup
Hangup channel.
IAXnetstats
Show IAX Netstats.
IAXpeerlist
List IAX Peers.
IAXpeers
List IAX peers.
IAXregistry
Show IAX registrations.
JabberSend
Sends a message to a Jabber Client.
ListCategories
List categories in configuration file.
ListCommands
List available manager commands.
LocalOptimizeAway
A local channel created with "/n" will not automat...
LoggerRotate
Reload and rotate the Asterisk logger.
Login
Authenticate a manager connection to the Asterisk ...
Logoff
Logoff Manager.
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. Retur...
MailboxStatus
Checks a voicemail account for status. Returns whe...
MeetmeList
Lists all users in a particular MeetMe conference....
MeetmeListRooms
Lists data about all active conferences. MeetmeLis...
MeetmeMute
Mute a Meetme user.
MeetmeUnmute
Unmute a Meetme user.
MessageSend
### Syntax Action: MessageSend ActionID: <value> [...
MixMonitor
Record a call and mix the audio during the recordi...
MixMonitorMute
Mute / unMute a Mixmonitor recording.
ModuleCheck
Checks if Asterisk module is loaded. Will return S...
ModuleLoad
Module management.
Monitor
May be used to record the audio on a specified cha...
MuteAudio
Mute an audio stream.
Originate
Originate a call.
PJSIPHangup
Hangup an incoming PJSIP channel with a SIP respon...
PJSIPNotify
Send a NOTIFY to either an endpoint, an arbitrary ...
PJSIPQualify
Qualify a chan_pjsip endpoint.
PJSIPRegister
Unregisters the specified (or all) outbound regist...
PJSIPShowAors
Provides a listing of all AORs. For each AOR an 'A...
PJSIPShowAuths
Provides a listing of all Auths. For each Auth an ...
PJSIPShowContacts
Provides a listing of all Contacts. For each Conta...
PJSIPShowEndpoint
Provides a detailed listing of options for a given...
PJSIPShowEndpoints
Provides a listing of all endpoints. For each endp...
PJSIPShowRegistrationInboundContactStatuses
Lists ContactStatuses for PJSIP inbound registrati...
PJSIPShowRegistrationsInbound
In response, 'InboundRegistrationDetail' events sh...
PJSIPShowRegistrationsOutbound
In response 'OutboundRegistrationDetail' events sh...
PJSIPShowResourceLists
Displays settings for configured resource lists.
PJSIPShowSubscriptionsInbound
Provides a listing of all inbound subscriptions. A...
PJSIPShowSubscriptionsOutbound
Provides a listing of all outbound subscriptions. ...
PJSIPUnregister
Unregisters the specified (or all) outbound regist...
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 ...
ParkedCalls
List parked calls.
Parkinglots
Get a list of parking lots
PauseMonitor
May be used to temporarily stop the recording of a...
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 p...
PresenceStateList
This will list out all known presence states in a ...
QueueAdd
### Syntax Action: QueueAdd ActionID: <value> Queu...
QueueChangePriorityCaller
### Syntax Action: QueueChangePriorityCaller Actio...
QueueLog
### Syntax Action: QueueLog ActionID: <value> Queu...
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 qu...
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 t...
Redirect
Redirect (transfer) a call.
Reload
Send a reload event.
SIPnotify
Sends a SIP Notify event. All parameters for this ...
SIPpeers
Lists SIP peers in text format with details on cur...
SIPpeerstatus
Retrieves the status of one or all of the sip peer...
SIPqualifypeer
Asterisk SIPqualifypeer AMI action reference. Comp...
SIPshowpeer
Show one SIP peer with details on current status. ...
SIPshowregistry
Lists all registration requests and status. Regist...
SKINNYdevices
Lists Skinny devices in text format with details o...
SKINNYlines
Lists Skinny lines in text format with details on ...
SKINNYshowdevice
Show one SKINNY device with details on current sta...
SKINNYshowline
Show one SKINNY line with details on current statu...
SendFlash
Send a hook flash on a specific channel.
SendText
Sends a text message to channel. A content type ca...
Setvar
Can be used to set the value of channel variables ...
ShowDialPlan
Show dialplan contexts and extensions
SorceryMemoryCacheExpire
Expire (remove) ALL objects from a sorcery memory ...
SorceryMemoryCacheExpireObject
Expire (remove) an object from a sorcery memory ca...
SorceryMemoryCachePopulate
Expire all objects from a memory cache and populat...
SorceryMemoryCacheStale
Marks ALL objects in a sorcery memory cache as sta...
SorceryMemoryCacheStaleObject
Mark an object in a sorcery memory cache as stale.
Status
List channel status.
StopMixMonitor
Stop recording a call through MixMonitor, and free...
StopMonitor
May be used to end a previously started 'Monitor' ...
UnpauseMonitor
May be used to re-enable recording of a channel af...
UpdateConfig
Update basic configuration.
UserEvent
Send an arbitrary event.
VoicemailBoxSummary
Show the mailbox contents of given voicemail user.
VoicemailForward
Forward Voicemail from one mailbox folder to anoth...
VoicemailMove
Move Voicemail between mailbox folders of given us...
VoicemailRefresh
Normally, MWI indicators are only sent when Asteri...
VoicemailRemove
Remove Voicemail from mailbox folder.
VoicemailUserStatus
Show the status of given voicemail user's info.
VoicemailUsersList
List All Voicemail User Information.
WaitEvent
Will elicit a 'Success' response. Whenever a manag...
AMI Events
184
View all
Asterisk Manager Interface events for real-time system monitoring.
AGIExecEnd
Raised when a received AGI command completes proce...
AGIExecStart
Raised when a received AGI command starts processi...
AOC-D
Raised when an Advice of Charge message is sent du...
AOC-E
Raised when an Advice of Charge message is sent at...
AOC-S
Raised when an Advice of Charge message is sent at...
AgentCalled
Raised when an queue member is notified of a calle...
AgentComplete
Raised when a queue member has finished servicing ...
AgentConnect
Raised when a queue member answers and is bridged ...
AgentDump
Raised when a queue member hangs up on a caller in...
AgentLogin
Raised when an Agent has logged in.
AgentLogoff
Raised when an Agent has logged off.
AgentRingNoAnswer
Raised when a queue member is notified of a caller...
Agents
Response event in a series to the Agents AMI actio...
AgentsComplete
Final response event in a series of events to the ...
Alarm
Raised when an alarm is set on a DAHDI channel.
AlarmClear
Raised when an alarm is cleared on a DAHDI channel...
AorDetail
Provide details about an Address of Record (AoR) s...
AorList
Provide details about an Address of Record (AoR) s...
AorListComplete
Provide final information about an aor list.
AsyncAGIEnd
Raised when a channel stops AsyncAGI command proce...
AsyncAGIExec
Raised when AsyncAGI completes an AGI command.
AsyncAGIStart
Raised when a channel starts AsyncAGI command proc...
AttendedTransfer
The headers in this event attempt to describe all ...
AuthDetail
Provide details about an authentication section.
AuthList
Provide details about an Address of Record (Auth) ...
AuthListComplete
Provide final information about an auth list.
AuthMethodNotAllowed
Raised when a request used an authentication metho...
BlindTransfer
Raised when a blind transfer is complete.
BridgeCreate
Raised when a bridge is created.
BridgeDestroy
Raised when a bridge is destroyed.
BridgeEnter
Raised when a channel enters a bridge.
BridgeInfoChannel
Information about a channel in a bridge.
BridgeInfoComplete
Information about a bridge.
BridgeLeave
Raised when a channel leaves a bridge.
BridgeMerge
Raised when two bridges are merged.
BridgeVideoSourceUpdate
Raised when the channel that is the source of vide...
CEL
Raised when a Channel Event Log is generated for a...
Cdr
Raised when a CDR is generated.
ChallengeResponseFailed
Raised when a request's attempt to authenticate ha...
ChallengeSent
Raised when an Asterisk service sends an authentic...
ChanSpyStart
Raised when one channel begins spying on another c...
ChanSpyStop
Raised when a channel has stopped spying.
ChannelTalkingStart
Raised when talking is detected on a channel.
ChannelTalkingStop
Raised when talking is no longer detected on a cha...
ConfbridgeEnd
Raised when a conference ends.
ConfbridgeJoin
Raised when a channel joins a Confbridge conferenc...
ConfbridgeLeave
Raised when a channel leaves a Confbridge conferen...
ConfbridgeList
Raised as part of the ConfbridgeList action respon...
ConfbridgeListRooms
Raised as part of the ConfbridgeListRooms action r...
ConfbridgeMute
Raised when a Confbridge participant mutes.
ConfbridgeRecord
Raised when a conference starts recording.
ConfbridgeStart
Raised when a conference starts.
ConfbridgeStopRecord
Raised when a conference that was recording stops ...
ConfbridgeTalking
Raised when a confbridge participant begins or end...
ConfbridgeUnmute
Raised when a confbridge participant unmutes.
ContactList
Provide details about a contact section.
ContactListComplete
Provide final information about a contact list.
ContactStatus
Raised when the state of a contact changes.
ContactStatusDetail
Provide details about a contact's status.
CoreShowChannel
Raised in response to a CoreShowChannels command.
CoreShowChannelMapComplete
Raised at the end of the CoreShowChannelMap list p...
CoreShowChannelsComplete
Raised at the end of the CoreShowChannel list prod...
DAHDIChannel
Raised when a DAHDI channel is created or an under...
DNDState
Raised when the Do Not Disturb state is changed on...
DTMFBegin
Raised when a DTMF digit has started on a channel.
DTMFEnd
Raised when a DTMF digit has ended on a channel.
DeadlockStart
Raised when a probable deadlock has started. Deliv...
DeviceStateChange
This differs from the 'ExtensionStatus' event beca...
DeviceStateListComplete
Indicates the end of the list the current known ex...
DialBegin
Raised when a dial action has started.
DialEnd
Raised when a dial action has completed.
DialState
Raised when dial status has changed.
EndpointDetail
Provide details about an endpoint section.
EndpointDetailComplete
Provide final information about endpoint details.
EndpointList
Provide details about a contact's status.
EndpointListComplete
Provide final information about an endpoint list.
ExtensionStateListComplete
Indicates the end of the list the current known ex...
ExtensionStatus
Raised when a hint changes due to a device state c...
FAXSession
Raised in response to FAXSession manager command
FAXSessionsComplete
Raised when all FAXSession events are completed fo...
FAXSessionsEntry
A single list item for the FAXSessions AMI command
FAXStats
Raised in response to FAXStats manager command
FAXStatus
Raised periodically during a fax transmission.
FailedACL
Raised when a request violates an ACL check.
Flash
Raised when a hook flash occurs on a channel.
FullyBooted
Raised when all Asterisk initialization procedures...
Hangup
Raised when a channel is hung up.
HangupHandlerPop
Raised when a hangup handler is removed from the h...
HangupHandlerPush
Raised when a hangup handler is added to the handl...
HangupHandlerRun
Raised when a hangup handler is about to be called...
HangupRequest
Raised when a hangup is requested.
Hold
Raised when a channel goes on hold.
IdentifyDetail
Provide details about an identify section.
InboundRegistrationDetail
Provide details about the Address of Record (AoR) ...
InboundSubscriptionDetail
Provides details about an inbound subscription - o...
InvalidAccountID
Raised when a request fails an authentication chec...
InvalidPassword
Raised when a request provides an invalid password...
InvalidTransport
Raised when a request attempts to use a transport ...
Load
Raised when a module has been loaded in Asterisk.
LoadAverageLimit
Raised when a request fails because a configured l...
LocalBridge
Raised when two halves of a Local Channel form a b...
LocalOptimizationBegin
Raised when two halves of a Local Channel begin to...
LocalOptimizationEnd
Raised when two halves of a Local Channel have fin...
LogChannel
Raised when a logging channel is re-enabled after ...
MCID
Published when a malicious call ID request arrives...
MWIGet
Raised in response to a MWIGet command.
MWIGetComplete
Raised in response to a MWIGet command.
MeetmeEnd
Raised when a MeetMe conference ends.
MeetmeJoin
Raised when a user joins a MeetMe conference.
MeetmeLeave
Raised when a user leaves a MeetMe conference.
MeetmeList
Raised in response to a MeetmeList command.
MeetmeListRooms
Raised in response to a MeetmeListRooms command.
MeetmeMute
Raised when a MeetMe user is muted or unmuted.
MeetmeTalkRequest
Raised when a MeetMe user has started talking.
MeetmeTalking
Raised when a MeetMe user begins or ends talking.
MemoryLimit
Raised when a request fails due to an internal mem...
MessageWaiting
Raised when the state of messages in a voicemail m...
MiniVoiceMail
Raised when a notification is sent out by a MiniVo...
MixMonitorMute
Raised when monitoring is muted or unmuted on a ch...
MixMonitorStart
Raised when monitoring has started on a channel.
MixMonitorStop
Raised when monitoring has stopped on a channel.
MonitorStart
Asterisk MonitorStart AMI event reference. Complet...
MonitorStop
Asterisk MonitorStop AMI event reference. Complete...
MusicOnHoldStart
Raised when music on hold has started on a channel...
MusicOnHoldStop
Raised when music on hold has stopped on a channel...
NewAccountCode
Raised when a Channel's AccountCode is changed.
NewCallerid
Raised when a channel receives new Caller ID infor...
NewConnectedLine
Raised when a channel's connected line information...
NewExten
Raised when a channel enters a new context, extens...
Newchannel
Raised when a new channel is created.
Newstate
Raised when a channel's state changes.
OriginateResponse
Raised in response to an Originate command.
OutboundRegistrationDetail
Provides configuration details and status informat...
OutboundSubscriptionDetail
Provides details about an outbound subscription - ...
ParkedCall
Raised when a channel is parked.
ParkedCallGiveUp
Raised when a channel leaves a parking lot because...
ParkedCallSwap
Raised when a channel takes the place of a previou...
ParkedCallTimeOut
Raised when a channel leaves a parking lot due to ...
PeerStatus
Raised when the state of a peer changes.
Pickup
Raised when a call pickup occurs.
PresenceStateChange
This differs from the 'PresenceStatus' event becau...
PresenceStateListComplete
Indicates the end of the list the current known ex...
PresenceStatus
Raised when a hint changes due to a presence state...
QueueCallerAbandon
Raised when a caller abandons the queue.
QueueCallerJoin
Raised when a caller joins a Queue.
QueueCallerLeave
Raised when a caller leaves a Queue.
QueueEntry
Raised in response to the QueueStatus action.
QueueMemberAdded
Raised when a member is added to the queue.
QueueMemberPause
Raised when a member is paused/unpaused in the que...
QueueMemberPenalty
Raised when a member's penalty is changed.
QueueMemberRemoved
Raised when a member is removed from the queue.
QueueMemberRinginuse
Raised when a member's ringinuse setting is change...
QueueMemberStatus
Raised when a Queue member's status has changed.
QueueParams
Raised in response to the QueueStatus action.
RTCPReceived
Raised when an RTCP packet is received.
RTCPSent
Raised when an RTCP packet is sent.
ReceiveFAX
Raised when a receive fax operation has completed.
Registry
Raised when an outbound registration completes.
Reload
Raised when a module has been reloaded in Asterisk...
Rename
Raised when the name of a channel is changed.
RequestBadFormat
Raised when a request is received with bad formatt...
RequestNotAllowed
Raised when a request is not allowed by the servic...
RequestNotSupported
Raised when a request fails due to some aspect of ...
ResourceListDetail
Provides details about a resource list.
SIPQualifyPeerDone
Raised when SIPQualifyPeer has finished qualifying...
SendFAX
Raised when a send fax operation has completed.
SessionLimit
Raised when a request fails due to exceeding the n...
SessionTimeout
Asterisk SessionTimeout AMI event reference. Compl...
Shutdown
Raised when Asterisk is shutdown or restarted.
SoftHangupRequest
Raised when a soft hangup is requested with a spec...
SpanAlarm
Raised when an alarm is set on a DAHDI span.
SpanAlarmClear
Raised when an alarm is cleared on a DAHDI span.
Status
Raised in response to a Status command.
StatusComplete
Raised in response to a Status command.
SuccessfulAuth
Raised when a request successfully authenticates w...
TransportDetail
Provide details about an authentication section.
UnParkedCall
Raised when a channel leaves a parking lot because...
UnexpectedAddress
Raised when a request has a different source addre...
Unhold
Raised when a channel goes off hold.
Unload
Raised when a module has been unloaded in Asterisk...
UserEvent
A user defined event raised from the dialplan.
VarSet
Raised when a variable local to the gosub stack fr...
VoicemailPasswordChange
Asterisk VoicemailPasswordChange AMI event referen...
Wink
Raised when a wink occurs on a channel.
Module Configuration
37
View all
Configuration reference for Asterisk modules and resource drivers.
app_agent_pool
Agent pool applications
app_confbridge
Conference Bridge Application
app_skel
cdr
Call Detail Record configuration
cel
chan_motif
Jingle Channel Driver
chan_websocket
Configuration for chan_websocket
codec_opus
This configuration documentation is for functional...
core
This configuration documentation is for functional...
features
Features Configuration
named_acl
res_aeap
Asterisk External Application Protocol (AEAP) modu...
res_ari
HTTP binding for the Stasis API
res_geolocation
Core Geolocation Support
res_hep
Resource for integration with Homer using HEPv3
res_http_media_cache
HTTP media cache
res_mwi_external
Core external MWI support
res_parking
res_pjproject
pjproject common configuration
res_pjsip
SIP Resource using PJProject
res_pjsip_acl
SIP ACL module
res_pjsip_config_wizard
Module that provides simple configuration wizard c...
res_pjsip_endpoint_identifier_ip
Module that identifies endpoints
res_pjsip_notify
Module that supports sending NOTIFY requests to en...
res_pjsip_outbound_publish
SIP resource for outbound publish
res_pjsip_outbound_registration
SIP resource for outbound registrations
res_pjsip_phoneprov_provider
Module that integrates res_pjsip with res_phonepro...
res_pjsip_publish_asterisk
SIP resource for inbound and outbound Asterisk eve...
res_pjsip_pubsub
Module that implements publish and subscribe suppo...
res_prometheus
Resource for integration with Prometheus
res_resolver_unbound
res_statsd
StatsD client
res_stir_shaken
STIR/SHAKEN module for Asterisk
res_websocket_client
Websocket Client Configuration
res_xmpp
XMPP Messaging
stasis
udptl
Compliance
1
View all
Legal and regulatory reference for VoIP and telephony systems.