Applications: Cheat Sheet

226 entries, compact print-friendly format

Applications | AsteriskRecipes.com Cheat Sheet
Name Syntax Synopsis Since
MusicOnHold() MusicOnHold(class[,duration]) Play Music On Hold indefinitely. 0.1.12
ADSIProg()
AELSub() AELSub(routine[,args]) Launch subroutine built with AEL 10.0.0
AGI() AGI(command[,args]) Executes an AGI compliant application. 0.1.9
AMD() AMD([initialSilence,greeting,afterGreetingSilence,totalAnalysisTime,miniumWordLength,betweenWordSilence,maximumNumberOfWords,silenceThreshold,maximumWordLength,audioFile]) Attempt to detect answering machines. 1.4.0
AddQueueMember() AddQueueMember(queuename[,interface,penalty,options,membername,stateinterface,wrapuptime]) Dynamically adds queue members. 0.5.0
AgentLogin() AgentLogin(AgentId[,options]) Login an agent. 12.0.0
AgentRequest() AgentRequest(AgentId) Request an agent to connect with the channel. 12.0.0
AlarmReceiver() AlarmReceiver() Provide support for receiving alarm reports from a burglar or fire alarm panel. 1.0.0
Answer() Answer([delay,options]) Answer a channel if ringing. 13.8.0
AttendedTransfer() AttendedTransfer(exten) Attended transfer to the extension provided and TRANSFER_CONTEXT 13.28.0, 16.5.0
AudioSocket() AudioSocket(uuid,service) Transmit and receive PCM audio between a channel and a TCP socket server. 18.0.0
Authenticate() Authenticate(password[,options,maxdigits,prompt]) Authenticate a user 0.4.0
Background() BackGround(filenames[,options,langoverride,context]) Play an audio file while waiting for digits of an extension to go to. 13.8.0
BackgroundDetect() BackgroundDetect(filename[,sil,min,max,analysistime]) Background a file with talk detect. 1.6.1.0
BlindTransfer() BlindTransfer(exten[,context]) Blind transfer channel(s) to the extension and context provided 13.28.0, 16.5.0
Bridge() Bridge(channel[,options]) Bridge two channels. 1.6.0
BridgeAdd() BridgeAdd(channel) Join a bridge that contains the specified channel. 14.0.0
BridgeWait() BridgeWait([name,role,options]) Put a call into the holding bridge. 12.0.0
Broadcast() Broadcast(channels[,options]) Transmit or receive audio to or from multiple channels simultaneously 18.17.0, 20.2.0
Busy() Busy([timeout]) Indicate the Busy condition. 13.8.0
CELGenUserEvent() CELGenUserEvent(event-name) Generates a CEL User Defined Event. 1.8.0
CallCompletionCancel() CallCompletionCancel() Cancel call completion service 1.8.0
CallCompletionRequest() CallCompletionRequest() Request call completion service for previous call 1.8.0
ChanIsAvail() ChanIsAvail([Technology/Resource,options]) Check channel availability 0.4.0
ChanSpy() ChanSpy([chanprefix,options]) Listen to a channel, and optionally whisper into it. 1.2.0
ChangeMonitor() ChangeMonitor(filename_base) Change monitoring filename of a channel. N/A
ChannelRedirect() ChannelRedirect(channel,priority[,context,extension]) Redirects given channel to a dialplan target 1.4.0
ClearHash() ClearHash(hashname) Clear the keys from a specified hashname. 1.6.0
ConfBridge() ConfBridge(conference[,bridge_profile,user_profile,menu]) Conference bridge application. 12.0.0
ConfKick() ConfKick(conference[,channel]) Kicks channel(s) from the requested ConfBridge. 16.19.0, 18.5.0
Congestion() Congestion([timeout]) Indicate the Congestion condition. 13.8.0
ContinueWhile() ContinueWhile() Restart a While loop. 1.4.0
ControlPlayback() ControlPlayback(filename[,skipms,ff,rew,stop,pause,restart,options]) Play a file with fast forward and rewind. 1.0.0
DAHDIAcceptR2Call() DAHDIAcceptR2Call(charge) Accept an R2 call if its not already accepted (you still need to answer it) 1.6.1.0
DAHDIRAS() DAHDIRAS(args) Executes DAHDI ISDN RAS application. N/A
DAHDIScan() DAHDIScan([group]) Scan DAHDI channels to monitor calls. 1.4.22
DAHDISendCallreroutingFacility() DAHDISendCallreroutingFacility(destination[,original,reason]) Send an ISDN call rerouting/deflection facility message. 1.6.2.0
DAHDISendKeypadFacility() DAHDISendKeypadFacility(digits) Send digits out of band over a PRI. 1.4.22
DBdeltree() DBdeltree(family[/keytree]) Delete a family or keytree from the asterisk database. 0.4.0
DISA() DISA(passcode|filename[,context,cid,mailbox,options]) Direct Inward System Access. 0.1.9
DateTime() DateTime([unixtime,timezone,format]) Says a specified time in a custom format. 0.2.0
DeadAGI() DeadAGI(command,arg1,[arg2[,...]]) Executes AGI on a hungup channel. N/A
Dial() Dial([Technology/Resource,timeout,options,URL]) Attempt to connect to another device or endpoint and bridge the call. 0.1.0
Dictate() Dictate([base_dir,filename]) Virtual Dictation Machine. 1.2.0
Directory() Directory([vm-context,dial-context,options]) Provide directory of voicemail extensions. 0.1.0
DumpChan() DumpChan([level]) Dump Info About The Calling Channel. 1.2.0
EAGI() EAGI(command[,args]) Executes an EAGI compliant application. 0.4.0
Echo() Echo() Echo media, DTMF back to the calling party 0.1.2
Else() Else(expr) Define an optional else branch. 18.16.0, 20.1.0
ElseIf() ElseIf(expr) Start an else if branch. 18.16.0, 20.1.0
EndIf() EndIf() End an if branch. 18.16.0, 20.1.0
EndWhile() EndWhile() End a while loop. 1.2.0
Exec() Exec(appname) Executes dialplan application. 1.0.0
ExecIf() ExecIf(expression?execapp) Executes dialplan application, conditionally. 1.2.0
ExecIfTime() ExecIfTime(day_condition?appname) Conditional application execution based on the current time. 13.8.0
ExitIf() ExitIf() End an If branch. 18.16.0, 20.1.0
ExitWhile() ExitWhile() End a While loop. 1.4.0
ExtenSpy() ExtenSpy(exten[,options]) Listen to a channel, and optionally whisper into it. 1.4.0
ExternalIVR() ExternalIVR(command|ivr://host[,options]) Interfaces with an external IVR application. 1.2.0
Festival() Festival(text[,intkeys]) Say text to the user. 0.2.0
Flash() Flash() Flashes a DAHDI Trunk. 1.6.1.0
FollowMe() FollowMe(followmeid[,options]) Find-Me/Follow-Me application. 1.6.1.0
ForkCDR() ForkCDR([options]) Forks the current Call Data Record for this channel. 1.6.1.0
GetCPEID() GetCPEID() Get ADSI CPE ID. 0.1.12
Gosub() Gosub(priority[,context,extension]) Jump to label, saving return address. 1.2.0
GosubIf() GosubIf(condition?destination) Conditionally jump to label, saving return address. 1.2.0
Goto() Goto(priority[,context,extension]) Jump to a particular priority, extension, or context. 13.8.0
GotoIf() GotoIf(condition?destination) Conditional goto. 13.8.0
GotoIfTime() GotoIfTime(condition?destination) Conditional Goto based on the current time. 13.8.0
Hangup() Hangup([causecode]) Hang up the calling channel. 13.8.0
HangupCauseClear() HangupCauseClear() Clears hangup cause information from the channel that is available through HANGUPCAUSE. 11.0.0
IAX2Provision() IAX2Provision([template]) Provision a calling IAXy with a given template. 1.6.1.0
ICES() ICES(config) Encode and stream using 'ices'. N/A
IVRDemo() IVRDemo(filename) IVR Demo Application. 1.2.0
If() If(expr) Start an if branch. 18.16.0, 20.1.0
ImportVar() ImportVar(newvar=channelname,variable) Import a variable from a channel into a new variable. N/A
Incomplete() Incomplete([n]) Returns AST_PBX_INCOMPLETE value. 13.8.0
JACK() JACK([options]) Jack Audio Connection Kit 1.6.0
JabberJoin() JabberJoin(Jabber,RoomJID[,Nickname]) Join a chat room 12.0.0
JabberLeave() JabberLeave(Jabber,RoomJID[,Nickname]) Leave a chat room 12.0.0
JabberSend() JabberSend(account,jid,message) Sends an XMPP message to a buddy. 12.0.0
JabberSendGroup() JabberSendGroup(Jabber,RoomJID,Message[,Nickname]) Send a Jabber Message to a specified chat room 12.0.0
JabberStatus() JabberStatus(Jabber,JID,Variable) Retrieve the status of a jabber list member N/A
Log() Log(level,message) Send arbitrary text to a selected log level. 1.4.0
MP3Player() MP3Player(Location) Play an MP3 file or M3U playlist file or stream. 0.1.0
MSet() MSet(set1[,set2]) Set channel variable(s) or function value(s). 13.8.0
Macro() Macro(name,arg1,[arg2[,...]]) Macro Implementation. N/A
MacroExclusive() MacroExclusive(name,[arg1,[arg2[,...]]]) Exclusive Macro Implementation. N/A
MacroExit() MacroExit() Exit from Macro. N/A
MacroIf() MacroIf(expr?macroiftrue:[macroiffalse]) Conditional Macro implementation. N/A
MailboxExists() MailboxExists(mailbox@[context],[options]) Check to see if Voicemail mailbox exists. N/A
MeetMe() MeetMe([confno,options,pin]) MeetMe conference bridge. 0.1.12
MeetMeAdmin() MeetMeAdmin(confno,command[,user]) MeetMe conference administration. 1.0.0
MeetMeChannelAdmin() MeetMeChannelAdmin(channel,command) MeetMe conference Administration (channel specific). 1.6.0
MeetMeCount() MeetMeCount(confno[,var]) MeetMe participant count. 0.1.12
MessageSend() MessageSend(destination[,from,to]) Send a text message. 10.0.0
Milliwatt() Milliwatt([options]) Generates a 1004 Hz test tone at 0dbm (mu-law). 0.1.12
MinivmAccMess() MinivmAccMess(mailbox[,options]) Record account specific messages. 1.6.1.0
MinivmDelete() MinivmDelete(filename) Delete Mini-Voicemail voicemail messages. 1.6.1.0
MinivmGreet() MinivmGreet(mailbox[,options]) Play Mini-Voicemail prompts. 1.6.1.0
MinivmMWI() MinivmMWI(mailbox,urgent,new,old) Send Message Waiting Notification to subscriber(s) of mailbox. 1.6.1.0
MinivmNotify() MinivmNotify(mailbox[,options]) Notify voicemail owner about new messages. 1.6.1.0
MinivmRecord() MinivmRecord(mailbox[,options]) Receive Mini-Voicemail and forward via e-mail. 1.6.1.0
MixMonitor() MixMonitor(file[,options,command]) Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee the audio file is a... 1.2.0
Monitor() Monitor(file_format:[urlbase],[fname_base,[options]]]) Monitor a channel. N/A
Morsecode() Morsecode(string) Plays morse code. 1.4.0
NBScat() NBScat() Play an NBS local stream. N/A
NoCDR() NoCDR() Tell Asterisk to not maintain a CDR for this channel. N/A
NoOp() NoOp([text]) Do Nothing (No Operation). 13.8.0
ODBCFinish() ODBCFinish(result-id) Clear the resultset of a sucessful multirow query. 1.6.0
ODBC_Commit() ODBC_Commit([transaction ID]) Commits a currently open database transaction. 13.8.0
ODBC_Rollback() ODBC_Rollback([transaction ID]) Rollback a currently open database transaction. 13.8.0
OSPAuth() OSPAuth([provider,[options]]) OSP Authentication. N/A
OSPFinish() OSPFinish([cause,[options]]) Report OSP entry. N/A
OSPLookup() OSPLookup(exten,[provider,[options]]) Lookup destination by OSP. N/A
OSPNext() Lookup next destination by OSP. N/A
Originate() Originate(tech_data,type,arg1[,arg2,arg3,timeout,options]) Originate a call. 1.6.1.0
PJSIPHangup() PJSIPHangup(Cause) Hangup an incoming PJSIP channel with a SIP response code 18.21.0, 20.6.0, 21.1.0
PJSIPNotify() PJSIPNotify(content[,to]) Send a NOTIFY to either an arbitrary URI, or inside a SIP dialog. 18.25.0, 20.10.0, 21.5.0
Page() Page([Technology/Resource,options,timeout]) Page series of phones 1.2.0
Park() Park([parking_lot_name,options]) Park yourself. 12.0.0
ParkAndAnnounce() ParkAndAnnounce(announce_template,dial[,parking_lot_name,options]) Park and Announce. 12.0.0
ParkedCall() ParkedCall([parking_lot_name,parking_space]) Retrieve a parked call. 12.0.0
PauseMonitor() PauseMonitor() Pause monitoring of a channel. N/A
PauseQueueMember() PauseQueueMember(interface[,queuename,options,reason]) Pauses a queue member. 1.2.0
Pickup() Pickup([targets]) Directed extension call pickup. 1.2.0
PickupChan() PickupChan(channel[,options]) Pickup a ringing channel. 1.6.0
PlayTones() PlayTones(arg) Play a tone list. 1.6.1.0
Playback() Playback(filenames[,options]) Play a file. 0.1.0
PrivacyManager() PrivacyManager([maxretries,minlength,options,context]) Require phone number to be entered, if no CallerID sent 0.4.0
Proceeding() Proceeding() Indicate proceeding. 13.8.0
Progress() Progress() Indicate progress. 13.8.0
Queue() Queue(queuename[,options,URL,announceoverride,timeout,AGI,gosub,rule,position]) Queue a call for a call queue. 0.2.0
QueueLog() QueueLog(queuename,uniqueid,agent,event[,additionalinfo]) Writes to the queue_log file. 1.4.0
QueueUpdate() QueueUpdate(queuename,uniqueid,agent,status,talktime[,params]) Writes to the queue_log file for outbound calls and updates Realtime Data. Is used at h extension to be able to have all... 15.0.0
RaiseException() RaiseException(reason) Handle an exceptional condition. 13.8.0
Read() Read(variable[,filenames,maxdigits,options,attempts,timeout]) Read a variable. 1.6.1.0
ReadExten() ReadExten(variable[,filename,context,option,timeout]) Read an extension into a variable. 1.6.0
ReceiveFAX() ReceiveFAX(filename[,options]) Receive a FAX and save as a TIFF/F file. 11.0.0
ReceiveMF() ReceiveMF(variable[,timeout,options]) Detects MF digits on a channel and saves them to a variable. 16.24.0, 18.10.0
ReceiveSF() ReceiveSF(variable[,digits,timeout,frequency,options]) Detects SF digits on a channel and saves them to a variable. 16.24.0, 18.10.0, 19.2.0
ReceiveText() ReceiveText([timeout]) Receive a Text Message on a channel. 16.24.0, 18.10.0, 19.2.0
Record() Record(filename[,silence,maxduration,options]) Record to a file. 0.1.8
Reload() Reload([module]) Reloads an Asterisk module, blocking the channel until the reload has completed. 16.20.0, 18.6.0
RemoveQueueMember() RemoveQueueMember(queuename[,interface]) Dynamically removes queue members. 0.5.0
ResetCDR() ResetCDR([options]) Resets the Call Data Record. 12.0.0
RetryDial() RetryDial(announce,sleep,retries,dialargs) Place a call, retrying on failure allowing an optional exit extension. 1.2.0
Return() Return([value]) Return from gosub routine. 1.2.0
Ringing() Ringing() Indicate ringing tone. 13.8.0
SIPAddHeader() SIPAddHeader(Header:Content) Add a SIP header to the outbound call. N/A
SIPDtmfMode() SIPDtmfMode(mode) Change the dtmfmode for a SIP call. N/A
SIPRemoveHeader() SIPRemoveHeader([Header]) Remove SIP headers previously added with SIPAddHeader N/A
SIPSendCustomINFO() SIPSendCustomINFO(Data,[UserAgent]) Send a custom INFO frame on specified channels. N/A
SLAStation() SLAStation(station) Shared Line Appearance Station. 21.0.0
SLATrunk() SLATrunk(trunk[,options]) Shared Line Appearance Trunk. 21.0.0
SMS() SMS(name[,options,addr,body]) Communicates with SMS service centres and SMS capable analogue phones. 1.6.1.0
SayAlpha() SayAlpha(string) Say Alpha. 13.8.0
SayAlphaCase() SayAlphaCase(casetype,string) Say Alpha. 13.8.0
SayCountedAdj() SayCountedAdj(number,filename[,gender]) Say a adjective in declined form in order to count things 1.8.0
SayCountedNoun() SayCountedNoun(number,filename) Say a noun in declined form in order to count things 1.8.0
SayDigits() SayDigits(digits) Say Digits. 13.8.0
SayMoney() SayMoney(dollars) Say Money. 16.21.0, 18.7.0
SayNumber() SayNumber(digits[,gender]) Say Number. 13.8.0
SayOrdinal() SayOrdinal(digits[,gender]) Say Ordinal Number. 16.21.0, 18.7.0
SayPhonetic() SayPhonetic(string) Say Phonetic. 13.8.0
SayUnixTime() SayUnixTime([unixtime,timezone,format,options]) Says a specified time in a custom format. 0.7.0
SendDTMF() SendDTMF(digits[,timeout_ms,duration_ms,channel,options]) Sends arbitrary DTMF digits 0.3.0
SendFAX() SendFAX(filename[,options]) Sends a specified TIFF/F file as a FAX. 11.0.0
SendImage() SendImage(filename) Sends an image file. N/A
SendMF() SendMF(digits[,timeout_ms,duration_ms,duration_ms_kp,duration_ms_st,channel]) Sends arbitrary MF digits on the current or specified channel. 16.21.0, 18.7.0
SendSF() SendSF(digits[,frequency,channel]) Sends arbitrary SF digits on the current or specified channel. 16.24.0, 18.10.0, 19.2.0
SendText() SendText([text]) Send a Text Message on a channel. 1.0.0
SendURL() SendURL(URL,[option]) Send a URL. N/A
Set()
SetAMAFlags() SetAMAFlags([flag]) Set the AMA Flags. N/A
Signal() Signal(signalname[,payload]) Sends a signal to any waiting channels. 18.17.0, 20.2.0
SkelGuessNumber() SkelGuessNumber(level[,options]) An example number guessing game 11.0.0
SoftHangup() SoftHangup(Technology/Resource[,options]) Hangs up the requested channel. 0.4.0
SpeechActivateGrammar() SpeechActivateGrammar(grammar_name) Activate a grammar. 1.6.1.0
SpeechBackground() SpeechBackground(sound_file[,timeout,options]) Play a sound file and wait for speech to be recognized. 1.6.1.0
SpeechCreate() SpeechCreate(engine_name) Create a Speech Structure. 1.6.1.0
SpeechDeactivateGrammar() SpeechDeactivateGrammar(grammar_name) Deactivate a grammar. 1.6.1.0
SpeechDestroy() SpeechDestroy() End speech recognition. 1.6.1.0
SpeechLoadGrammar() SpeechLoadGrammar(grammar_name,path) Load a grammar. 1.6.1.0
SpeechProcessingSound() SpeechProcessingSound(sound_file) Change background processing sound. 1.6.1.0
SpeechStart() SpeechStart() Start recognizing voice in the audio stream. 1.6.1.0
SpeechUnloadGrammar() SpeechUnloadGrammar(grammar_name) Unload a grammar. 1.6.1.0
StackPop() StackPop() Remove one address from gosub stack. 1.2.0
StartMusicOnHold() StartMusicOnHold(class) Play Music On Hold. 1.2.0
Stasis() Stasis(app_name[,args]) Invoke an external Stasis application. 12.0.0
StatsD() StatsD(metric_type,statistic_name,value[,sample_rate]) Allow statistics to be passed to the StatsD server from the dialplan. 13.20.0, 15.3.0
StopMixMonitor() StopMixMonitor([MixMonitorID]) Stop recording a call through MixMonitor, and free the recording's file handle. 1.4.0
StopMonitor() StopMonitor() Stop monitoring a channel. N/A
StopMusicOnHold() StopMusicOnHold() Stop playing Music On Hold. 1.2.0
StopPlayTones() StopPlayTones() Stop playing a tone list. 1.6.1.0
StoreDTMF() StoreDTMF(direction) Stores DTMF digits transmitted or received on a channel. 16.20.0, 18.6.0
StreamEcho() StreamEcho([num,type]) Echo media, up to 'N' streams of a type, and DTMF back to the calling party 15.0.0
System() System(command) Execute a system command. 0.1.2
TestClient() TestClient(testid) Execute Interface Test Client. 1.0.0
TestServer() TestServer() Execute Interface Test Server. 1.0.0
ToneScan() ToneScan([zone,timeout,threshold,options]) Wait for period of time while scanning for call progress tones 16.23.0, 18.9.0, 19.1.0
Transfer() Transfer(dest) Transfer caller to remote extension. 0.5.0
TryExec() TryExec(appname) Executes dialplan application, always returning. 1.4.0
TrySystem() TrySystem(command) Try executing a system command. 1.0.0
UnpauseMonitor() UnpauseMonitor() Unpause monitoring of a channel. N/A
UnpauseQueueMember() UnpauseQueueMember(interface[,queuename,options,reason]) Unpauses a queue member. 1.2.0
UserEvent() UserEvent(eventname[,body]) Send an arbitrary user-defined event to parties interested in a channel (AMI users and relevant res_stasis applications)... 1.0.0
VMAuthenticate() VMAuthenticate(mailbox[,options]) Authenticate with Voicemail passwords. 1.2.0
VMSayName() VMSayName(mailbox) Play the name of a voicemail user 1.8.0
Verbose() Verbose(message[,level]) Send arbitrary text to verbose output. 1.0.0
VoiceMail() VoiceMail(mailboxs[,options]) Leave a Voicemail message. 0.1.0
VoiceMailMain() VoiceMailMain(mailbox[,options]) Check Voicemail messages. 0.1.0
VoiceMailPlayMsg() VoiceMailPlayMsg(mailbox,msg_id) Play a single voice mail msg from a mailbox by msg id. 11.0.0
Wait() Wait(seconds) Waits for some time. 13.8.0
WaitDigit() WaitDigit([seconds,digits]) Waits for a digit to be entered. 15.0.0
WaitExten() WaitExten([seconds,options]) Waits for an extension to be entered. 13.8.0
WaitForCondition() WaitForCondition(replacementchar,expression[,timeout,interval]) Wait (sleep) until the given condition is true. 16.20.0, 18.6.0
WaitForNoise() WaitForNoise([noiserequired,iterations,timeout]) Waits for a specified amount of noise. 1.6.1.0
WaitForRing() WaitForRing(timeout) Wait for Ring Application. 0.4.0
WaitForSignal() WaitForSignal(signalname[,signaltimeout]) Waits for a named signal on a channel. 18.17.0, 20.2.0
WaitForSilence() WaitForSilence([silencerequired,iterations,timeout]) Waits for a specified amount of silence. 1.2.0
WaitForTone() WaitForTone(freq[,duration_ms,timeout,times,options]) Wait for tone 16.21.0, 18.7.0
WaitUntil() WaitUntil(epoch) Wait (sleep) until the current time is the given epoch. 1.6.0
While() While(expr) Start a while loop. 1.2.0
Zapateller() Zapateller(options) Block telemarketers with SIT. 0.1.12