| Answer |
| Answer - Answer a channel if ringing |
| Answer(): If the channel is ringing, answer it, otherwise do nothing. Returns 0 unless it tries to answer the channel and fails. | |
| Goto |
| Goto - Goto a particular priority, extension, or context |
| Goto([[context|]extension|]priority): Set the priority to the specified value, optionally setting the extension and optionally the context as well. The extension BYEXTENSION is special in that it uses the current extension, thus permitting you to go to a different context, without specifying a specific extension. Always returns 0, even if the given context, extension, or priority is invalid. | |
| Hangup |
| Hangup - Unconditional hangup |
| Hangup(): Unconditionally hangs up a given channel by returning -1 always. | |
| DigitTimeout |
| DigitTimeout - Set maximum timeout between digits |
| DigitTimeout(seconds): Set the maximum amount of time permitted between digits when the user is typing in an extension. When this timeout expires, after the user has started to type in an extension, the extension will be considered complete, and will be interpreted. Note that if an extension typed in is valid, it will not have to timeout to be tested, so typically at the expiry of this timeout, the extension will be considered invalid (and thus control would be passed to the 'i' extension, or if it doesn't exist the call would be terminated). Always returns 0. | |
| ResponseTimeout |
| ResponseTimeout - Set maximum timeout awaiting response |
| ResponseTimeout(seconds): Set the maximum amount of time permitted after falling through a series of priorities for a channel in which the user may begin typing an extension. If the user does not type an extension in this amount of time, control will pass to the 't' extension if it exists, and if not the call would be terminated. Always returns 0. | |
| AbsoluteTimeout |
| AbsoluteTimeout - Set absolute maximum time of call |
| AbsoluteTimeout(seconds): Set the absolute maximum amount of time permitted for a call. A setting of 0 disables the timeout. Always returns 0. | |
| BackGround |
| BackGround - Play a file while awaiting extension |
| Background(filename): Plays a given file, while simultaneously waiting for the user to begin typing an extension. The timeouts do not count until the last BackGround application as ended. Always returns 0. | |
| Wait |
| Wait - Waits for some time |
| Wait(seconds): Waits for a specified number of seconds, then returns 0. | |
| StripMSD |
| StripMSD - Strip leading digits |
| StripMSD(count): Strips the leading 'count' digits from the channel's associated extension. For example, the number 5551212 when stripped with a count of 3 would be changed to 1212. This app always returns 0, and the PBX will continue processing at the next priority for the *new* extension. So, for example, if priority 3 of 5551212 is StripMSD 3, the next step executed will be priority 4 of 1212. If you switch into an extension which has no first step, the PBX will treat it as though the user dialed an invalid extension. | |
| Prefix |
| Prefix - Prepend leading digits |
| Prefix(digits): Prepends the digit string specified by digits to the channel's associated extension. For example, the number 1212 when prefixed with '555' will become 5551212. This app always returns 0, and the PBX will continue processing at the next priority for the *new* extension. So, for example, if priority 3 of 1212 is Prefix 555, the next step executed will be priority 4 of 5551212. If you switch into an extension which has no first step, the PBX will treat it as though the user dialed an invalid extension. | |
| SetLanguage |
| SetLanguage - Sets user language |
| SetLanguage(language): Set the channel language to 'language'. This information is used for the generation of numbers, and to select a natural language file when available. For example, if language is set to 'fr' and the file 'demo-congrats' is requested to be played, if the file 'demo- congrats-fr' exists, then it will play that file, and if not will play the normal 'demo-congrats'. Always returns 0. | |
| Ringing |
| Ringing - Indicate ringing tone |
| Ringing(): Request that the channel indicate ringing tone to the user. Always returns 0. | |
| Congestion |
| Congestion - Indicate congestion and stop |
| Congestion(): Requests that the channel indicate congestion and then waits for the user to hang up. Always returns -1. | |
| Busy |
| Busy - Indicate busy condition and stop |
| Busy(): Requests that the channel indicate busy condition and then waits for the user to hang up. Always returns -1. | |
| SetVar |
| SetVar - Set variable to value |
| Setvar(#n=value): Sets variable n to value | |
| SetGlobalVar |
| SetGlobalVar - Set variable to value |
| Setvar(#n=value): Sets global variable n to value | |
| NoOp |
| NoOp - No operation |
| NoOp(): No-operation; Does nothing. | |
| GotoIf |
| GotoIf - Conditional goto |
| GotoIf(Condition?label1:label2): Go to label 1 if condition is true, to label2 if condition is false. Either label1 or label2 may be omitted (in that case, we just don't take the particular branch) but not both. Look for the condition syntax in examples or documentation. | |
| ADSIProg |
| Asterisk ADSI Programming Application - Load Asterisk ADSI Scripts into phone |
| ADSIProg(script): Programs an ADSI Phone with the given script. If none is specified, the default is used. Returns 0 unless CPE is hungup. | |
| AGI |
| Asterisk Gateway Interface (AGI) - Executes an AGI compliant application |
| [E]AGI(command|args): Executes an Asterisk Gateway Interface compliant program on a channel. AGI allows Asterisk to launch external programs written in any language to control a telephony channel, play audio, read DTMF digits, etc. by communicating with the AGI protocol on stdin and stdout. Returns -1 on hangup or if application requested hangup, or 0 on non-hangup exit. Using 'EAGI' provides enhanced AGI, with audio available out of band on file descriptor 3 | |
| Authenticate |
| Authentication Application - Authenticate a user |
Authenticate(password[|options]): Requires a user to enter a given password in order to continue execution. If the password begins with the '/' character, it is interpreted as a file which contains a list of valid passwords (1 per line). an optional set of opions may be provided by concatenating any of the following letters:
a - Set account code to the password that is entered
Returns 0 if the user enters a valid password within three tries, or -1 otherwise (or on hangup). | |
| ChanIsAvail |
| Check if channel is available - Check if channel is available |
| ChanIsAvail(Technology/resource[&Technology2/resource2...]): Checks is any of the requested channels are available. If none of the requested channels are available the new priority will be n+101 (unless such a priority does not exist, in which case ChanIsAvail will return -1. If any of the requested channels are available, the next priority will be n+1, the channel variable ${CHANAVAIL} will be set to the name of the available channel and the ChanIsAvail app will return 0. | |
| DateTime |
| Date and Time - Say the date and time |
| DateTime(): Says the current date and time. Returns -1 on hangup or 0 otherwise. | |
| DBget |
| Database access functions for Asterisk extension logic - Retrieve a value from the database |
| DBget(varname=family/key): Retrieves a value from the Asterisk database and stores it in the given variable. Always returns 0. If the requested key is not found, jumps to priority n+101 if available. | |
| DBput |
| Database access functions for Asterisk extension logic - Store a value in the database |
| DBput(family/key=value): Stores the given value in the Asterisk database. Always returns 0. | |
| DBdel |
| Database access functions for Asterisk extension logic - Delete a key from the database |
| DBdel(family/key): Deletes a key from the Asterisk database. Always returns 0. | |
| DBdeltree |
| Database access functions for Asterisk extension logic - Delete a family or keytree from the database |
| DBdeltree(family[/keytree]): Deletes a family or keytree from the Asterisk database. Always returns 0. | |
| Dial |
| Dialing Application - Place an call and connect to the current channel |
Dial(Technology/resource[&Technology2/resource2...][|timeout][|options][|URL]): Requests one or more channels and places specified outgoing calls on them. As soon as a channel answers, the Dial app will answer the originating channel (if it needs to be answered) and will bridge a call with the channel which first answered. All other calls placed by the Dial app will be hunp up If a timeout is not specified, the Dial application will wait indefinitely until either one of the called channels answers, the user hangs up, or all channels return busy or error. In general, the dialler will return 0 if it was unable to place the call, or the timeout expired. However, if all channels were busy, and there exists an extension with priority n+101 (where n is the priority of the dialler instance), then it will be the next executed extension (this allows you to setup different behavior on busy from no-answer). This application returns -1 if the originating channel hangs up, or if the call is bridged and either of the parties in the bridge terminate the call. The option string may contain zero or more of the following characters:
't' -- allow the called user transfer the calling user
'T' -- to allow the calling user to transfer the call.
'r' -- indicate ringing to the calling party, pass no audio until answered.
'm' -- provide hold music to the calling party until answered.
'd' -- data-quality (modem) call (minimum delay).
'c' -- clear-channel data call (PRI-PRI only).
'H' -- allow caller to hang up by hitting *.
'C' -- reset call detail record for this call.
'P[(x)]' -- privacy mode, using 'x' as database if provided.
In addition to transferring the call, a call may be parked and then picked up by another user. The optionnal URL will be sent to the called party if the channel supports it. | |
| Directory |
| Extension Directory - Provide directory of voicemail extensions |
| Directory(context): Presents the user with a directory of extensions from which they may select by name. The list of names and extensions is discovered from voicemail.conf. The context argument is required, and specifies the context in which to interpret the extensions. Returns 0 unless the user hangs up. It also sets up the channel on exit to enter the extension the user selected. | |
| DISA |
| DISA (Direct Inward System Access) Application - DISA (Direct Inward System Access) |
| DISA (Direct Inward System Access) -- Allows someone from outside the telephone switch (PBX) to obtain an "internal" system dialtone and to place calls from it as if they were placing a call from within the switch. A user calls a number that connects to the DISA application and is given dialtone. The user enters their passcode, followed by the pound sign (#). If the passcode is correct, the user is then given system dialtone on which a call may be placed. Obviously, this type of access has SERIOUS security implications, and GREAT care must be taken NOT to compromise your security.
There is a possibility of accessing DISA without password. Simply exchange your password with no-password.
Example: exten => s,1,DISA,no-password|local
but be aware of using this for your security compromising.
The arguments to this application (in extensions.conf) allow either specification of a single global password (that everyone uses), or individual passwords contained in a file. It also allow specification of the context on which the user will be dialing. If no context is specified, the DISA application defaults the context to "disa" presumably that a normal system will have a special context set up for DISA use with some or a lot of restrictions. The arguments are one of the following:
numeric-passcode numeric-passcode|context full-pathname-of-file-that-contains-passcodes
The file that contains the passcodes (if used) allows specification of either just a passcode (defaulting to the "disa" context, or passcode|context on each line of the file. The file may contain blank lines, or comments starting with "#" or ";". In addition, the above arguments may have |new-callerid-string appended to them, to specify a new (different) callerid to be used for this call, for
example: numeric-passcode|context|"My Phone" <(234) 123-4567> or full-pathname-of-passcode-file|"My Phone" <(234) 123-4567>. Note that in the case of specifying the numeric-passcode, the context must be specified if the callerid is specified also.
If login is successful, the application parses the dialed number in the specified (or default) context, and returns 0 with the new extension context filled-in and the priority set to 1, so that the PBX may re-apply the routing tables to it and complete the call normally. | |
| Echo |
| Simple Echo Application - Echo audio read back to the user |
| Echo(): Echo audio read from channel back to the channel. Returns 0 if the user exits with the '#' key, or -1 if the user hangs up. | |
| Festival |
| Simple Festival Interface - Say text to the user |
| Festival(): Connect to Festival, send the argument, get back the waveform, play it to the user. | |
| Flash |
| Flash zap trunk application - Flashes a Zap Trunk |
| Flash(): Sends a flash on a zap trunk. This is only a hack for people who want to perform transfers and such via AGI and is generally quite useless otherwise. Returns 0 on success or -1 if this is not a zap trunk | |
| GetCPEID |
| Get ADSI CPE ID - Get ADSI CPE ID |
| GetCPEID: Obtains and displays CPE ID and other information in order to properly setup zapata.conf for on-hook operations. Returns -1 on hangup only. | |
| SendImage |
| Image Transmission Application - Send an image file |
| SendImage(filename): Sends an image on a channel. If the channel does not support image transport, and there exists a step with priority n + 101, then execution will continue at that step. Otherwise, execution will continue at the next priority level. SendImage only returns 0 if the image was sent correctly or if the channel does not support image transport, and -1 otherwise. | |
| Intercom |
| Intercom using /dev/dsp for output - (Obsolete) Send to Intercom |
| Intercom(): Sends the user to the intercom (i.e. /dev/dsp). This program is generally considered obselete by the chan_oss module. Returns 0 if the user exits with a DTMF tone, or -1 if they hangup. | |
| LookupBlacklist |
| Look up Caller*ID name/number from blacklist database - Look up Caller*ID name/number from blacklist database |
| LookupBlacklist: Looks up the Caller*ID number on the active channel in the Asterisk database (family 'blacklist'). If the number is found, and if there exists a priority n + 101, where 'n' is the priority of the current instance, then the channel will be setup to continue at that priority level. Otherwise, it returns 0. Does nothing if no Caller*ID was received on the channel.
Example: database put blacklist <name/number> 1 | |
| LookupCIDName |
| Look up CallerID Name from local database - Look up CallerID Name from local database |
| LookupCIDName: Looks up the Caller*ID number on the active channel in the Asterisk database (family 'cidname') and sets the Caller*ID name. Does nothing if no Caller*ID was received on the channel. This is useful if you do not subscribe to Caller*ID name delivery, or if you want to change the names on some incoming calls. Always returns 0. | |
| Macro |
| Extension Macros - Macro Implementation |
| Macro(macroname|arg1|arg2...): Executes a macro using the context 'macro-<macroname>', jumping to the 's' extension of that context and executing each step, then returning when the steps end. The calling extension, context, and priority are stored in ${MACRO_EXTEN}, ${MACRO_CONTEXT} and ${MACRO_PRIORITY} respectively. Arguments become ${ARG1}, ${ARG2}, etc in the macro context. Macro returns -1 if any step in the macro returns -1, and 0 otherwise. If you Goto out of the Macro context, the Macro will terminate and control will be return at the location of the Goto. Otherwise if ${MACRO_OFFSET} is set at termination, Macro will attempt to continue at priority MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise. | |
| MeetMe |
| Simple MeetMe conference bridge - Simple MeetMe conference bridge |
MeetMe(confno[|options]): Enters the user into a specified MeetMe conference. If the conference number is omitted, the user will be prompted to enter one. This application always returns -1. A ZAPTEL INTERFACE MUST BE INSTALLED FOR CONFERENCING FUNCTIONALITY. The option string may contain zero or more of the following characters:
'a' -- set admin mode
'm' -- set monitor only mode
'p' -- allow user to exit the conference by pressing '#'
's' -- send user to admin/user menu if '*' is received
't' -- set talk only mode
'q' -- quiet mode (don't play enter/leave sounds)
| |
| Milliwatt |
| Digital Milliwatt (mu-law) Test Application - Generate a Constant 1000Hz tone at 0dbm (mu-law) |
| Milliwatt(): Generate a Constant 1000Hz tone at 0dbm (mu-law) | |
| MP3Player |
| Silly MP3 Application - Play an MP3 file or stream |
| MP3Player(location) Executes mpg123 to play the given location which typically would be a filename or a URL. Returns -1 on hangup or 0 otherwise. User can exit by pressing any key. | |
| ParkAndAnnounce |
| Call Parking and Announce Application - Park and Announce |
ParkAndAnnounce(announce:template|timeout|dial|[return_context]): Park a call into the parkinglot and announce the call over the console.
announce template: colon seperated list of files to announce, the word PARKED will be replaced by a say_digits of the ext the call is parked in
timeout: time in seconds before the call returns into the return context.
dial: The app_dial style resource to call to make the announcement. Console/dsp calls the console.
return_context: the goto style label to jump the call back into after timeout. default=prio+1 | |
| Playback |
| Trivial Playback Application - Play a file |
| Playback(filename[|option]): Plays back a given filename (do not put extension). Options may also be included following a pipe symbol. The only defined option at this time is 'skip', which causes the playback of the message to be skipped if the channel is not in the 'up' state (i.e. it hasn't been answered yet. If 'skip' is specified, the application will return immediately should the channel not be off hook. Otherwise, unless 'noanswer' is specified, the channel channel will be answered before the sound is played. Not all channels support playing messages while on hook. Returns -1 if the channel was hung up, or if the file does not exist. Returns 0 otherwise. | |
| PrivacyManager |
| Require phone number to be entered, if no CallerID sent - Require phone number to be entered, if no CallerID sent |
| PrivacyManager: If no Caller*ID is sent, PrivacyManager answers the channel and asks the caller to enter their 10 digit phone number. The caller is given 3 attempts. If after 3 attempts, they do no enter their 10 digit phone number, and if there exists a priority n + 101, where 'n' is the priority of the current instance, then the channel will be setup to continue at that priority level. Otherwise, it returns 0. Does nothing if Caller*ID was received on the channel. | |
| Queue |
| True Call Queueing - Queue a call for a call queue |
Queue(queuename[|options[|URL][|announceoverride]]): Queues an incoming call in a particular call queue as defined in queues.conf. This application returns -1 if the originating channel hangs up, or if the call is bridged and either of the parties in the bridge terminate the call. Returns 0 if the queue is full, nonexistant, or has no members. The option string may contain zero or more of the following characters:
't' -- allow the called user transfer the calling user
'T' -- to allow the calling user to transfer the call.
'd' -- data-quality (modem) call (minimum delay).
'H' -- allow caller to hang up by hitting *.
In addition to transferring the call, a call may be parked and then picked up by another user. The optionnal URL will be sent to the called party if the channel supports it. | |
|
|
| Record |
| Trivial Record Application - Record to a file |
| Record(filename:extension): Records from the channel into a given filename. If the file exists it will be overwritten. The 'extension' is the extension of the file type to be recorded (wav, gsm, etc). Returns -1 when the user hangs up. | |
| SendDTMF |
| Send DTMF digits Application - Sends arbitrary DTMF digits |
| SendDTMF(digits): Sends DTMF digits on a channel. Returns 0 on success or -1 on a hangup. | |
| SetCallerID |
| Set CallerID Application - Set CallerID |
| SetCallerID(clid[|a]): Set Caller*ID on a call to a new value. Sets ANI as well if a flag is used. Always returns 0 | |
| SetCIDName |
| Set CallerID Name - Set CallerID Name |
| SetCIDName(cname[|a]): Set Caller*ID Name on a call to a new value, while preserving the original Caller*ID number. This is useful for providing additional information to the called party. Sets ANI as well if a flag is used. Always returns 0 | |
| SoftHangup |
| Hangs up the requested channel - Soft Hangup Application |
| |
| PGSQL |
| Simple PostgreSQL Interface - Do several SQLy things |
| PGSQL(): Do several SQLy things | |
| StripLSD |
| Strip trailing digits - Strip Least Significant Digits |
| StripLSD(count): Strips the trailing 'count' digits from the channel's associated extension. For example, the number 5551212 when stripped with a count of 4 would be changed to 555. This app always returns 0, and the PBX will continue processing at the next priority for the *new* extension. So, for example, if priority 3 of 5551212 is StripLSD 4, the next step executed will be priority 4 of 555. If you switch into an extension which has no first step, the PBX will treat it as though the user dialed an invalid extension. | |
| SubString |
| Save substring digits in a given variable - Save substring digits in a given variable |
| StripLSD(variable=string_of_digits|count1|count2): Assigns the substring of string_of_digits to a given variable. Parameter count1 may be positive or negative. If it's positive then we skip the first count1 digits from the left. If it's negative, we move count1 digits counting from the end of the string to the left. Parameter count2 may be only positive and implies how many digits we're taking from the point that count1 placed us. For example: exten => _NXXXXXX,1,SubString,test=2564286161|0|3 assigns the area code (3 first digits) to variable test. exten => _NXXXXXX,1,SubString,test=2564286161|-7|7 assigns the last 7 digits to variable test. If there are no parameters it'll return with -1. If there wrong parameters it go on and return with 0 | |
| System |
| Generic System() application - Execute a system command |
| System(command): Executes a command by using system(). Returns -1 on failure to execute the specified command. If the command itself executes but is in error, and if there exists a priority n + 101, where 'n' is the priority of the current instance, then the channel will be setup to continue at that priority level. Otherwise, System returns 0. | |
| TimeCondition |
| Cron-like conditional goto - |
| |
| SendURL |
| Send URL Applications - Send a URL |
| SendURL(URL[|option]): Requests client go to URL. If the client does not support html transport, and there exists a step with priority n + 101, then execution will continue at that step. Otherwise, execution will continue at the next priority level. SendURL only returns 0 if the URL was sent correctly or if the channel does not support HTML transport, and -1 otherwise. If the option 'wait' is specified, execution will wait for an acknowledgement that the URL has been loaded before continuing and will return -1 if the peer is unable to load the URL | |
| VoiceMail |
| Comedian Mail (Voicemail System) - Leave a voicemail message |
| VoiceMail([s|u|b]extension): Leaves voicemail for a given extension (must be configured in voicemail.conf). If the extension is preceeded by an 's' then instructions for leaving the message will be skipped. If the extension is preceeded by 'u' then the "unavailable" message will be played (that is, /var/lib/asterisk/sounds/vm/<exten>/unavail) if it exists. If the extension is preceeded by a 'b' then the the busy message will be played (that is, busy instead of unavail). At most one of 's', 'u', or 'b' may be specified. Returns -1 on error or mailbox not found, or if the user hangs up. Otherwise, it returns 0. | |
| VoiceMailMain |
| Comedian Mail (Voicemail System) - Enter voicemail system |
| VoiceMailMain(): Enters the main voicemail system for the checking of voicemail. The mailbox can be passed as the option, which will stop the voicemail system from prompting the user for the mailbox. If the mailbox is preceded by 's' then the password check will be skipped. Returns -1 if the user hangs up or 0 otherwise. | |
| WaitForRing |
| Waits until first ring after time - Wait for Ring Application |
| |
| Zapateller |
| Block Telemarketers with Special Information Tone - Block telemarketers with SIT |
| Zapateller(options): Generates special information tone to block telemarketers from calling you. Returns 0 normally or -1 on hangup. Options is a pipe-delimited list of options. The following options are available: 'answer' causes the line to be answered before playing the tone, 'nocallerid' causes Zapateller to only play the tone if there is no callerid information available. Options should be separated by | characters | |
| ZapBarge |
| Barge in on Zap channel application - Barge in (monitor) Zap channel |
| ZapBarge([channel]): Barges in on a specified zap channel or prompts if one is not specified. Returns -1 when caller user hangs up and is independent of the state of the channel being monitored. | |
| ZapRAS |
| Zap RAS Application - Executes Zaptel ISDN RAS application |
| ZapRAS(args): Executes a RAS server using pppd on the given channel. The channel must be a clear channel (i.e. PRI source) and a Zaptel channel to be able to use this function (No modem emulcation is included). Your pppd must be patched to be zaptel aware. Arguments should be separated by | characters. Always returns -1. | |
