Applications 199

A

ADSIProg() AELSub() Execute the named subroutine, defined in AEL, from another dialplan language, such as extensions.con... AGI() Executes an Asterisk Gateway Interface compliant program on a channel. AGI allows Asterisk to launch... AMD() Attempts to detect answering machines at the beginning of outbound calls. Simply call this applicati... AgentLogin() Login an agent to the system. Any agent authentication is assumed to already be done by dialplan. As... AgentRequest() Request an agent to connect with the channel. Failure to find, alert the agent, or acknowledge the c... AlarmReceiver() Provide support for receiving alarm reports from a burglar or fire alarm panel. AttendedTransfer() Attended transfer to the extension provided and TRANSFER_CONTEXT AudioSocket() Transmit and receive PCM audio between a channel and a TCP socket server. Authenticate() Asks the caller to enter a given password in order to continue dialplan execution. Asterisk dialplan...

B

BackgroundDetect() Plays back filename, waiting for interruption from a given digit (the digit must start the beginning... BlindTransfer() Blind transfer channel(s) to the extension and context provided Bridge() Allows the ability to bridge two channels via the dialplan. This application sets the following chan... BridgeAdd() Join a bridge that contains the specified channel. BridgeWait() Places the incoming channel into a holding bridge. The channel will then wait in the holding bridge ... Broadcast() Transmit or receive audio to or from multiple channels simultaneously Busy() Indicate the Busy condition.

C

CELGenUserEvent() A CEL event will be immediately generated by this channel, with the supplied name for a type. Asteri... CallCompletionCancel() Cancel a Call Completion Request. This application sets the following channel variables: CCCANCELRES... CallCompletionRequest() Request call completion service for a previously failed call attempt. This application sets the foll... ChanIsAvail() Will check to see if any of the specified channels are available. This application sets the followin... ChanSpy() Listen to a channel, and optionally whisper into it. ChangeMonitor() Changes monitoring filename of a channel. Has no effect if the channel is not monitored. Asterisk di... ChannelRedirect() Sends the specified channel to the specified extension priority This application sets the following ... ClearHash() Clear the keys from a specified hashname. ConfKick() Kicks the requested channel(s) from a conference bridge. CONFKICKSTATUS FAILURE - Could not kick any... Congestion() Indicate the Congestion condition. ContinueWhile() Restart a While loop. ControlPlayback() Will play back the given filename. It sets the following channel variables upon completion: CPLAYBAC...

D

DAHDIAcceptR2Call() Accept an R2 call if its not already accepted (you still need to answer it) DAHDIRAS() Executes a RAS server using pppd on the given channel. The channel must be a clear channel (i.e. Ast... DAHDIScan() Allows a call center manager to monitor DAHDI channels in a convenient way. Use '#' to select the ne... DAHDISendCallreroutingFacility() Send an ISDN call rerouting/deflection facility message. DAHDISendKeypadFacility() Will send the given string of digits in a Keypad Facility IE over the current channel. Asterisk dial... DBdeltree() Delete a family or keytree from the asterisk database. DISA() The DISA, Direct Inward System Access, application allows someone from outside the telephone switch ... DateTime() Says a specified time in a custom format. DeadAGI() Is deprecated and may be removed in a future version of Asterisk. Use the replacement application 'A... Dictate() Virtual Dictation Machine. Directory() Will present the calling channel with a directory of extensions from which they can search by name. ... DumpChan() Displays information on channel and listing of all channel variables. If level is specified, output ...

E

EAGI() Using 'EAGI' provides enhanced AGI, with incoming audio available out of band on file descriptor 3. ... Else() Define an optional else branch. ElseIf() Start an optional ElseIf branch. Execution will continue inside the branch if expr is true and if pr... EndIf() End an if branch. EndWhile() End a while loop. Exec() ExecIf() If expr is true, execute and return the result of appiftrue(args). If expr is true, but appiftrue is... ExecIfTime() Conditional application execution based on the current time. ExitIf() End an If branch. ExitWhile() End a While loop. ExtenSpy() Listen to a channel, and optionally whisper into it. ExternalIVR() Either forks a process to run given command or makes a socket to connect to given host and starts a ...

F

Festival() Connect to Festival, send the argument, get back the waveform, play it to the user, allowing any giv... Flash() Performs a flash on a DAHDI trunk. This can be used to access features provided on an incoming analo... ForkCDR() Forks the current Call Data Record for this channel.

G

GetCPEID() Get ADSI CPE ID. GosubIf() Conditionally jump to label, saving return address.

H

HangupCauseClear() Clears hangup cause information from the channel that is available through HANGUPCAUSE.

I

IAX2Provision() Provisions the calling IAXy (assuming the calling entity is in fact an IAXy) with the given template... ICES() Streams to an icecast server using ices (available separately). A configuration file must be supplie... IVRDemo() This is a skeleton application that shows you the basic structure to create your own asterisk applic... If() Start an if branch. ImportVar() Import a variable from a channel into a new variable. Incomplete() Signals the PBX routines that the previous matched extension is incomplete and that further input sh...

J

JACK() When executing this application, two jack ports will be created; one input and one output. Asterisk ... JabberJoin() Join a chat room JabberLeave() Leave a chat room JabberSend() Sends the content of message as text message from the given account to the buddy identified by jid T... JabberSendGroup() Allows user to send a message to a chat room via XMPP. To be able to send messages to a chat room, a... JabberStatus() Is deprecated. Please use the JABBER\STATUS() function instead. Retrieves the numeric status associa...

L

Log() Send arbitrary text to a selected log level.

M

MusicOnHold() Play hold music on a channel, blocking until the caller hangs up or the specified duration expires. ... MP3Player() Play an MP3 file or M3U playlist file or stream. MSet() Can be used to set the value of channel variables or dialplan functions. When setting variables, if ... Macro() Executes a macro using the context macro- name, jumping to the 's' extension of that context and exe... MacroExclusive() Executes macro defined in the context macro- name. Only one call at a time may run the macro. Asteri... MacroExit() Causes the currently running macro to exit as if it had ended normally by running out of priorities ... MacroIf() Executes macro defined in macroiftrue if expr is true (otherwise macroiffalse if provided) Arguments... MailboxExists() DEPRECATED. Use VM\INFO(mailbox\[@context\],exists) instead. /// Check to see if the specified mailb... MeetMe() MeetMe conference bridge. MeetMeAdmin() Run admin command for conference confno. Will additionally set the variable MEETMEADMINSTATUS with o... MeetMeChannelAdmin() MeetMe conference Administration (channel specific). MeetMeCount() Plays back the number of users in the specified MeetMe conference. If var is specified, playback wil... MessageSend() Send a text message. The body of the message that will be sent is what is currently set to 'MESSAGE(... Milliwatt() Generates a 1004 Hz test tone. By default, this application does not provide a Milliwatt test tone. ... MinivmAccMess() Is part of the Mini-Voicemail system, configured in minivm.conf. Use this application to record acco... MinivmDelete() Is part of the Mini-Voicemail system, configured in minivm.conf. It deletes voicemail file set in MV... MinivmGreet() Is part of the Mini-Voicemail system, configured in minivm.conf. MinivmGreet() plays default prompts... MinivmMWI() Send Message Waiting Notification to subscriber(s) of mailbox. MinivmNotify() Is part of the Mini-Voicemail system, configured in minivm.conf. MiniVMnotify forwards messages abou... MinivmRecord() Is part of the Mini-Voicemail system, configured in minivm.conf MiniVM records audio file in configu... MixMonitor() Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee... Monitor() Used to start monitoring a channel. The channel's input and output voice packets are logged to files... Morsecode() Plays the Morse code equivalent of the passed string. This application does not automatically answer...

N

NBScat() Executes nbscat to listen to the local NBS stream. User can exit by pressing any key. Asterisk dialp... NoCDR() Tell Asterisk to not maintain a CDR for this channel.

O

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: OSPINPEERIP - The last hop IP address. OSPINTOKEN - The... OSPFinish() Report call state. Input variables: OSPINHANDLE - The inbound call OSP transaction handle. OSPOUTHAN... OSPLookup() Looks up destination via OSP. Input variables: OSPINACTUALSRC - The actual source device IP address ... OSPNext() Looks up the next destination via OSP. Input variables: OSPINHANDLE - The inbound call OSP transacti... Originate() Originates an outbound call and connects it to a specified extension or application. Asterisk dialpl...

P

PJSIPHangup() Hangup an incoming PJSIP channel with a SIP response code PJSIPNotify() Send a NOTIFY to either an arbitrary URI, or inside a SIP dialog. Page() Page series of phones ParkAndAnnounce() Park a call into the parkinglot and announce the call to another channel. The variable PARKEDAT will... ParkedCall() Used to retrieve a parked call from a parking lot. If a parking lot's parkext option is set, then Pa... PauseMonitor() Pauses monitoring of a channel until it is re-enabled by a call to UnpauseMonitor. Asterisk dialplan... PauseQueueMember() Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue. Ast... PickupChan() Pickup a ringing channel. PlayTones() Plays a tone list. Execution will continue with the next step in the dialplan immediately while the ... PrivacyManager() Require phone number to be entered, if no CallerID sent Proceeding() Indicate proceeding. Progress() Will request that in-band progress information be provided to the calling channel. Asterisk dialplan...

Q

QueueLog() Writes to the queue_log file. QueueUpdate() Writes to the queue_log file for outbound calls and updates Realtime Data. Is used at h extension to...

R

RaiseException() Will jump to the 'e' extension in the current context, setting the dialplan function EXCEPTION(). As... ReadExten() Reads a '#' terminated string of digits from the user into the given variable. Will set READEXTENSTA... ReceiveFAX() Is provided by res\_fax, which is a FAX technology agnostic module that utilizes FAX technology reso... ReceiveMF() Detects MF digits on a channel and saves them to a variable. ReceiveSF() Detects SF digits on a channel and saves them to a variable. ReceiveText() Waits for timeout seconds on the current channel to receive text. Result of transmission will be sto... Reload() Reloads an Asterisk module, blocking the channel until the reload has completed. RemoveQueueMember() If the interface is NOT in the queue it will return an error. This application sets the following ch... ResetCDR() Causes the Call Data Record to be reset. Depending on the flags passed in, this can have several eff... RetryDial() Place a call, retrying on failure allowing an optional exit extension. Ringing() Indicate ringing tone.

S

StartMusicOnHold() Start background music on a channel without blocking the dialplan. Use StartMusicOnHold when you nee... StopMixMonitor() Stop recording a call through MixMonitor, and free the recording's file handle. SIPAddHeader() Adds a header to a SIP call placed with DIAL. Remember to use the X-header if you are adding non-sta... SIPDtmfMode() Changes the dtmfmode for a SIP call. Asterisk dialplan application reference. SIPRemoveHeader() Remove SIP headers previously added with SIPAddHeader SIPSendCustomINFO() SIPSendCustomINFO() allows you to send a custom INFO message on all active SIP channels or on channe... SLAStation() Should be executed by an SLA station. The argument depends on how the call was initiated. Asterisk d... SLATrunk() Should be executed by an SLA trunk on an inbound call. The channel calling this application should c... SMS() Communicates with SMS service centres and SMS capable analogue phones. SayAlpha() Will play the sounds that correspond to the letters of the given string. If the channel variable SAY... SayAlphaCase() Say Alpha. SayCountedAdj() Say a adjective in declined form in order to count things SayCountedNoun() Say a noun in declined form in order to count things SayMoney() Will play the currency sounds for the given floating point number in the current language. Currently... SayNumber() Will play the sounds that correspond to the given digits. Optionally, a gender may be specified. Ast... SayOrdinal() Say Ordinal Number. SayPhonetic() Will play the sounds from the phonetic alphabet that correspond to the letters in the given string. ... SayUnixTime() Uses some of the sound files stored in /var/lib/asterisk/sounds to construct a phrase saying the spe... SendDTMF() Sends arbitrary DTMF digits SendFAX() Is provided by res\_fax, which is a FAX technology agnostic module that utilizes FAX technology reso... SendImage() Send an image file on a channel supporting it. Result of transmission will be stored in SENDIMAGESTA... SendMF() Sends arbitrary MF digits on the current or specified channel. SendSF() Sends arbitrary SF digits on the current or specified channel. SendText() Sends text to the current channel. current channel could be the caller or callee depending on the co... SendURL() Requests client go to URL (IAX2) or sends the URL to the client (other channels). Result is returned... SetAMAFlags() Will set the channel's AMA Flags for billing purposes. This application is deprecated. Please use th... Signal() Sends a signal to any waiting channels. SkelGuessNumber() This simple number guessing application is a template to build other applications from. Asterisk dia... SoftHangup() Hangs up the requested channel. If there are no channels to hangup, the application will report it. ... SpeechActivateGrammar() This activates the specified grammar to be recognized by the engine. A grammar tells the speech reco... SpeechBackground() Play a sound file and wait for speech to be recognized. SpeechCreate() Creates information to be used by all the other applications. It must be called before doing any spe... SpeechDeactivateGrammar() This deactivates the specified grammar so that it is no longer recognized. Hangs up the channel on f... SpeechDestroy() This destroys the information used by all the other speech recognition applications. Asterisk dialpl... SpeechLoadGrammar() Load a grammar. SpeechProcessingSound() This changes the processing sound that SpeechBackground plays back when the speech recognition engin... SpeechStart() Tell the speech recognition engine that it should start trying to get results from audio being fed t... SpeechUnloadGrammar() Unload a grammar. Hangs up the channel on failure. If this is not desired, use TryExec. Asterisk dia... StackPop() Remove one address from gosub stack. Stasis() Invoke a Stasis application. This application will set the following channel variable upon completio... StatsD() Allow statistics to be passed to the StatsD server from the dialplan. StopMonitor() Stops monitoring a channel. Has no effect if the channel is not monitored. Asterisk dialplan applica... StopMusicOnHold() Asterisk StopMusicOnHold dialplan application reference. Complete documentation with syntax, argumen... StopPlayTones() Stop playing a tone list. StoreDTMF() Stores DTMF digits transmitted or received on a channel. StreamEcho() Echo media, up to 'N' streams of a type, and DTMF back to the calling party

T

TestClient() Execute Interface Test Client. TestServer() Execute Interface Test Server. ToneScan() Wait for period of time while scanning for call progress tones Transfer() Requests the remote caller be transferred to a given destination. If TECH (SIP, IAX2, etc) is used, ... TryExec() Allows an arbitrary application to be invoked even when not hard coded into the dialplan. To invoke ... TrySystem() Executes a command by using system(). Result of execution is returned in the SYSTEMSTATUS channel va...

U

UnpauseMonitor() Unpauses monitoring of a channel on which monitoring had previously been paused with PauseMonitor. A... UnpauseQueueMember() Unpauses (resumes calls to) a queue member. This is the counterpart to 'PauseQueueMember()' and oper... UserEvent() Send an arbitrary user-defined event to parties interested in a channel (AMI users and relevant res_...

V

VMAuthenticate() Authenticate with Voicemail passwords. VMSayName() Will say the recorded name of the voicemail user specified as the argument to this application. If n... Verbose() Send arbitrary text to verbose output. VoiceMailPlayMsg() Play a single voice mail msg from a mailbox by msg id.

W

WaitDigit() Waits for the user to press one of the accepted digits for a specified number of seconds. Asterisk d... WaitForCondition() Waits until expression evaluates to true, checking every interval seconds for up to timeout. Asteris... WaitForNoise() Waits for up to noiserequired milliseconds of noise, iterations times. An optional timeout specified... WaitForRing() Returns '0' after waiting at least timeout seconds, and only after the next ring has completed. Retu... WaitForSignal() Waits for signaltimeout seconds on the current channel to receive a signal with name signalname. Act... WaitForSilence() Waits for up to silencerequired milliseconds of silence, iterations times. An optional timeout speci... WaitForTone() Waits for a single-frequency tone to be detected before dialplan execution continues. WAITFORTONESTA... WaitUntil() Wait (sleep) until the current time is the given epoch. While() Start a while loop.

Z

Zapateller() Generates special information tone to block telemarketers from calling you. This application will se...