AgentLogin

Synopsis

Call agent login.

Syntax

AgentLogin([AgentNo[,options]])

Arguments

AgentNo	(no description)
options	s silent login - do not announce the login ok segment after agent logged on/off

Description

Asks the agent to login to the system. Always returns -1. While logged in, the agent can receive calls and will hear a beep when a new call comes in. The agent can dump the call by pressing the star key.

See also

Queue application
AddQueueMember application
RemoveQueueMember application
PauseQueueMember application
UnpauseQueueMember application
AGENT function
agents.conf file queues.conf file

AgentMonitorOutgoing

Synopsis

Record agent's outgoing call.

Syntax

AgentMonitorOutgoing([options])

Arguments

options

d make the app return -1 if there is an error condition. c change the CDR so that the source of the call is Agent/agent_id n don't generate the warnings when there is no callerid or the agentid is not known. It's handy if you want to have one context for agent and non-agent calls.

Description

Tries to figure out the id of the agent who is placing outgoing call based on comparison of the callerid of the current interface and the global variable placed by the AgentCallbackLogin application. That's why it should be used only with the AgentCallbackLogin app. Uses the monitoring functions in chan_agent instead of Monitor application. That has to be configured in the agents.conf file.

Normally the app returns 0 unless the options are passed.

See also

agents.conf file

DAHDISendKeypadFacility

Synopsis

Send digits out of band over a PRI.

Syntax

DAHDISendKeypadFacility(digits)

Arguments

digits

(no description)

Description

This application will send the given string of digits in a Keypad Facility IE over the current channel.

DAHDISendCallreroutingFacility

Synopsis

Send QSIG call rerouting facility over a PRI.

Syntax

DAHDISendCallreroutingFacility(destination[,original[,reason]])

Arguments

destination	Destination number.
original	Original called number.
reason	Diversion reason, if not specified defaults to unknown

Description

This application will send a Callrerouting Facility IE over the current channel.

DAHDIAcceptR2Call

Synopsis

Accept an R2 call if its not already accepted (you still need to answer it)

Syntax

DAHDIAcceptR2Call(charge)

Arguments

charge

Yes or No. Whether you want to accept the call with charge or without charge.

Description

This application will Accept the R2 call either with charge or no charge.

IAX2Provision

Synopsis

Provision a calling IAXy with a given template.

Syntax

IAX2Provision([template])

Arguments

template

If not specified, defaults to default.

Description

Provisions the calling IAXy (assuming the calling entity is in fact an IAXy) with the given template. Returns -1 on error or 0 on success.

SIPDtmfMode

Synopsis

Change the dtmfmode for a SIP call.

Syntax

SIPDtmfMode(mode)

Arguments

mode	(no description)

Description

Changes the dtmfmode for a SIP call.

SIPAddHeader

Synopsis

Add a SIP header to the outbound call.

Syntax

SIPAddHeader(Header,Content)

Arguments

Header	(no description)
Content	(no description)

Description

Adds a header to a SIP call placed with DIAL.

Remember to use the X-header if you are adding non-standard SIP headers, like X-Asterisk-Accountcode:. Use this with care. Adding the wrong headers may jeopardize the SIP dialog.

Always returns 0.

SIPRemoveHeader

Synopsis

Remove SIP headers previously added with SIPAddHeader

Syntax

SIPRemoveHeader([Header])

Arguments

Header

(no description)

Description

SIPRemoveHeader() allows you to remove headers which were previously added with SIPAddHeader(). If no parameter is supplied, all previously added headers will be removed. If a parameter is supplied, only the matching headers will be removed.

For example you have added these 2 headers:

SIPAddHeader(P-Asserted-Identity: sip:foo@bar);

SIPAddHeader(P-Preferred-Identity: sip:bar@foo);

// remove all headers

SIPRemoveHeader();

// remove all P- headers

SIPRemoveHeader(P-);

// remove only the PAI header (note the : at the end)

SIPRemoveHeader(P-Asserted-Identity:);

Always returns 0.

ADSIProg

Synopsis

Load Asterisk ADSI Scripts into phone

Syntax

ADSIProg([script])

Arguments

script

adsi script to use. If not given uses the default script asterisk.adsi

Description

This application programs an ADSI Phone with the given script

See also

GetCPEID application
adsi.conf file

AlarmReceiver

Synopsis

Provide support for receiving alarm reports from a burglar or fire alarm panel.

Syntax

AlarmReceiver()

Arguments

Description

This application should be called whenever there is an alarm panel calling in to dump its events. The application will handshake with the alarm panel, and receive events, validate them, handshake them, and store them until the panel hangs up. Once the panel hangs up, the application will run the system command specified by the eventcmd setting in alarmreceiver.conf and pipe the events to the standard input of the application. The configuration file also contains settings for DTMF timing, and for the loudness of the acknowledgement tones.

Only 1 signalling format is supported at this time: Ademco Contact ID.

See also

alarmreceiver.conf file

AMD

Synopsis

Attempt to detect answering machines.

Syntax

AMD([initialSilence[,greeting[,afterGreetingSilence[,totalAnalysis Time[,miniumWordLength[,betweenWordSilence[,maximumNumberOfWords[,silenceThreshold[,maximumWordLength]]]]]]]]])

Arguments

initialSilence	Is maximum initial silence duration before greeting. If this is exceeded set as MACHINE
greeting	is the maximum length of a greeting. If this is exceeded set as MACHINE
afterGreetingSilence	Is the silence after detecting a greeting. If this is exceeded set as HUMAN
totalAnalysis Time	Is the maximum time allowed for the algorithm to decide HUMAN or MACHINE
miniumWordLength	Is the minimum duration of Voice considered to be a word
betweenWordSilence	Is the minimum duration of silence after a word to consider the audio that follows to be a new word
maximumNumberOfWords	Is the maximum number of words in a greeting If this is exceeded set as MACHINE
silenceThreshold	How long do we consider silence
maximumWordLength	Is the maximum duration of a word to accept. If exceeded set as MACHINE

Description

This application attempts to detect answering machines at the beginning of outbound calls. Simply call this application after the call has been answered (outbound only, of course).

When loaded, AMD reads amd.conf and uses the parameters specified as default values. Those default values get overwritten when the calling AMD with parameters.

This application sets the following channel variables:

AMDSTATUS	This is the status of the answering machine detection MACHINE HUMAN NOTSURE HANGUP
AMDCAUSE	Indicates the cause that led to the conclusion TOOLONG Total Time. INITIALSILENCE Silence Duration - Initial Silence. HUMAN Silence Duration - afterGreetingSilence. LONGGREETING Voice Duration - Greeting. MAXWORDLENGTH Word Count - maximum number of words.

See also

WaitForSilence application
WaitForNoise application

Authenticate

Synopsis

Authenticate a user

Syntax

Authenticate(password[,options[,maxdigits[,prompt]]])

Arguments

password	Password the user should know
options	a Set the channels' account code to the password that is entered d Interpret the given path as database key, not a literal file m Interpret the given path as a file which contains a list of account codes and password hashes delimited with :, listed one per line in the file. When one of the passwords is matched, the channel will have its account code set to the corresponding account code in the file. r Remove the database key upon successful entry (valid with d only)
maxdigits	maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the # key). Defaults to 0 - no limit - wait for the user press the # key.
prompt	Override the agent-pass prompt file.

Description

This application asks the caller to enter a given password in order to continue dialplan execution.

If the password begins with the / character, it is interpreted as a file which contains a list of valid passwords, listed 1 password per line in the file.

When using a database key, the value associated with the key can be anything.

Users have three attempts to authenticate before the channel is hung up.

See also

VMAuthenticate application
DISA application

NoCDR

Synopsis

Tell Asterisk to not maintain a CDR for the current call

Syntax

NoCDR()

Arguments

Description

This application will tell Asterisk not to maintain a CDR for the current call.

ChanIsAvail

Synopsis

Check channel availability

Syntax

ChanIsAvail(Technology/Resource[,options])

Arguments

Technology/Resource	Optional extra devices to check If you need more then one enter them as Technology2/Resource2&Technology3/Resourse3&..... Specification of the device(s) to check. These must be in the format of Technology/Resource, where Technology represents a particular channel driver, and Resource represents a resource available to that particular channel driver.
options	a Check for all available channels, not only the first one s Consider the channel unavailable if the channel is in use at all t Simply checks if specified channels exist in the channel list

Description

This application will check to see if any of the specified channels are available.

This application sets the following channel variables:

AVAILCHAN	The name of the available channel, if one exists
AVAILORIGCHAN	The canonical channel name that was used to create the channel
AVAILSTATUS	The status code for the available channel

ChannelRedirect

Synopsis

Redirects given channel to a dialplan target

Syntax

ChannelRedirect([[channel,context,]extension,]priority)

Arguments

channel	(no description)
context	(no description)
extension	(no description)
priority	(no description)

Description

Sends the specified channel to the specified extension priority

This application sets the following channel variables upon completion

CHANNELREDIRECT_STATUS

NOCHANNEL SUCCESS Are set to the result of the redirection

ChanSpy

Synopsis

Listen to a channel, and optionally whisper into it.

Syntax

ChanSpy([chanprefix[,options]])

Arguments

chanprefix

(no description)

options

b Only spy on channels involved in a bridged call. B Instead of whispering on a single channel barge in on both channels involved in the call. d Override the typical numeric DTMF functionality and instead use DTMF to switch between spy modes. spy mode whisper mode barge mode g Only spy on channels in which one or more of the groups listed in grp matches one or more groups from the SPYGROUP variable set on the channel to be spied upon. both grp and SPYGROUP can contain either a single group or a colon-delimited list of groups, such as sales:support:accounting. n Say the name of the person being spied on if that person has recorded his/her name. If a context is specified, then that voicemail context will be searched when retrieving the name, otherwise the default context be used when searching for the name (i.e. if SIP/1000 is the channel being spied on and no mailbox is specified, then 1000 will be used when searching for the name). q Don't play a beep when beginning to spy on a channel, or speak the selected channel name. r Record the session to the monitor spool directory. An optional base for the filename may be specified. The default is chanspy. s Skip the playback of the channel type (i.e. SIP, IAX, etc) when speaking the selected channel name. v Adjust the initial volume in the range from -4 to 4. A negative value refers to a quieter setting. w Enable whisper mode, so the spying channel can talk to the spied-on channel. W Enable private whisper mode, so the spying channel can talk to the spied-on channel but cannot listen to that channel. o Only listen to audio coming from this channel. X Allow the user to exit ChanSpy to a valid single digit numeric extension in the current context or the context specified by the SPY_EXIT_CONTEXT channel variable. The name of the last channel that was spied on will be stored in the SPY_CHANNEL variable. x Specify a DTMF digit that can be used to exit the application. c Specify a DTMF digit that can be used to spy on the next available channel. e Enable enforced mode, so the spying channel can only monitor extensions whose name is in the ext : delimited list.

Description

This application is used to listen to the audio from an Asterisk channel. This includes the audio coming in and "out of the channel being spied on. If the chanprefix parameter is specified, only channels beginning with this string will be spied upon.

While spying, the following actions may be performed:

- Dialing # cycles the volume level.

- Dialing * will stop spying and look for another channel to spy on.

- Dialing a series of digits followed by # builds a channel name to append to 'chanprefix'. For example, executing ChanSpy(Agent) and then dialing the digits '1234#' while spying will begin spying on the channel 'Agent/1234'. Note that this feature will be overridden if the 'd' option is used

The X option supersedes the three features above in that if a valid single digit extension exists in the correct context ChanSpy will exit to it. This also disables choosing a channel based on chanprefix and a digit sequence.

See also

ExtenSpy application

ExtenSpy

Synopsis

Listen to a channel, and optionally whisper into it.

Syntax

ExtenSpy(exten[,options])

Arguments

exten

Specify extension. Optionally specify a context, defaults to default.

options

b Only spy on channels involved in a bridged call. B Instead of whispering on a single channel barge in on both channels involved in the call. d Override the typical numeric DTMF functionality and instead use DTMF to switch between spy modes. spy mode whisper mode barge mode g Only spy on channels in which one or more of the groups listed in grp matches one or more groups from the SPYGROUP variable set on the channel to be spied upon. both grp and SPYGROUP can contain either a single group or a colon-delimited list of groups, such as sales:support:accounting. n Say the name of the person being spied on if that person has recorded his/her name. If a context is specified, then that voicemail context will be searched when retrieving the name, otherwise the default context be used when searching for the name (i.e. if SIP/1000 is the channel being spied on and no mailbox is specified, then 1000 will be used when searching for the name). q Don't play a beep when beginning to spy on a channel, or speak the selected channel name. r Record the session to the monitor spool directory. An optional base for the filename may be specified. The default is chanspy. s Skip the playback of the channel type (i.e. SIP, IAX, etc) when speaking the selected channel name. v Adjust the initial volume in the range from -4 to 4. A negative value refers to a quieter setting. w Enable whisper mode, so the spying channel can talk to the spied-on channel. W Enable private whisper mode, so the spying channel can talk to the spied-on channel but cannot listen to that channel. o Only listen to audio coming from this channel. X Allow the user to exit ChanSpy to a valid single digit numeric extension in the current context or the context specified by the SPY_EXIT_CONTEXT channel variable. The name of the last channel that was spied on will be stored in the SPY_CHANNEL variable. x Specify a DTMF digit that can be used to exit the application. c Specify a DTMF digit that can be used to spy on the next available channel. e Enable enforced mode, so the spying channel can only monitor extensions whose name is in the ext : delimited list.

Description

This application is used to listen to the audio from an Asterisk channel. This includes the audio coming in and out of the channel being spied on. Only channels created by outgoing calls for the specified extension will be selected for spying. If the optional context is not supplied, the current channel's context will be used.

While spying, the following actions may be performed:

- Dialing # cycles the volume level.

- Dialing * will stop spying and look for another channel to spy on.

The X option supersedes the three features above in that if a valid single digit extension exists in the correct context ChanSpy will exit to it. This also disables choosing a channel based on chanprefix and a digit sequence.

See also

ChanSpy application

DAHDIScan

Synopsis

Scan DAHDI channels to monitor calls.

Syntax

DAHDIScan([group])

Arguments

group

Limit scanning to a channel group by setting this option.

Description

Allows a call center manager to monitor DAHDI channels in a convenient way. Use # to select the next channel and use * to exit.

ConfBridge

Synopsis

Conference bridge application.

Syntax

ConfBridge([confno[,options]])

Arguments

confno

The conference number

options

a Set admin mode. A Set marked mode. c Announce user(s) count on joining a conference. m Set initially muted. M Enable music on hold when the conference has a single caller. Optionally, specify a musiconhold class to use. If one is not provided, it will use the channel's currently set music class, or default. 1 Do not play message when first person enters s Present menu (user or admin) when * is received (send to menu). w Wait until the marked user enters the conference. q Quiet mode (don't play enter/leave sounds).

Description

Enters the user into a specified conference bridge. The user can exit the conference by hangup only.

The join sound can be set using the CONFBRIDGE_JOIN_SOUND variable and the leave sound can be set using the CONFBRIDGE_LEAVE_SOUND variable. These can be unique to the caller.

ControlPlayback

Synopsis

Play a file with fast forward and rewind.

Syntax

ControlPlayback(filename[,skipms[,ff[,rew[,stop[,pause[,restart[,options]]]]]]])

Arguments

filename	(no description)
skipms	This is number of milliseconds to skip when rewinding or fast-forwarding.
ff	Fast-forward when this DTMF digit is received. (defaults to #)
rew	Rewind when this DTMF digit is received. (defaults to *)
stop	Stop playback when this DTMF digit is received.
pause	Pause playback when this DTMF digit is received.
restart	Restart playback when this DTMF digit is received.
options	o Start at time ms from the beginning of the file.

Description

This application will play back the given filename.

It sets the following channel variables upon completion:

CPLAYBACKSTATUS	Contains the status of the attempt as a text string SUCCESS USERSTOPPED ERROR
CPLAYBACKOFFSET	Contains the offset in ms into the file where playback was at when it stopped. -1 is end of file.
CPLAYBACKSTOPKEY	If the playback is stopped by the user this variable contains the key that was pressed.

DAHDIBarge

Synopsis

Barge in (monitor) DAHDI channel.

Syntax

DAHDIBarge([channel])

Arguments

channel

Channel to barge.

Description

Barges in on a specified DAHDI 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.

DAHDIRAS

Synopsis

Executes DAHDI ISDN RAS application.

Syntax

DAHDIRAS(args)

Arguments

args	A list of parameters to pass to the pppd daemon, separated by , characters.

Description

Executes a RAS server using pppd on the given channel. The channel must be a clear channel (i.e. PRI source) and a DAHDI channel to be able to use this function (No modem emulation is included).

Your pppd must be patched to be DAHDI aware.

DBdel

Synopsis

Delete a key from the asterisk database.

Syntax

DBdel(family,key)

Arguments

family	(no description)
key	(no description)

Description

This application will delete a key from the Asterisk database.

This application has been DEPRECATED in favor of the DB_DELETE function.

See also

DB_DELETE function
DBdeltree application
DB function

DBdeltree

Synopsis

Delete a family or keytree from the asterisk database.

Syntax

DBdeltree(family[,keytree])

Arguments

family	(no description)
keytree	(no description)

Description

This application will delete a family or keytree from the Asterisk database.

See also

DB_DELETE function
DBdel application
DB function

Dial

Synopsis

Attempt to connect to another device or endpoint and bridge the call.

Syntax

Dial(Technology/Resource[,timeout[,options[,URL]]])

Arguments

Technology/Resource	Specification of the device(s) to dial. These must be in the format of Technology/Resource, where Technology represents a particular channel driver, and Resource represents a resource available to that particular channel driver. Optional extra devices to dial in parallel If you need more then one enter them as Technology2/Resource2&Technology3/Resourse3&.....
timeout	Specifies the number of seconds we attempt to dial the specified devices If not specified, this defaults to 136 years.
options	A The file to play to the called party Play an announcement to the called party, where x is the prompt to be played C Reset the call detail record (CDR) for this call. c If the Dial() application cancels this call, always set the flag to tell the channel driver that the call is answered elsewhere. d Allow the calling user to dial a 1 digit extension while waiting for a call to be answered. Exit to that extension if it exists in the current context, or the context defined in the EXITCONTEXT variable, if it exists. D Send the specified DTMF strings after the called party has answered, but before the call gets bridged. The called DTMF string is sent to the called party, and the calling DTMF string is sent to the calling party. Both arguments can be used alone. If progress is specified, its DTMF is sent immediately after receiving a PROGRESS message. e Execute the h extension for peer after the call ends f Force the callerid of the calling channel to be set as the extension associated with the channel using a dialplan hint. For example, some PSTNs do not allow CallerID to be set to anything other than the number assigned to the caller. F When the caller hangs up, transfer the called party to the specified destination and continue execution at that location. F Proceed with dialplan execution at the next priority in the current extension if the source channel hangs up. g Proceed with dialplan execution at the next priority in the current extension if the destination channel hangs up. G If the call is answered, transfer the calling party to the specified priority and the called party to the specified priority plus one. You cannot use any additional action post answer options in conjunction with this option. h Allow the called party to hang up by sending the * DTMF digit. H Allow the calling party to hang up by hitting the * DTMF digit. i Asterisk will ignore any forwarding requests it may receive on this dial attempt. I Asterisk will ignore any connected line update requests or redirecting party update requests it may receiveon this dial attempt. k Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf. K Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf. L Maximum call time, in milliseconds Warning time, in milliseconds Repeat time, in milliseconds Limit the call to x milliseconds. Play a warning when y milliseconds are left. Repeat the warning every z milliseconds until time expires. This option is affected by the following variables: LIMIT_PLAYAUDIO_CALLER yes no If set, this variable causes Asterisk to play the prompts to the caller. LIMIT_PLAYAUDIO_CALLEE yes no If set, this variable causes Asterisk to play the prompts to the callee. LIMIT_TIMEOUT_FILE filename If specified, filename specifies the sound prompt to play when the timeout is reached. If not set, the time remaining will be announced. LIMIT_CONNECT_FILE filename If specified, filename specifies the sound prompt to play when the call begins. If not set, the time remaining will be announced. LIMIT_WARNING_FILE filename If specified, filename specifies the sound prompt to play as a warning when time x is reached. If not set, the time remaining will be announced. m Provide hold music to the calling party until a requested channel answers. A specific music on hold class (as defined in musiconhold.conf) can be specified. M Name of the macro that should be executed. Macro arguments Execute the specified macro for the called channel before connecting to the calling channel. Arguments can be specified to the Macro using ^ as a delimiter. The macro can set the variable MACRO_RESULT to specify the following actions after the macro is finished executing: MACRO_RESULT If set, this action will be taken after the macro finished executing. ABORT Hangup both legs of the call CONGESTION Behave as if line congestion was encountered BUSY Behave as if a busy signal was encountered CONTINUE Hangup the called party and allow the calling party to continue dialplan execution at the next priority GOTO:<context>^<exten>^<priority> Transfer the call to the specified destination. You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are not run on the peer (called) channel, so you will not be able to set timeouts via the TIMEOUT() function in this macro. Be aware of the limitations that macros have, specifically with regards to use of the WaitExten application. For more information, see the documentation for Macro() n This option is a modifier for the call screening/privacy mode. (See the p and P options.) It specifies that no introductions are to be saved in the priv-callerintros directory. N This option is a modifier for the call screening/privacy mode. It specifies that if Caller*ID is present, do not screen the call. o Specify that the Caller*ID that was present on the calling channel be set as the Caller*ID on the called channel. This was the behavior of Asterisk 1.0 and earlier. O With mode either not specified or set to 1, the originator hanging up will cause the phone to ring back immediately. With mode set to 2, when the operator flashes the trunk, it will ring their phone back. Enables operator services mode. This option only works when bridging a DAHDI channel to another DAHDI channel only. if specified on non-DAHDI interfaces, it will be ignored. When the destination answers (presumably an operator services station), the originator no longer has control of their line. They may hang up, but the switch will not release their line until the destination party (the operator) hangs up. p This option enables screening mode. This is basically Privacy mode without memory. P Enable privacy mode. Use x as the family/key in the AstDB database if it is provided. The current extension is used if a database family/key is not specified. r Indicate ringing to the calling party, even if the called party isn't actually ringing. Pass no audio to the calling party until the called channel has answered. S Hang up the call x seconds after the called party has answered the call. t Allow the called party to transfer the calling party by sending the DTMF sequence defined in features.conf. T Allow the calling party to transfer the called party by sending the DTMF sequence defined in features.conf. U Name of the subroutine to execute via Gosub Arguments for the Gosub routine Execute via Gosub the routine x for the called channel before connecting to the calling channel. Arguments can be specified to the Gosub using ^ as a delimiter. The Gosub routine can set the variable GOSUB_RESULT to specify the following actions after the Gosub returns. GOSUB_RESULT ABORT Hangup both legs of the call. CONGESTION Behave as if line congestion was encountered. BUSY Behave as if a busy signal was encountered. CONTINUE Hangup the called party and allow the calling party to continue dialplan execution at the next priority. GOTO:<context>^<exten>^<priority> Transfer the call to the specified priority. Optionally, an extension, or extension and priority can be specified. You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are not run on the peer (called) channel, so you will not be able to set timeouts via the TIMEOUT() function in this routine. w Allow the called party to enable recording of the call by sending the DTMF sequence defined for one-touch recording in features.conf. W Allow the calling party to enable recording of the call by sending the DTMF sequence defined for one-touch recording in features.conf. x Allow the called party to enable recording of the call by sending the DTMF sequence defined for one-touch automixmonitor in features.conf. X Allow the calling party to enable recording of the call by sending the DTMF sequence defined for one-touch automixmonitor in features.conf. z On a call forward, cancel any dial timeout which has been set for this call.
URL	The optional URL will be sent to the called party if the channel driver supports it.

Description

This application will place calls to one or more specified channels. As soon as one of the requested channels answers, the originating channel will be answered, if it has not already been answered. These two channels will then be active in a bridged call. All other channels that were requested will then be hung up.

Unless there is a timeout specified, the Dial application will wait indefinitely until one of the called channels answers, the user hangs up, or if all of the called channels are busy or unavailable. Dialplan executing will continue if no requested channels can be called, or if the timeout expires. This application will report normal termination if the originating channel hangs up, or if the call is bridged and either of the parties in the bridge ends the call.

If the OUTBOUND_GROUP variable is set, all peer channels created by this application will be put into that group (as in Set(GROUP()=...). If the OUTBOUND_GROUP_ONCE variable is set, all peer channels created by this application will be put into that group (as in Set(GROUP()=...). Unlike OUTBOUND_GROUP, however, the variable will be unset after use.

This application sets the following channel variables:

DIALEDTIME	This is the time from dialing a channel until when it is disconnected.
ANSWEREDTIME	This is the amount of time for actual call.
DIALSTATUS	This is the status of the call CHANUNAVAIL CONGESTION NOANSWER BUSY ANSWER CANCEL DONTCALL For the Privacy and Screening Modes. Will be set if the called party chooses to send the calling party to the 'Go Away' script. TORTURE For the Privacy and Screening Modes. Will be set if the called party chooses to send the calling party to the 'torture' script. INVALIDARGS

RetryDial

Synopsis

Place a call, retrying on failure allowing an optional exit extension.

Syntax

RetryDial(announce,sleep,retries,dialargs)

Arguments

announce	Filename of sound that will be played when no channel can be reached
sleep	Number of seconds to wait after a dial attempt failed before a new attempt is made
retries	Number of retries When this is reached flow will continue at the next priority in the dialplan
dialargs	Same format as arguments provided to the Dial application

Description

This application will attempt to place a call using the normal Dial application. If no channel can be reached, the announce file will be played. Then, it will wait sleep number of seconds before retrying the call. After retries number of attempts, the calling channel will continue at the next priority in the dialplan. If the retries setting is set to 0, this application will retry endlessly. While waiting to retry a call, a 1 digit extension may be dialed. If that extension exists in either the context defined in EXITCONTEXT or the current one, The call will jump to that extension immediately. The dialargs are specified in the same format that arguments are provided to the Dial application.

Dictate

Synopsis

Virtual Dictation Machine.

Syntax

Dictate([base_dir[,filename]])

Arguments

base_dir	(no description)
filename	(no description)

Description

Start dictation machine using optional base_dir for files.

Pickup

Synopsis

Directed extension call pickup.

Syntax

Pickup(ext[,ext2])

Arguments

ext	(no description)
ext2	(no description)

Description

This application can pickup any ringing channel that is calling the specified extension. If no context is specified, the current context will be used. If you use the special string PICKUPMARK for the context parameter, for example 10@PICKUPMARK, this application tries to find a channel which has defined a PICKUPMARK channel variable with the same value as extension (in this example, 10). When no parameter is specified, the application will pickup a channel matching the pickup group of the active channel.

PickupChan

Synopsis

Pickup a ringing channel.

Syntax

PickupChan(channel[,channel2])

Arguments

channel	(no description)
channel2	(no description)

Description

This will pickup a specified channel if ringing.

Directory

Synopsis

Provide directory of voicemail extensions.

Syntax

Directory([vm-context[,dial-context[,options]]])

Arguments

vm-context	This is the context within voicemail.conf to use for the Directory. If not specified and searchcontexts=no in voicemail.conf, then default will be assumed.
dial-context	This is the dialplan context to use when looking for an extension that the user has selected, or when jumping to the o or a extension.
options	e In addition to the name, also read the extension number to the caller before presenting dialing options. f Allow the caller to enter the first name of a user in the directory instead of using the last name. If specified, the optional number argument will be used for the number of characters the user should enter. l Allow the caller to enter the last name of a user in the directory. This is the default. If specified, the optional number argument will be used for the number of characters the user should enter. b Allow the caller to enter either the first or the last name of a user in the directory. If specified, the optional number argument will be used for the number of characters the user should enter. m Instead of reading each name sequentially and asking for confirmation, create a menu of up to 8 names. p Pause for n milliseconds after the digits are typed. This is helpful for people with cellphones, who are not holding the receiver to their ear while entering DTMF. Only one of the f, l, or b options may be specified. If more than one is specified, then Directory will act as if b was specified. The number of characters for the user to type defaults to 3.

Description

This application will present the calling channel with a directory of extensions from which they can search by name. The list of names and corresponding extensions is retrieved from the voicemail configuration file, voicemail.conf.

This application will immediately exit if one of the following DTMF digits are received and the extension to jump to exists:

0 - Jump to the 'o' extension, if it exists.

* - Jump to the 'a' extension, if it exists.

DISA

Synopsis

Direct Inward System Access.

Syntax

DISA(passcode|filename[,context[,cid[,mailbox[,options]]]])

Arguments

passcode|filename	If you need to present a DISA dialtone without entering a password, simply set passcode to no-password You may specified a filename instead of a passcode, this filename must contain individual passcodes
context	Specifies the dialplan context in which the user-entered extension will be matched. If no context is specified, the DISA application defaults to the disa context. Presumably a normal system will have a special context set up for DISA use with some or a lot of restrictions.
cid	Specifies a new (different) callerid to be used for this call.
mailbox	Will cause a stutter-dialtone (indication dialrecall) to be used, if the specified mailbox contains any new messages.
options	n The DISA application will not answer initially. p The extension entered will be considered complete when a # is entered.

Description

The DISA, Direct Inward System Access, application 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. DISA plays a dialtone. The user enters their numeric passcode, followed by the pound sign #. If the passcode is correct, the user is then given system dialtone within context on which a call may be placed. If the user enters an invalid extension and extension i exists in the specified context, it will be used.

Be aware that using this may compromise the security of your PBX.

The arguments to this application (in extensions.conf) allow either specification of a single global passcode (that everyone uses), or individual passcodes contained in a file (filename).

The file that contains the passcodes (if used) allows a complete specification of all of the same arguments available on the command line, with the sole exception of the options. The file may contain blank lines, or comments starting with # or ;.

See also

Authenticate application
VMAuthenticate application

DumpChan

Synopsis

Dump Info About The Calling Channel.

Syntax

DumpChan([level])

Arguments

level

Minimun verbose level

Description

Displays information on channel and listing of all channel variables. If level is specified, output is only displayed when the verbose level is currently set to that number or greater.

See also

NoOp application
Verbose application

Echo

Synopsis

Echo audio, video, DTMF back to the calling party

Syntax

Echo()

Arguments

Description

Echos back any audio, video or DTMF frames read from the calling channel back to itself. Note: If '#' detected application exits

Exec

Synopsis

Executes dialplan application.

Syntax

Exec(appname)

Arguments

appname

Application name and arguments of the dialplan application to execute.

Description

Allows an arbitrary application to be invoked even when not hard coded into the dialplan. If the underlying application terminates the dialplan, or if the application cannot be found, Exec will terminate the dialplan.

To invoke external applications, see the application System. If you would like to catch any error instead, see TryExec.

TryExec

Synopsis

Executes dialplan application, always returning.

Syntax

TryExec(appname)

Arguments

appname

(no description)

Description

Allows an arbitrary application to be invoked even when not hard coded into the dialplan. To invoke external applications see the application System. Always returns to the dialplan. The channel variable TRYSTATUS will be set to one of:

TRYSTATUS

SUCCESS If the application returned zero. FAILED If the application returned non-zero. NOAPP If the application was not found or was not specified.

ExecIf

Synopsis

Executes dialplan application, conditionally.

Syntax

ExecIf(expression,execapp)

Arguments

expression	(no description)
execapp	(no description)

Description

If expr is true, execute and return the result of appiftrue(args).

If expr is true, but appiftrue is not found, then the application will return a non-zero value.

SendFAX

Synopsis

Send a Fax

Syntax

SendFAX(filename[,a])

Arguments

filename	Filename of TIFF file to fax
a	Makes the application behave as the answering machine (Default behavior is as calling machine)

Description

Send a given TIFF file to the channel as a FAX.

This application sets the following channel variables:

LOCALSTATIONID	To identify itself to the remote end
LOCALHEADERINFO	To generate a header line on each page
FAXSTATUS	SUCCESS FAILED
FAXERROR	Cause of failure
REMOTESTATIONID	The CSID of the remote side
FAXPAGES	Number of pages sent
FAXBITRATE	Transmission rate
FAXRESOLUTION	Resolution of sent fax

ReceiveFAX

Synopsis

Receive a Fax

Syntax

ReceiveFAX(filename[,c])

Arguments

filename	Filename of TIFF file save incoming fax
c	Makes the application behave as the calling machine (Default behavior is as answering machine)

Description

Receives a FAX from the channel into the given filename overwriting the file if it already exists.

File created will be in TIFF format.

This application sets the following channel variables:

LOCALSTATIONID	To identify itself to the remote end
LOCALHEADERINFO	To generate a header line on each page
FAXSTATUS	SUCCESS FAILED
FAXERROR	Cause of failure
REMOTESTATIONID	The CSID of the remote side
FAXPAGES	Number of pages sent
FAXBITRATE	Transmission rate
FAXRESOLUTION	Resolution of sent fax

Festival

Synopsis

Say text to the user.

Syntax

Festival(text[,intkeys])

Arguments

text	(no description)
intkeys	(no description)

Description

Connect to Festival, send the argument, get back the waveform, play it to the user, allowing any given interrupt keys to immediately terminate and return the value, or any to allow any number back (useful in dialplan).

Flash

Synopsis

Flashes a DAHDI Trunk.

Syntax

Flash()

Arguments

Description

Performs a flash on a DAHDI trunk. This can be used to access features provided on an incoming analogue circuit such as conference and call waiting. Use with SendDTMF() to perform external transfers.

See also

SendDTMF application

FollowMe

Synopsis

Find-Me/Follow-Me application.

Syntax

FollowMe(followmeid[,options])

Arguments

followmeid	(no description)
options	s Playback the incoming status message prior to starting the follow-me step(s) a Record the caller's name so it can be announced to the callee on each step. n Playback the unreachable status message if we've run out of steps to reach the or the callee has elected not to be reachable.

Description

This application performs Find-Me/Follow-Me functionality for the caller as defined in the profile matching the followmeid parameter in followme.conf. If the specified followmeid profile doesn't exist in followme.conf, execution will be returned to the dialplan and call execution will continue at the next priority.

Returns -1 on hangup.

ForkCDR

Synopsis

Forks the Call Data Record.

Syntax

ForkCDR([options])

Arguments

options

a Update the answer time on the NEW CDR just after it's been inited. The new CDR may have been answered already. The reset that forkcdr does will erase the answer time. This will bring it back, but the answer time will be a copy of the fork/start time. It will only do this if the initial cdr was indeed already answered. A Lock the original CDR against the answer time being updated. This will allow the disposition on the original CDR to remain the same. d Copy the disposition forward from the old cdr, after the init. D Clear the dstchannel on the new CDR after reset. e End the original CDR. Do this after all the neccessry data is copied from the original CDR to the new forked CDR. r Do NOT reset the new cdr. s(name=val) Set the CDR var name in the original CDR, with value val. T Mark the original CDR with a DONT_TOUCH flag. setvar, answer, and end cdr funcs will obey this flag; normally they don't honor the LOCKED flag set on the original CDR record. Using this flag may cause CDR's not to have their end times updated! It is suggested that if you specify this flag, you might wish to use the e flag as well!. v When the new CDR is forked, it gets a copy of the vars attached to the current CDR. The vars attached to the original CDR are removed unless this option is specified.

Description

Causes the Call Data Record to fork an additional cdr record starting from the time of the fork call. This new cdr record will be linked to end of the list of cdr records attached to the channel. The original CDR has a LOCKED flag set, which forces most cdr operations to skip it, except for the functions that set the answer and end times, which ignore the LOCKED flag. This allows all the cdr records in the channel to be 'ended' together when the channel is closed.

The CDR() func (when setting CDR values) normally ignores the LOCKED flag also, but has options to vary its behavior. The 'T' option (described below), can override this behavior, but beware the risks.

First, this app finds the last cdr record in the list, and makes a copy of it. This new copy will be the newly forked cdr record. Next, this new record is linked to the end of the cdr record list. Next, The new cdr record is RESET (unless you use an option to prevent this)

This means that:

1. All flags are unset on the cdr record

2. the start, end, and answer times are all set to zero.

3. the billsec and duration fields are set to zero.

4. the start time is set to the current time.

5. the disposition is set to NULL.

Next, unless you specified the v option, all variables will be removed from the original cdr record. Thus, the v option allows any CDR variables to be replicated to all new forked cdr records. Without the v option, the variables on the original are effectively moved to the new forked cdr record.

Next, if the s option is set, the provided variable and value are set on the original cdr record.

Next, if the a option is given, and the original cdr record has an answer time set, then the new forked cdr record will have its answer time set to its start time. If the old answer time were carried forward, the answer time would be earlier than the start time, giving strange duration and billsec times.

If the d option was specified, the disposition is copied from the original cdr record to the new forked cdr. If the D option was specified, the destination channel field in the new forked CDR is erased. If the e option was specified, the 'end' time for the original cdr record is set to the current time. Future hang-up or ending events will not override this time stamp. If the A option is specified, the original cdr record will have it ANS_LOCKED flag set, which prevent future answer events from updating the original cdr record's disposition. Normally, an ANSWERED event would mark all cdr records in the chain as ANSWERED. If the T option is specified, the original cdr record will have its DONT_TOUCH flag set, which will force the cdr_answer, cdr_end, and cdr_setvar functions to leave that cdr record alone.

And, last but not least, the original cdr record has its LOCKED flag set. Almost all internal CDR functions (except for the funcs that set the end, and answer times, and set a variable) will honor this flag and leave a LOCKED cdr record alone. This means that the newly created forked cdr record will be affected by events transpiring within Asterisk, with the previously noted exceptions.

See also

CDR function
NoCDR application
ResetCDR application

GetCPEID

Synopsis

Get ADSI CPE ID.

Syntax

GetCPEID()

Arguments

Description

Obtains and displays ADSI CPE ID and other information in order to properly setup dahdi.conf for on-hook operations.

ICES

Synopsis

Encode and stream using 'ices'.

Syntax

ICES(config)

Arguments

config

ICES configuration file.

Description

Streams to an icecast server using ices (available separately). A configuration file must be supplied for ices (see contrib/asterisk-ices.xml).

ICES version 2 client and server required.

SendImage

Synopsis

Sends an image file.

Syntax

SendImage(filename)

Arguments

filename

Path of the filename (image) to send.

Description

Send an image file on a channel supporting it.

Result of transmission will be stored in SENDIMAGESTATUS

SENDIMAGESTATUS

SUCCESS Transmission succeeded. FAILURE Transmission failed. UNSUPPORTED Image transmission not supported by channel.

See also

SendText application
SendURL application

IVRDemo

Synopsis

IVR Demo Application.

Syntax

IVRDemo(filename)

Arguments

filename

(no description)

Description

This is a skeleton application that shows you the basic structure to create your own asterisk applications and demonstrates the IVR demo.

JACK

Synopsis

Jack Audio Connection Kit

Syntax

JACK([options])

Arguments

options

s Connect to the specified jack server name i Connect the output port that gets created to the specified jack input port o Connect the input port that gets created to the specified jack output port c By default, Asterisk will use the channel name for the jack client name. Use this option to specify a custom client name.

Description

When executing this application, two jack ports will be created; one input and one output. Other applications can be hooked up to these ports to access audio coming from, or being send to the channel.

Macro

Synopsis

Macro Implementation.

Syntax

Macro(name[,args])

Arguments

name	The name of the macro
args	(no description)

Description

Executes a macro using the context macro-name, 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.

If you Goto out of the Macro context, the Macro will terminate and control will be returned at the location of the Goto.

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.

Because of the way Macro is implemented (it executes the priorities contained within it via sub-engine), and a fixed per-thread memory stack allowance, macros are limited to 7 levels of nesting (macro calling macro calling macro, etc.); It may be possible that stack-intensive applications in deeply nested macros could cause asterisk to crash earlier than this limit. It is advised that if you need to deeply nest macro calls, that you use the Gosub application (now allows arguments like a Macro) with explict Return() calls instead.

Use of the application WaitExten within a macro will not function as expected. Please use the Read application in order to read DTMF from a channel currently executing a macro.

See also

MacroExit application
Goto application
Gosub application

MacroIf

Synopsis

Conditional Macro implementation.

Syntax

MacroIf(expr,destination)

Arguments

expr	(no description)
destination	(no description)

Description

Executes macro defined in macroiftrue if expr is true (otherwise macroiffalse if provided)

Arguments and return values as in application Macro()

See also

GotoIf application
GosubIf application
IF function

MacroExclusive

Synopsis

Exclusive Macro Implementation.

Syntax

MacroExclusive(name[,arg1[,arg2]])

Arguments

name	The name of the macro
arg1	(no description)
arg2	(no description)

Description

Executes macro defined in the context macro-name. Only one call at a time may run the macro. (we'll wait if another call is busy executing in the Macro)

Arguments and return values as in application Macro()

See also

Macro application

MacroExit

Synopsis

Exit from Macro.

Syntax

MacroExit()

Arguments

Description

Causes the currently running macro to exit as if it had ended normally by running out of priorities to execute. If used outside a macro, will likely cause unexpected behavior.

See also

Macro application

MeetMe

Synopsis

MeetMe conference bridge.

Syntax

MeetMe([confno[,options[,pin]]])

Arguments

confno	The conference number
options	a Set admin mode. A Set marked mode. b Run AGI script specified in MEETME_AGI_BACKGROUND Default: conf-background.agi. This does not work with non-DAHDI channels in the same conference). c Announce user(s) count on joining a conference. C Continue in dialplan when kicked out of conference. d Dynamically add conference. D Dynamically add conference, prompting for a PIN. e Select an empty conference. E Select an empty pinless conference. F Pass DTMF through the conference. i Announce user join/leave with review. I Announce user join/leave without review. l Set listen only mode (Listen only, no talking). m Set initially muted. M Enable music on hold when the conference has a single caller. Optionally, specify a musiconhold class to use. If one is not provided, it will use the channel's currently set music class, or default. o Set talker optimization - treats talkers who aren't speaking as being muted, meaning (a) No encode is done on transmission and (b) Received audio that is not registered as talking is omitted causing no buildup in background noise. p Allow user to exit the conference by pressing # (default) or any of the defined keys. If keys contain * this will override option s. The key used is set to channel variable MEETME_EXIT_KEY. P Always prompt for the pin even if it is specified. q Quiet mode (don't play enter/leave sounds). r Record conference (records as MEETME_RECORDINGFILE using format MEETME_RECORDINGFORMAT. Default filename is meetme-conf-rec-${CONFNO}-${UNIQUEID} and the default format is wav. s Present menu (user or admin) when * is received (send to menu). t Set talk only mode. (Talk only, no listening). T Set talker detection (sent to manager interface and meetme list). W Wait until the marked user enters the conference. x Close the conference when last marked user exits X Allow user to exit the conference by entering a valid single digit extension MEETME_EXIT_CONTEXT or the current context if that variable is not defined. 1 Do not play message when first person enters S Kick the user x seconds after he entered into the conference. L Limit the conference to x ms. Play a warning when y ms are left. Repeat the warning every z ms. The following special variables can be used with this option: CONF_LIMIT_TIMEOUT_FILE File to play when time is up. CONF_LIMIT_WARNING_FILE File to play as warning if y is defined. The default is to say the time remaining.
pin	(no description)

Description

Enters the user into a specified MeetMe conference. If the confno is omitted, the user will be prompted to enter one. User can exit the conference by hangup, or if the p option is specified, by pressing #.

The DAHDI kernel modules and at least one hardware driver (or dahdi_dummy) must be present for conferencing to operate properly. In addition, the chan_dahdi channel driver must be loaded for the i and r options to operate at all.

See also

MeetMeCount application
MeetMeAdmin application
MeetMeChannelAdmin application

MeetMeCount

Synopsis

MeetMe participant count.

Syntax

MeetMeCount(confno[,var])

Arguments

confno	Conference number.
var	(no description)

Description

Plays back the number of users in the specified MeetMe conference. If var is specified, playback will be skipped and the value will be returned in the variable. Upon application completion, MeetMeCount will hangup the channel, unless priority n+1 exists, in which case priority progress will continue.

See also

MeetMe application

MeetMeAdmin

Synopsis

MeetMe conference administration.

Syntax

MeetMeAdmin(confno,command[,user])

Arguments

confno	(no description)
command	e Eject last user that joined. E Extend conference end time, if scheduled. k Kick one user out of conference. K Kick all users out of conference. l Unlock conference. L Lock conference. m Unmute one user. M Mute one user. n Unmute all users in the conference. N Mute all non-admin users in the conference. r Reset one user's volume settings. R Reset all users volume settings. s Lower entire conference speaking volume. S Raise entire conference speaking volume. t Lower one user's talk volume. T Raise one user's talk volume. u Lower one user's listen volume. U Raise one user's listen volume. v Lower entire conference listening volume. V Raise entire conference listening volume.
user	(no description)

Description

Run admin command for conference confno.

Will additionally set the variable MEETMEADMINSTATUS with one of the following values:

MEETMEADMINSTATUS

NOPARSE Invalid arguments. NOTFOUND User specified was not found. FAILED Another failure occurred. OK The operation was completed successfully.

See also

MeetMe application

MeetMeChannelAdmin

Synopsis

MeetMe conference Administration (channel specific).

Syntax

MeetMeChannelAdmin(channel,command)

Arguments

channel	(no description)
command	k Kick the specified user out of the conference he is in. m Unmute the specified user. M Mute the specified user.

Description

Run admin command for a specific channel in any coference.

SLAStation

Synopsis

Shared Line Appearance Station.

Syntax

SLAStation(station)

Arguments

station

Station name

Description

This application should be executed by an SLA station. The argument depends on how the call was initiated. If the phone was just taken off hook, then the argument station should be just the station name. If the call was initiated by pressing a line key, then the station name should be preceded by an underscore and the trunk name associated with that line button.

For example: station1_line1

On exit, this application will set the variable SLASTATION_STATUS to one of the following values:

SLASTATION_STATUS

FAILURE CONGESTION SUCCESS

SLATrunk

Synopsis

Shared Line Appearance Trunk.

Syntax

SLATrunk(trunk[,options])

Arguments

trunk	Trunk name
options	M Play back the specified MOH class instead of ringing

Description

This application should be executed by an SLA trunk on an inbound call. The channel calling this application should correspond to the SLA trunk with the name trunk that is being passed as an argument.

On exit, this application will set the variable SLATRUNK_STATUS to one of the following values:

SLATRUNK_STATUS

FAILURE SUCCESS UNANSWERED RINGTIMEOUT

Milliwatt

Synopsis

Generate a Constant 1004Hz tone at 0dbm (mu-law).

Syntax

Milliwatt([options])

Arguments

options

o Generate the tone at 1000Hz like previous version.

Description

Previous versions of this application generated the tone at 1000Hz. If for some reason you would prefer that behavior, supply the o option to get the old behavior.

MinivmRecord

Synopsis

Receive Mini-Voicemail and forward via e-mail.

Syntax

MinivmRecord(mailbox[,options])

Arguments

mailbox	Voicemail username Voicemail domain
options	0 Jump to the o extension in the current dialplan context. * Jump to the a extension in the current dialplan context. g Amount of gain to use Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB).

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf

MiniVM records audio file in configured format and forwards message to e-mail and pager.

If there's no user account for that address, a temporary account will be used with default options.

The recorded file name and path will be stored in MVM_FILENAME and the duration of the message will be stored in MVM_DURATION

If the caller hangs up after the recording, the only way to send the message and clean up is to execute in the h extension. The application will exit if any of the following DTMF digits are received and the requested extension exist in the current context.

MVM_RECORD_STATUS

This is the status of the record operation SUCCESS USEREXIT FAILED

MinivmGreet

Synopsis

Play Mini-Voicemail prompts.

Syntax

MinivmGreet(mailbox[,options])

Arguments

mailbox	Voicemail username Voicemail domain
options	b Play the busy greeting to the calling party. s Skip the playback of instructions for leaving a message to the calling party. u Play the unavailable greeting.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

MinivmGreet() plays default prompts or user specific prompts for an account.

Busy and unavailable messages can be choosen, but will be overridden if a temporary message exists for the account.

MVM_GREET_STATUS

This is the status of the greeting playback. SUCCESS USEREXIT FAILED

MinivmNotify

Synopsis

Notify voicemail owner about new messages.

Syntax

MinivmNotify(mailbox[,options])

Arguments

mailbox	Voicemail username Voicemail domain
options	template E-mail template to use for voicemail notification

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

MiniVMnotify forwards messages about new voicemail to e-mail and pager. If there's no user account for that address, a temporary account will be used with default options (set in minivm.conf).

If the channel variable MVM_COUNTER is set, this will be used in the message file name and available in the template for the message.

If no template is given, the default email template will be used to send email and default pager template to send paging message (if the user account is configured with a paging address.

MVM_NOTIFY_STATUS

This is the status of the notification attempt SUCCESS FAILED

MinivmDelete

Synopsis

Delete Mini-Voicemail voicemail messages.

Syntax

MinivmDelete(filename)

Arguments

filename

File to delete

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

It deletes voicemail file set in MVM_FILENAME or given filename.

MVM_DELETE_STATUS

This is the status of the delete operation. SUCCESS FAILED

MinivmAccMess

Synopsis

Record account specific messages.

Syntax

MinivmAccMess(mailbox[,options])

Arguments

mailbox	Voicemail username Voicemail domain
options	u Record the unavailable greeting. b Record the busy greeting. t Record the temporary greeting. n Account name.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

Use this application to record account specific audio/video messages for busy, unavailable and temporary messages.

Account specific directories will be created if they do not exist.

MVM_ACCMESS_STATUS

This is the result of the attempt to record the specified greeting. FAILED is set if the file can't be created. SUCCESS FAILED

MinivmMWI

Synopsis

Send Message Waiting Notification to subscriber(s) of mailbox.

Syntax

MinivmMWI(mailbox,urgent,new,old)

Arguments

mailbox	Voicemail username Voicemail domain
urgent	Number of urgent messages in mailbox.
new	Number of new messages in mailbox.
old	Number of old messages in mailbox.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

MinivmMWI is used to send message waiting indication to any devices whose channels have subscribed to the mailbox passed in the first parameter.

MixMonitor

Synopsis

Record a call and mix the audio during the recording.

Syntax

MixMonitor(file[,options[,command]])

Arguments

file	If filename is an absolute path, uses that path, otherwise creates the file in the configured monitoring directory from asterisk.conf.
options	a Append to the file instead of overwriting it. b Only save audio to the file while the channel is bridged. Does not include conferences or sounds played to each bridged party If you utilize this option inside a Local channel, you must make sure the Local channel is not optimized away. To do this, be sure to call your Local channel with the /n option. For example: Dial(Local/start@mycontext/n) v Adjust the heard volume by a factor of x (range -4 to 4) V Adjust the spoken volume by a factor of x (range -4 to 4) W Adjust both, heard and spoken volumes by a factor of x (range -4 to 4)
command	Will be executed when the recording is over. Any strings matching ^{X} will be unescaped to X. All variables will be evaluated at the time MixMonitor is called.

Description

Records the audio on the current channel to the specified file.

MIXMONITOR_FILENAME

Will contain the filename used to record.

See also

Monitor application
StopMixMonitor application
PauseMonitor application
UnpauseMonitor application

StopMixMonitor

Synopsis

Stop recording a call through MixMonitor.

Syntax

StopMixMonitor()

Arguments

Description

Stops the audio recording that was started with a call to MixMonitor() on the current channel.

See also

MixMonitor application

Morsecode

Synopsis

Plays morse code.

Syntax

Morsecode(string)

Arguments

string

String to playback as morse code to channel

Description

Plays the Morse code equivalent of the passed string.

This application uses the following variables:

MORSEDITLEN	Use this value in (ms) for length of dit
MORSETONE	The pitch of the tone in (Hz), default is 800

See also

SayAlpha application
SayPhonetic application

MP3Player

Synopsis

Play an MP3 file or stream.

Syntax

MP3Player(Location)

Arguments

Location

Location of the file to be played. (argument passed to mpg123)

Description

Executes mpg123 to play the given location, which typically would be a filename or a URL. User can exit by pressing any key on the dialpad, or by hanging up.

NBScat

Synopsis

Play an NBS local stream.

Syntax

NBScat()

Arguments

Description

Executes nbscat to listen to the local NBS stream. User can exit by pressing any key.

Originate

Synopsis

Originate a call.

Syntax

Originate(tech_data,type,arg1[,arg2[,arg3]])

Arguments

tech_data	Channel technology and data for creating the outbound channel. For example, SIP/1234.
type	This should be app or exten, depending on whether the outbound channel should be connected to an application or extension.
arg1	If the type is app, then this is the application name. If the type is exten, then this is the context that the channel will be sent to.
arg2	If the type is app, then this is the data passed as arguments to the application. If the type is exten, then this is the extension that the channel will be sent to.
arg3	If the type is exten, then this is the priority that the channel is sent to. If the type is app, then this parameter is ignored.

Description

This application originates an outbound call and connects it to a specified extension or application. This application will block until the outgoing call fails or gets answered. At that point, this application will exit with the status variable set and dialplan processing will continue.

This application sets the following channel variable before exiting:

ORIGINATE_STATUS

This indicates the result of the call origination. FAILED SUCCESS BUSY CONGESTION HANGUP RINGING UNKNOWN In practice, you should never see this value. Please report it to the issue tracker if you ever see it.

Page

Synopsis

Page series of phones

Syntax

Page(Technology/Resource[,options[,timeout]])

Arguments

Technology/Resource	Specification of the device(s) to dial. These must be in the format of Technology/Resource, where Technology represents a particular channel driver, and Resource represents a resource available to that particular channel driver. Optional extra devices to dial inparallel If you need more then one enter them as Technology2/Resource2& Technology3/Resourse3&.....
options	d Full duplex audio i Ignore attempts to forward the call q Quiet, do not play beep to caller r Record the page into a file (meetme option r) s Only dial a channel if its device state says that it is NOT_INUSE
timeout	Specify the length of time that the system will attempt to connect a call. After this duration, any intercom calls that have not been answered will be hung up by the system.

Description

Places outbound calls to the given technology/resource and dumps them into a conference bridge as muted participants. The original caller is dumped into the conference as a speaker and the room is destroyed when the original callers leaves.

See also

MeetMe application

ParkAndAnnounce

Synopsis

Park and Announce.

Syntax

ParkAndAnnounce(announce_template,timeout,dial[,return_context])

Arguments

announce_template	Colon-separated list of files to announce. The word PARKED will be replaced by a say_digits of the extension in which the call is parked.
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 priority+1.

Description

Park a call into the parkinglot and announce the call to another channel.

The variable PARKEDAT will contain the parking extension into which the call was placed. Use with the Local channel to allow the dialplan to make use of this information.

See also

Park application
ParkedCall application

Playback

Synopsis

Play a file.

Syntax

Playback(filenames[,options])

Arguments

filenames	(no description)
options	Comma separated list of options skip Do not play if not answered noanswer Playback without answering, otherwise the channel will be answered before the sound is played. Not all channel types support playing messages while still on hook.

Description

Plays back given filenames (do not put extension of wav/alaw etc). The playback command answer the channel if no options are specified. If the file is non-existant it will fail

This application sets the following channel variable upon completion:

PLAYBACKSTATUS

The status of the playback attempt as a text string. SUCCESS FAILED

See Also: Background (application) -- for playing sound files that are interruptible

WaitExten (application) -- wait for digits from caller, optionally play music on hold

PlayTones

Synopsis

Play a tone list.

Syntax

PlayTones(arg)

Arguments

arg	Arg is either the tone name defined in the indications.conf configuration file, or a directly specified list of frequencies and durations.

Description

Plays a tone list. Execution will continue with the next step in the dialplan immediately while the tones continue to play.

See the sample indications.conf for a description of the specification of a tonelist.

See also

StopPlayTones application

StopPlayTones

Synopsis

Stop playing a tone list.

Syntax

StopPlayTones()

Arguments

Description

Stop playing a tone list, initiated by PlayTones().

See also

PlayTones application

PrivacyManager

Synopsis

Require phone number to be entered, if no CallerID sent

Syntax

PrivacyManager([maxretries[,minlength[,context]]])

Arguments

maxretries	Total tries caller is allowed to input a callerid. Defaults to 3.
minlength	Minimum allowable digits in the input callerid number. Defaults to 10.
context	Context to check the given callerid against patterns.

Description

If no Caller*ID is sent, PrivacyManager answers the channel and asks the caller to enter their phone number. The caller is given maxretries attempts to do so. The application does nothing if Caller*ID was received on the channel.

The application sets the following channel variable upon completion:

PRIVACYMGRSTATUS

The status of the privacy manager's attempt to collect a phone number from the user. SUCCESS FAILED

See also

Zapateller application

Queue

Synopsis

Queue a call for a call queue.

Syntax

Queue(queuename[,options[,URL[,announceoverride[,timeout[,AGI[,macro[,gosub[,rule[,position]]]]]]]]])

Arguments

queuename	(no description)
options	C Mark all calls as "answered elsewhere" when cancelled. c Continue in the dialplan if the callee hangs up. d data-quality (modem) call (minimum delay). h Allow callee to hang up by pressing *. H Allow caller to hang up by pressing *. n No retries on the timeout; will exit this application and go to the next step. i Ignore call forward requests from queue members and do nothing when they are requested. I Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on this dial attempt. r Ring instead of playing MOH. Periodic Announcements are still made, if applicable. t Allow the called user to transfer the calling user. T Allow the calling user to transfer the call. w Allow the called user to write the conversation to disk via Monitor. W Allow the calling user to write the conversation to disk via Monitor. k Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf. K Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf. x Allow the called user to write the conversation to disk via MixMonitor. X Allow the calling user to write the conversation to disk via MixMonitor.
URL	URL will be sent to the called party if the channel supports it.
announceoverride	(no description)
timeout	Will cause the queue to fail out after a specified number of seconds, checked between each queues.conftimeout and retry cycle.
AGI	Will setup an AGI script to be executed on the calling party's channel once they are connected to a queue member.
macro	Will run a macro on the calling party's channel once they are connected to a queue member.
gosub	Will run a gosub on the calling party's channel once they are connected to a queue member.
rule	Will cause the queue's defaultrule to be overridden by the rule specified.
position	Attempt to enter the caller into the queue at the numerical position specified. 1 would attempt to enter the caller at the head of the queue, and 3 would attempt to place the caller third in the queue.

Description

In addition to transferring the call, a call may be parked and then picked up by another user.

This application will return to the dialplan if the queue does not exist, or any of the join options cause the caller to not enter the queue.

This application sets the following channel variable upon completion:

QUEUESTATUS

The status of the call as a text string. TIMEOUT FULL JOINEMPTY LEAVEEMPTY JOINUNAVAIL LEAVEUNAVAIL CONTINUE

See also

AddQueueMember application
RemoveQueueMember application
PauseQueueMember application
UnpauseQueueMember application
AgentLogin application
QUEUE_MEMBER_COUNT function
QUEUE_MEMBER_LIST function
QUEUE_WAITING_COUNT function

AddQueueMember

Synopsis

Dynamically adds queue members.

Syntax

AddQueueMember(queuename[,interface[,penalty[,options[,membername[,stateinterface]]]]])

Arguments

queuename	(no description)
interface	(no description)
penalty	(no description)
options	(no description)
membername	(no description)
stateinterface	(no description)

Description

Dynamically adds interface to an existing queue. If the interface is already in the queue it will return an error.

This application sets the following channel variable upon completion:

AQMSTATUS

The status of the attempt to add a queue member as a text string. ADDED MEMBERALREADY NOSUCHQUEUE

See also

RemoveQueueMember application
PauseQueueMember application
UnpauseQueueMember application
AgentLogin application

RemoveQueueMember

Synopsis

Dynamically removes queue members.

Syntax

RemoveQueueMember(queuename[,interface[,options]])

Arguments

queuename	(no description)
interface	(no description)
options	(no description)

Description

If the interface is NOT in the queue it will return an error.

This application sets the following channel variable upon completion:

RQMSTATUS

REMOVED NOTINQUEUE NOSUCHQUEUE

Example: RemoveQueueMember(techsupport,SIP/3000)

See also

Queue application
AddQueueMember application
PauseQueueMember application
UnpauseQueueMember application

PauseQueueMember

Synopsis

Pauses a queue member.

Syntax

PauseQueueMember([queuename,interface[,options[,reason]]])

Arguments

queuename	(no description)
interface	(no description)
options	(no description)
reason	Is used to add extra information to the appropriate queue_log entries and manager events.

Description

Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue. This prevents any calls from being sent from the queue to the interface until it is unpaused with UnpauseQueueMember or the manager interface. If no queuename is given, the interface is paused in every queue it is a member of. The application will fail if the interface is not found.

This application sets the following channel variable upon completion:

PQMSTATUS

The status of the attempt to pause a queue member as a text string. PAUSED NOTFOUND

Example: PauseQueueMember(,SIP/3000)

See also

UnpauseQueueMember application

UnpauseQueueMember

Synopsis

Unpauses a queue member.

Syntax

UnpauseQueueMember([queuename,interface[,options[,reason]]])

Arguments

queuename	(no description)
interface	(no description)
options	(no description)
reason	Is used to add extra information to the appropriate queue_log entries and manager events.

Description

Unpauses (resumes calls to) a queue member. This is the counterpart to PauseQueueMember() and operates exactly the same way, except it unpauses instead of pausing the given interface.

This application sets the following channel variable upon completion:

UPQMSTATUS

The status of the attempt to unpause a queue member as a text string. UNPAUSED NOTFOUND

Example: UnpauseQueueMember(,SIP/3000)

See also

PauseQueueMember application

QueueLog

Synopsis

Writes to the queue_log file.

Syntax

QueueLog(queuename,uniqueid,agent,event[,additionalinfo])

Arguments

queuename	(no description)
uniqueid	(no description)
agent	(no description)
event	(no description)
additionalinfo	(no description)

Description

Allows you to write your own events into the queue log.

Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)

See also

Queue application

Read

Synopsis

Read a variable.

Syntax

Read(variable[,filenames[,maxdigits[,options[,attempts[,timeout]]]]])

Arguments

variable	The input digits will be stored in the given variable name.
filenames	file(s) to play before reading digits or tone with option i
maxdigits	Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the # key). Defaults to 0 - no limit - wait for the user press the # key. Any value below 0 means the same. Max accepted value is 255.
options	s to return immediately if the line is not up. i to play filename as an indication tone from your indications.conf. n to read digits even if the line is not up.
attempts	If greater than 1, that many attempts will be made in the event no data is entered.
timeout	The number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout. Can be floating point.

Description

Reads a #-terminated string of digits a certain number of times from the user in to the given variable.

This application sets the following channel variable upon completion:

READSTATUS

This is the status of the read operation. OK ERROR HANGUP INTERRUPTED SKIPPED TIMEOUT

See also

SendDTMF application

ReadExten

Synopsis

Read an extension into a variable.

Syntax

ReadExten(variable[,filename[,context[,option[,timeout]]]])

Arguments

variable	(no description)
filename	File to play before reading digits or tone with option i
context	Context in which to match extensions.
option	s Return immediately if the channel is not answered. i Play filename as an indication tone from your indications.conf n Read digits even if the channel is not answered.
timeout	An integer number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout.

Description

Reads a # terminated string of digits from the user into the given variable.

Will set READEXTENSTATUS on exit with one of the following statuses:

READEXTENSTATUS

OK A valid extension exists in ${variable}. TIMEOUT No extension was entered in the specified time. Also sets ${variable} to "t". INVALID An invalid extension, ${INVALID_EXTEN}, was entered. Also sets ${variable} to "i". SKIP Line was not up and the option 's' was specified. ERROR Invalid arguments were passed.

ReadFile

Synopsis

Read the contents of a text file into a channel variable.

Syntax

ReadFile(varname,fileparams)

Arguments

varname	Result stored here.
fileparams	The name of the file to read. Maximum number of characters to capture. If not specified defaults to max.

Description

Read the contents of a text file into channel variable varname

ReadFile has been deprecated in favor of Set(varname=${FILE(file,0,length)})

See also

System application
Read application

Record

Synopsis

Record to a file.

Syntax

Record(filename[,silence[,maxduration[,options]]])

Arguments

filename	Is the format of the file type to be recorded (wav, gsm, etc).
silence	Is the number of seconds of silence to allow before returning.
maxduration	Is the maximum recording duration in seconds. If missing or 0 there is no maximum.
options	a Append to existing recording rather than replacing. n Do not answer, but record anyway if line not yet answered. q quiet (do not play a beep tone). s skip recording if the line is not yet answered. t use alternate '*' terminator key (DTMF) instead of default '#' x Ignore all terminator keys (DTMF) and keep recording until hangup. k Keep recording if channel hangs up.

Description

If filename contains %d, these characters will be replaced with a number incremented by one each time the file is recorded. Use core show file formats to see the available formats on your system User can press # to terminate the recording and continue to the next priority. If the user hangs up during a recording, all data will be lost and the application will terminate.

RECORDED_FILE	Will be set to the final filename of the recording.
RECORD_STATUS	This is the final status of the command DTMF A terminating DTMF was received ('#' or '*', depending upon option 't') SILENCE The maximum silence occurred in the recording. SKIP The line was not yet answered and the 's' option was specified. TIMEOUT The maximum length was reached. HANGUP The channel was hung up. ERROR An unrecoverable error occurred, which resulted in a WARNING to the logs.

SayUnixTime

Synopsis

Says a specified time in a custom format.

Syntax

SayUnixTime([unixtime[,timezone[,format]]])

Arguments

unixtime	time, in seconds since Jan 1, 1970. May be negative. Defaults to now.
timezone	timezone, see /usr/share/zoneinfo for a list. Defaults to machine default.
format	a format the time is to be said in. See voicemail.conf. Defaults to ABdY "digits/at" IMp

Description

Uses some of the sound files stored in /var/lib/asterisk/sounds to construct a phrase saying the specified date and/or time in the specified format.

See also

STRFTIME function
STRPTIME function
IFTIME function

DateTime

Synopsis

Says a specified time in a custom format.

Syntax

DateTime([unixtime[,timezone[,format]]])

Arguments

unixtime	time, in seconds since Jan 1, 1970. May be negative. Defaults to now.
timezone	timezone, see /usr/share/zoneinfo for a list. Defaults to machine default.
format	a format the time is to be said in. See voicemail.conf. Defaults to ABdY "digits/at" IMp

Description

Say the date and time in a specified format.

SendDTMF

Synopsis

Sends arbitrary DTMF digits

Syntax

SendDTMF(digits[,timeout_ms[,duration_ms]])

Arguments

digits	List of digits 0-9,*#,abcd
timeout_ms	Amount of time to wait in ms between tones. (defaults to .25s)
duration_ms	Duration of each digit

Description

DTMF digits sent to a channel with half second pause

It will pass all digits or terminate if it encounters an error.

See also

Read application

SendText

Synopsis

Send a Text Message.

Syntax

SendText(text)

Arguments

text	(no description)

Description

Sends text to current channel (callee).

Result of transmission will be stored in the SENDTEXTSTATUS

SENDTEXTSTATUS

SUCCESS Transmission succeeded. FAILURE Transmission failed. UNSUPPORTED Text transmission not supported by channel.

At this moment, text is supposed to be 7 bit ASCII in most channels.

See also

SendImage application
SendURL application

SetCallerPres

Synopsis

Set CallerID Presentation.

Syntax

SetCallerPres(presentation)

Arguments

presentation

Presentation Allowed, Not Screened. Presentation Allowed, Passed Screen. Presentation Allowed, Failed Screen. Presentation Allowed, Network Number. Presentation Prohibited, Not Screened. Presentation Prohibited, Passed Screen. Presentation Prohibited, Failed Screen. Presentation Prohibited, Network Number. Number Unavailable.

Description

Set Caller*ID presentation on a call.

Skel

Synopsis

Simple one line explaination.

Syntax

Skel(dummy[,options])

Arguments

dummy	(no description)
options	a Option A. b Option B. c Option C.

Description

This application is a template to build other applications from. It shows you the basic structure to create your own Asterisk applications.

SMS

Synopsis

Communicates with SMS service centres and SMS capable analogue phones.

Syntax

SMS(name[,options[,addr[,body]]])

Arguments

name	The name of the queue used in /var/spool/asterisk/sms
options	a Answer, i.e. send initial FSK packet. s Act as service centre talking to a phone. t Use protocol 2 (default used is protocol 1). p Set the initial delay to N ms (default is 300). addr and body are a deprecated format to send messages out. r Set the Status Report Request (SRR) bit. o The body should be coded as octets not 7-bit symbols.
addr	(no description)
body	(no description)

Description

SMS handles exchange of SMS data with a call to/from SMS capable phone or SMS PSTN service center. Can send and/or receive SMS messages. Works to ETSI ES 201 912; compatible with BT SMS PSTN service in UK and Telecom Italia in Italy.

Typical usage is to use to handle calls from the SMS service centre CLI, or to set up a call using outgoing or manager interface to connect service centre to SMS().

"Messages are processed as per text file message queues. smsq (a separate software) is a command to generate message queues and send messages.

The protocol has tight delay bounds. Please use short frames and disable/keep short the jitter buffer on the ATA to make sure that respones (ACK etc.) are received in time.

SoftHangup

Synopsis

Hangs up the requested channel.

Syntax

SoftHangup(Technology/Resource[,options])

Arguments

Technology/Resource	(no description)
options	a Hang up all channels on a specified device instead of a single resource

Description

Hangs up the requested channel. If there are no channels to hangup, the application will report it.

SpeechCreate

Synopsis

Create a Speech Structure.

Syntax

SpeechCreate(engine_name)

Arguments

engine_name

(no description)

Description

This application creates information to be used by all the other applications. It must be called before doing any speech recognition activities such as activating a grammar. It takes the engine name to use as the argument, if not specified the default engine will be used.

SpeechActivateGrammar

Synopsis

Activate a grammar.

Syntax

SpeechActivateGrammar(grammar_name)

Arguments

grammar_name

(no description)

Description

This activates the specified grammar to be recognized by the engine. A grammar tells the speech recognition engine what to recognize, and how to portray it back to you in the dialplan. The grammar name is the only argument to this application.

SpeechStart

Synopsis

Start recognizing voice in the audio stream.

Syntax

SpeechStart()

Arguments

Description

Tell the speech recognition engine that it should start trying to get results from audio being fed to it.

SpeechBackground

Synopsis

Play a sound file and wait for speech to be recognized.

Syntax

SpeechBackground(sound_file[,timeout[,options]])

Arguments

sound_file	(no description)
timeout	Timeout integer in seconds. Note the timeout will only start once the sound file has stopped playing.
options	n Don't answer the channel if it has not already been answered.

Description

This application plays a sound file and waits for the person to speak. Once they start speaking playback of the file stops, and silence is heard. Once they stop talking the processing sound is played to indicate the speech recognition engine is working. Once results are available the application returns and results (score and text) are available using dialplan functions.

The first text and score are ${SPEECH_TEXT(0)} AND ${SPEECH_SCORE(0)} while the second are ${SPEECH_TEXT(1)} and ${SPEECH_SCORE(1)}.

The first argument is the sound file and the second is the timeout integer in seconds.

SpeechDeactivateGrammar

Synopsis

Deactivate a grammar.

Syntax

SpeechDeactivateGrammar(grammar_name)

Arguments

grammar_name

The grammar name to deactivate

Description

This deactivates the specified grammar so that it is no longer recognized.

SpeechProcessingSound

Synopsis

Change background processing sound.

Syntax

SpeechProcessingSound(sound_file)

Arguments

sound_file

(no description)

Description

This changes the processing sound that SpeechBackground plays back when the speech recognition engine is processing and working to get results.

SpeechDestroy

Synopsis

End speech recognition.

Syntax

SpeechDestroy()

Arguments

Description

This destroys the information used by all the other speech recognition applications. If you call this application but end up wanting to recognize more speech, you must call SpeechCreate() again before calling any other application.

SpeechLoadGrammar

Synopsis

Load a grammar.

Syntax

SpeechLoadGrammar(grammar_name,path)

Arguments

grammar_name	(no description)
path	(no description)

Description

Load a grammar only on the channel, not globally.

SpeechUnloadGrammar

Synopsis

Unload a grammar.

Syntax

SpeechUnloadGrammar(grammar_name)

Arguments

grammar_name

(no description)

Description

Unload a grammar.

Gosub

Synopsis

Jump to label, saving return address.

Syntax

Gosub([[context,]exten,]priority)

Arguments

context	(no description)
exten	(no description)
priority	(no description)

Description

Jumps to the label specified, saving the return address.

See also

GosubIf application
Macro application
Goto application
Return application
StackPop application

GosubIf

Synopsis

Conditionally jump to label, saving return address.

Syntax

GosubIf(condition,destination)

Arguments

condition	(no description)
destination	(no description)

Description

If the condition is true, then jump to labeliftrue. If false, jumps to labeliffalse, if specified. In either case, a jump saves the return point in the dialplan, to be returned to with a Return.

See also

Gosub application
Return application
MacroIf application
IF function
GotoIf application

Return

Synopsis

Return from gosub routine.

Syntax

Return([value])

Arguments

value

Return value.

Description

Jumps to the last label on the stack, removing it. The return value, if any, is saved in the channel variable GOSUB_RETVAL.

See also

Gosub application
StackPop application

StackPop

Synopsis

Remove one address from gosub stack.

Syntax

StackPop()

Arguments

Description

Removes last label on the stack, discarding it.

See also

Return application
Gosub application

System

Synopsis

Execute a system command.

Syntax

System(command)

Arguments

command

Command to execute

Description

Executes a command by using system(). If the command fails, the console should report a fallthrough.

Result of execution is returned in the SYSTEMSTATUS channel variable:

SYSTEMSTATUS

FAILURE Could not execute the specified command. SUCCESS Specified command successfully executed.

TrySystem

Synopsis

Try executing a system command.

Syntax

TrySystem(command)

Arguments

command

Command to execute

Description

Executes a command by using system().

Result of execution is returned in the SYSTEMSTATUS channel variable:

SYSTEMSTATUS

FAILURE Could not execute the specified command. SUCCESS Specified command successfully executed. APPERROR Specified command successfully executed, but returned error code.

BackgroundDetect

Synopsis

Background a file with talk detect.

Syntax

BackgroundDetect(filename[,sil[,min[,max[,analysistime]]]])

Arguments

filename	(no description)
sil	If not specified, defaults to 1000.
min	If not specified, defaults to 100.
max	If not specified, defaults to infinity.
analysistime	If not specified, defaults to infinity.

Description

Plays back filename, waiting for interruption from a given digit (the digit must start the beginning of a valid extension, or it will be ignored). During the playback of the file, audio is monitored in the receive direction, and if a period of non-silence which is greater than min ms yet less than max ms is followed by silence for at least sil ms, which occurs during the first analysistime ms, then the audio playback is aborted and processing jumps to the talk extension, if available.

TestServer

Synopsis

Execute Interface Test Server.

Syntax

TestServer()

Arguments

Description

Perform test server function and write call report. Results stored in /var/log/asterisk/testreports/<testid>-server.txt

See also

TestClient application

TestClient

Synopsis

Execute Interface Test Client.

Syntax

TestClient(testid)

Arguments

testid

An ID to identify this test.

Description

Executes test client with given testid. Results stored in /var/log/asterisk/testreports/<testid>-client.txt

See also

TestServer application

Transfer

Synopsis

Transfer caller to remote extension.

Syntax

Transfer(dest)

Arguments

dest	(no description)

Description

Requests the remote caller be transferred to a given destination. If TECH (SIP, IAX2, LOCAL etc) is used, only an incoming call with the same channel technology will be transfered. Note that for SIP, if you transfer before call is setup, a 302 redirect SIP message will be returned to the caller.

The result of the application will be reported in the TRANSFERSTATUS channel variable:

TRANSFERSTATUS

SUCCESS Transfer succeeded. FAILURE Transfer failed. UNSUPPORTED Transfer unsupported by channel driver.

SendURL

Synopsis

Send a URL.

Syntax

SendURL(URL[,option])

Arguments

URL	(no description)
option	w Execution will wait for an acknowledgement that the URL has been loaded before continuing.

Description

Requests client go to URL (IAX2) or sends the URL to the client (other channels).

Result is returned in the SENDURLSTATUS channel variable:

SENDURLSTATUS

SUCCESS URL successfully sent to client. FAILURE Failed to send URL. NOLOAD Client failed to load URL (wait enabled). UNSUPPORTED Channel does not support URL transport.

SendURL continues normally if the URL was sent correctly or if the channel does not support HTML transport. Otherwise, the channel is hung up.

See also

SendImage application
SendText application

UserEvent

Synopsis

Send an arbitrary event to the manager interface.

Syntax

UserEvent(eventname[,body])

Arguments

eventname	(no description)
body	(no description)

Description

Sends an arbitrary event to the manager interface, with an optional body representing additional arguments. The body may be specified as a | delimited list of headers. Each additional argument will be placed on a new line in the event. The format of the event will be:

Event: UserEvent

UserEvent: <specified event name>

[body]

If no body is specified, only Event and UserEvent headers will be present.

Verbose

Synopsis

Send arbitrary text to verbose output.

Syntax

Verbose([level,]message)

Arguments

level	Must be an integer value. If not specified, defaults to 0.
message	Output text message.

Description

Sends an arbitrary text message to verbose output.

Log

Synopsis

Send arbitrary text to a selected log level.

Syntax

Log([level,]message)

Arguments

level	Level must be one of ERROR, WARNING, NOTICE, DEBUG, VERBOSE or DTMF.
message	Output text message.

Description

Sends an arbitrary text message to a selected log level.

VoiceMail

Synopsis

Leave a Voicemail message.

Syntax

VoiceMail(mailboxs[,options])

Arguments

mailboxs

(no description)

options

b Play the busy greeting to the calling party. d Accept digits for a new extension in context c, if played during the greeting. Context defaults to the current context. g Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB). Only works on supported technologies, which is DAHDI only. s Skip the playback of instructions for leaving a message to the calling party. u Play the unavailable greeting. U Mark message as URGENT. P Mark message as PRIORITY.

Description

This application allows the calling party to leave a message for the specified list of mailboxes. When multiple mailboxes are specified, the greeting will be taken from the first mailbox specified. Dialplan execution will stop if the specified mailbox does not exist.

The Voicemail application will exit if any of the following DTMF digits are received:

Jump to the o extension in the current dialplan context.

Jump to the a extension in the current dialplan context.

This application will set the following channel variable upon completion:

VMSTATUS

This indicates the status of the execution of the VoiceMail application. SUCCESS USEREXIT FAILED

VoiceMailMain

Synopsis

Check Voicemail messages.

Syntax

VoiceMailMain(mailbox[,options])

Arguments

mailbox	(no description)
options	p Consider the mailbox parameter as a prefix to the mailbox that is entered by the caller. g Use the specified amount of gain when recording a voicemail message. The units are whole-number decibels (dB). s Skip checking the passcode for the mailbox. a Skip folder prompt and go directly to folder specified. Defaults to INBOX.

Description

This application allows the calling party to check voicemail messages. A specific mailbox, and optional corresponding context, may be specified. If a mailbox is not provided, the calling party will be prompted to enter one. If a context is not specified, the default context will be used.

MailboxExists

Synopsis

Check to see if Voicemail mailbox exists.

Syntax

MailboxExists(mailbox[,options])

Arguments

mailbox	(no description)
options	None options.

Description

Check to see if the specified mailbox exists. If no voicemail context is specified, the default context will be used.

This application will set the following channel variable upon completion:

VMBOXEXISTSSTATUS

This will contain the status of the execution of the MailboxExists application. Possible values include: SUCCESS FAILED

VMAuthenticate

Synopsis

Authenticate with Voicemail passwords.

Syntax

VMAuthenticate(mailbox[,options])

Arguments

mailbox	(no description)
options	s Skip playing the initial prompts.

Description

This application behaves the same way as the Authenticate application, but the passwords are taken from voicemail.conf. If the mailbox is specified, only that mailbox's password will be considered valid. If the mailbox is not specified, the channel variable AUTH_MAILBOX will be set with the authenticated mailbox.

WaitForRing

Synopsis

Wait for Ring Application.

Syntax

WaitForRing(timeout)

Arguments

timeout

(no description)

Description

Returns 0 after waiting at least timeout seconds, and only after the next ring has completed. Returns 0 on success or -1 on hangup.

WaitForSilence

Synopsis

Waits for a specified amount of silence.

Syntax

WaitForSilence(silencerequired[,iterations[,timeout]])

Arguments

silencerequired	(no description)
iterations	If not specified, defaults to 1.
timeout	Is specified only to avoid an infinite loop in cases where silence is never achieved.

Description

Waits for up to silencerequired milliseconds of silence, iterations times. An optional timeout specified the number of seconds to return after, even if we do not receive the specified amount of silence. Use timeout with caution, as it may defeat the purpose of this application, which is to wait indefinitely until silence is detected on the line. This is particularly useful for reverse-911-type call broadcast applications where you need to wait for an answering machine to complete its spiel before playing a message.

Typically you will want to include two or more calls to WaitForSilence when dealing with an answering machine; first waiting for the spiel to finish, then waiting for the beep, etc.

Examples:

WaitForSilence(500,2) will wait for 1/2 second of silence, twice

WaitForSilence(1000) will wait for 1 second of silence, once

WaitForSilence(300,3,10) will wait for 300ms silence, 3 times, and returns after 10 sec, even if silence is not detected

Sets the channel variable WAITSTATUS to one of these values:

WAITSTATUS

SILENCE if exited with silence detected. TIMEOUT if exited without silence detected after timeout.

See also

WaitForNoise application

WaitForNoise

Synopsis

Waits for a specified amount of noise.

Syntax

WaitForNoise(noiserequired[,iterations[,timeout]])

Arguments

noiserequired	(no description)
iterations	If not specified, defaults to 1.
timeout	Is specified only to avoid an infinite loop in cases where silence is never achieved.

Description

Waits for up to noiserequired milliseconds of noise, iterations times. An optional timeout specified the number of seconds to return after, even if we do not receive the specified amount of noise. Use timeout with caution, as it may defeat the purpose of this application, which is to wait indefinitely until noise is detected on the line.

See also

WaitForSilence application

WaitUntil

Synopsis

Wait (sleep) until the current time is the given epoch.

Syntax

WaitUntil(epoch)

Arguments

epoch

(no description)

Description

Waits until the given epoch.

Sets WAITUNTILSTATUS to one of the following values:

WAITUNTILSTATUS

OK Wait succeeded. FAILURE Invalid argument. HANGUP Channel hungup before time elapsed. PAST Time specified had already past.

While

Synopsis

Start a while loop.

Syntax

While(expr)

Arguments

expr	(no description)

Description

Start a While Loop. Execution will return to this point when EndWhile() is called until expr is no longer true.

See also

EndWhile application
ExitWhile application
ContinueWhile application

EndWhile

Synopsis

End a while loop.

Syntax

EndWhile()

Arguments

Description

Return to the previous called While().

See also

While application
ExitWhile application
ContinueWhile application

ExitWhile

Synopsis

End a While loop.

Syntax

ExitWhile()

Arguments

Description

Exits a While() loop, whether or not the conditional has been satisfied.

See also

While application
EndWhile application
ContinueWhile application

ContinueWhile

Synopsis

Restart a While loop.

Syntax

ContinueWhile()

Arguments

Description

Returns to the top of the while loop and re-evaluates the conditional.

See also

While application
EndWhile application
ExitWhile application

Zapateller

Synopsis

Block telemarketers with SIT.

Syntax

Zapateller(options)

Arguments

options

Comma delimited list of options. 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.

Description

Generates special information tone to block telemarketers from calling you.

This application will set the following channel variable upon completion:

ZAPATELLERSTATUS

This will contain the last action accomplished by the Zapateller application. Possible values include: NOTHING ANSWERED ZAPPED

ODBCFinish

Synopsis

Clear the resultset of a sucessful multirow query.

Syntax

ODBCFinish(result-id)

Arguments

result-id

(no description)

Description

For queries which are marked as mode=multirow, this will clear any remaining rows of the specified resultset.

ClearHash

Synopsis

Clear the keys from a specified hashname.

Syntax

ClearHash(hashname)

Arguments

hashname

(no description)

Description

Clears all keys out of the specified hashname.

Bridge

Synopsis

Bridge two channels.

Syntax

Bridge(channel[,options])

Arguments

channel	The current channel is bridged to the specified channel.
options	p Play a courtesy tone to channel.

Description

Allows the ability to bridge two channels via the dialplan.

This application sets the following channel variable upon completion:

BRIDGERESULT

The result of the bridge attempt as a text string. SUCCESS FAILURE LOOP NONEXISTENT INCOMPATIBLE

ParkedCall

Synopsis

Answer a parked call.

Syntax

ParkedCall(exten)

Arguments

exten

(no description)

Description

Used to connect to a parked call. This application is always registered internally and does not need to be explicitly added into the dialplan, although you should include the parkedcalls context. If no extension is provided, then the first available parked call will be acquired.

See also

Park application
ParkAndAnnounce application

Park

Synopsis

Park yourself.

Syntax

Park([timeout[,return_context[,return_exten[,return_priority[,options]]]]])

Arguments

timeout	A custom parking timeout for this parked call.
return_context	The context to return the call to after it times out.
return_exten	The extension to return the call to after it times out.
return_priority	The priority to return the call to after it times out.
options	A list of options for this parked call. r Send ringing instead of MOH to the parked call. R Randomize the selection of a parking space. s Silence announcement of the parking space number.

Description

Used to park yourself (typically in combination with a supervised transfer to know the parking space). This application is always registered internally and does not need to be explicitly added into the dialplan, although you should include the parkedcalls context (or the context specified in features.conf).

If you set the PARKINGEXTEN variable to an extension in your parking context, Park() will park the call on that extension, unless it already exists. In that case, execution will continue at next priority.

See also

ParkAndAnnounce application
ParkedCall application

Answer

Synopsis

Answer a channel if ringing.

Syntax

Answer([delay[,nocdr]])

Arguments

delay	Asterisk will wait this number of milliseconds before returning to the dialplan after answering the call.
nocdr	Asterisk will send an answer signal to the calling phone, but will not set the disposition or answer time in the CDR for this call.

Description

If the call has not been answered, this application will answer it. Otherwise, it has no effect on the call.

See also

Hangup application

BackGround

Synopsis

Play an audio file while waiting for digits of an extension to go to.

Syntax

BackGround(filenames[,options[,langoverride[,context]]])

Arguments

filenames	(no description)
options	s 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 this happens, the application will return immediately. n Don't answer the channel before playing the files. m Only break if a digit hit matches a one digit extension in the destination context.
langoverride	Explicitly specifies which language to attempt to use for the requested sound files.
context	This is the dialplan context that this application will use when exiting to a dialed extension.

Description

This application will play the given list of files (do not put extension) while waiting for an extension to be dialed by the calling channel. To continue waiting for digits after this application has finished playing files, the WaitExten application should be used.

If one of the requested sound files does not exist, call processing will be terminated.

This application sets the following channel variable upon completion:

BACKGROUNDSTATUS

The status of the background attempt as a text string. SUCCESS FAILED

See also

ControlPlayback application
WaitExten application
BackgroundDetect application
TIMEOUT function

Busy

Synopsis

Indicate the Busy condition.

Syntax

Busy([timeout])

Arguments

timeout

If specified, the calling channel will be hung up after the specified number of seconds. Otherwise, this application will wait until the calling channel hangs up.

Description

This application will indicate the busy condition to the calling channel.

See also

Congestion application
Progess application
Playtones application
Hangup application

Congestion

Synopsis

Indicate the Congestion condition.

Syntax

Congestion([timeout])

Arguments

timeout

If specified, the calling channel will be hung up after the specified number of seconds. Otherwise, this application will wait until the calling channel hangs up.

Description

This application will indicate the congestion condition to the calling channel.

See also

Busy application
Progess application
Playtones application
Hangup application

ExecIfTime

Synopsis

Conditional application execution based on the current time.

Syntax

ExecIfTime(day_condition,appname)

Arguments

day_condition	(no description)
appname	(no description)

Description

This application will execute the specified dialplan application, with optional arguments, if the current time matches the given time specification.

See also

Exec application
TryExec application

Goto

Synopsis

Jump to a particular priority, extension, or context.

Syntax

Goto([[context,]extensions,]priority)

Arguments

context	(no description)
extensions	(no description)
priority	(no description)

Description

This application will set the current context, extension, and priority in the channel structure. After it completes, the pbx engine will continue dialplan execution at the specified location. If no specific extension, or extension and context, are specified, then this application will just set the specified priority of the current extension.

At least a priority is required as an argument, or the goto will return a -1, and the channel and call will be terminated.

If the location that is put into the channel information is bogus, and asterisk cannot find that location in the dialplan, then the execution engine will try to find and execute the code in the i (invalid) extension in the current context. If that does not exist, it will try to execute the h extension. If either or neither the h or i extensions have been defined, the channel is hung up, and the execution of instructions on the channel is terminated. What this means is that, for example, you specify a context that does not exist, then it will not be possible to find the h or i extensions, and the call will terminate!

See also

GotoIf application
GotoIfTime application
Gosub application
Macro application

GotoIf

Synopsis

Conditional goto.

Syntax

GotoIf(condition,destination)

Arguments

condition	(no description)
destination	Continue at labeliftrue if the condition is true. Continue at labeliffalse if the condition is false.

Description

This application will set the current context, extension, and priority in the channel structure based on the evaluation of the given condition. After this application completes, the pbx engine will continue dialplan execution at the specified location in the dialplan. The labels are specified with the same syntax as used within the Goto application. If the label chosen by the condition is omitted, no jump is performed, and the execution passes to the next instruction. If the target location is bogus, and does not exist, the execution engine will try to find and execute the code in the i (invalid) extension in the current context. If that does not exist, it will try to execute the h extension. If either or neither the h or i extensions have been defined, the channel is hung up, and the execution of instructions on the channel is terminated. Remember that this command can set the current context, and if the context specified does not exist, then it will not be able to find any 'h' or 'i' extensions there, and the channel and call will both be terminated!.

See also

Goto application
GotoIfTime application
GosubIf application
MacroIf application

GotoIfTime

Synopsis

Conditional Goto based on the current time.

Syntax

GotoIfTime(condition,destination)

Arguments

condition	(no description)
destination	(no description)

Description

This application will set the context, extension, and priority in the channel structure based on the evaluation of the given time specification. After this application completes, the pbx engine will continue dialplan execution at the specified location in the dialplan. If the current time is within the given time specification, the channel will continue at labeliftrue. Otherwise the channel will continue at labeliffalse. If the label chosen by the condition is omitted, no jump is performed, and execution passes to the next instruction. If the target jump location is bogus, the same actions would be taken as for Goto. Further information on the time specification can be found in examples illustrating how to do time-based context includes in the dialplan.

See also

GotoIf application
IFTIME function

ImportVar

Synopsis

Import a variable from a channel into a new variable.

Syntax

ImportVar(newvar,vardata)

Arguments

newvar	(no description)
vardata	(no description)

Description

This application imports a variable from the specified channel (as opposed to the current one) and stores it as a variable (newvar) in the current channel (the channel that is calling this application). Variables created by this application have the same inheritance properties as those created with the Set application.

See also

Set application

Hangup

Synopsis

Hang up the calling channel.

Syntax

Hangup([causecode])

Arguments

causecode

If a causecode is given the channel's hangup cause will be set to the given value.

Description

This application will hang up the calling channel.

See also

Answer application
Busy application
Congestion application

Incomplete

Synopsis

Returns AST_PBX_INCOMPLETE value.

Syntax

Incomplete([n])

Arguments

n	If specified, then Incomplete will not attempt to answer the channel first. Most channel types need to be in Answer state in order to receive DTMF.

Description

Signals the PBX routines that the previous matched extension is incomplete and that further input should be allowed before matching can be considered to be complete. Can be used within a pattern match when certain criteria warrants a longer match.

NoOp

Synopsis

Do Nothing (No Operation).

Syntax

NoOp([text])

Arguments

text	Any text provided can be viewed at the Asterisk CLI.

Description

This application does nothing. However, it is useful for debugging purposes.

This method can be used to see the evaluations of variables or functions without having any effect.

See also

Verbose application
Log application

Proceeding

Synopsis

Indicate proceeding.

Syntax

Proceeding()

Arguments

Description

This application will request that a proceeding message be provided to the calling channel.

Progress

Synopsis

Indicate progress.

Syntax

Progress()

Arguments

Description

This application will request that in-band progress information be provided to the calling channel.

See also

Busy application
Congestion application
Ringing application
Playtones application

RaiseException

Synopsis

Handle an exceptional condition.

Syntax

RaiseException(reason)

Arguments

reason

(no description)

Description

This application will jump to the e extension in the current context, setting the dialplan function EXCEPTION(). If the e extension does not exist, the call will hangup.

See also

Exception function

ResetCDR

Synopsis

Resets the Call Data Record.

Syntax

ResetCDR([options])

Arguments

options

w Store the current CDR record before resetting it. a Store any stacked records. v Save CDR variables. e Enable CDR only (negate effects of NoCDR).

Description

This application causes the Call Data Record to be reset.

See also

ForkCDR application
NoCDR application

Ringing

Synopsis

Indicate ringing tone.

Syntax

Ringing()

Arguments

Description

This application will request that the channel indicate a ringing tone to the user.

See also

Busy application
Congestion application
Progress application
Playtones application

SayAlpha

Synopsis

Say Alpha.

Syntax

SayAlpha(string)

Arguments

string

(no description)

Description

This application will play the sounds that correspond to the letters of the given string.

See also

SayDigits application
SayNumber application
SayPhonetic application
CHANNEL function

SayDigits

Synopsis

Say Digits.

Syntax

SayDigits(digits)

Arguments

digits

(no description)

Description

This application will play the sounds that correspond to the digits of the given number. This will use the language that is currently set for the channel.

See also

SayAlpha application
SayNumber application
SayPhonetic application
CHANNEL function

SayNumber

Synopsis

Say Number.

Syntax

SayNumber(digits[,gender])

Arguments

digits	(no description)
gender	(no description)

Description

This application will play the sounds that correspond to the given digits. Optionally, a gender may be specified. This will use the language that is currently set for the channel. See the LANGUAGE() function for more information on setting the language for the channel.

See also

SayAlpha application
SayDigits application
SayPhonetic application
CHANNEL function

SayPhonetic

Synopsis

Say Phonetic.

Syntax

SayPhonetic(string)

Arguments

string

(no description)

Description

This application will play the sounds from the phonetic alphabet that correspond to the letters in the given string.

See also

SayAlpha application
SayDigits application
SayNumber application

Set

Synopsis

Set channel variable or function value.

Syntax

Set(name,value)

Arguments

name	(no description)
value	(no description)

Description

This function can be used to set the value of channel variables or dialplan functions. When setting variables, if the variable name is prefixed with _, the variable will be inherited into channels created from the current channel. If the variable name is prefixed with __, the variable will be inherited into channels created from the current channel and all children channels.

If (and only if), in /etc/asterisk/asterisk.conf, you have a [compat] category, and you have app_set = 1.6 under that,then the behavior of this app changes, and does not strip surrounding quotes from the right hand side as it did previously in 1.4. The app_set = 1.6 is only inserted if make samples is executed, or if users insert this by hand into the asterisk.conf file. The advantages of not stripping out quoting, and not caring about the separator characters (comma and vertical bar) were sufficient to make these changes in 1.6. Confusion about how many backslashes would be needed to properly protect separators and quotes in various database access strings has been greatly reduced by these changes.

See also

MSet application
GLOBAL function
SET function
ENV function

MSet

Synopsis

Set channel variable(s) or function value(s).

Syntax

MSet(set1[,set2])

Arguments

set1	(no description)
set2	(no description)

Description

This function can be used to set the value of channel variables or dialplan functions. When setting variables, if the variable name is prefixed with _, the variable will be inherited into channels created from the current channel If the variable name is prefixed with __, the variable will be inherited into channels created from the current channel and all children channels. MSet behaves in a similar fashion to the way Set worked in 1.2/1.4 and is thus prone to doing things that you may not expect. For example, it strips surrounding double-quotes from the right-hand side (value). If you need to put a separator character (comma or vert-bar), you will need to escape them by inserting a backslash before them. Avoid its use if possible.

See also

Set application

SetAMAFlags

Synopsis

Set the AMA Flags.

Syntax

SetAMAFlags([flag])

Arguments

flag	(no description)

Description

This application will set the channel's AMA Flags for billing purposes.

See also

CDR function

Wait

Synopsis

Waits for some time.

Syntax

Wait(seconds)

Arguments

seconds

Can be passed with fractions of a second. For example, 1.5 will ask the application to wait for 1.5 seconds.

Description

This application waits for a specified number of seconds.

WaitExten

Synopsis

Waits for an extension to be entered.

Syntax

WaitExten([seconds[,options]])

Arguments

seconds	Can be passed with fractions of a second. For example, 1.5 will ask the application to wait for 1.5 seconds.
options	m Provide music on hold to the caller while waiting for an extension. Specify the class for music on hold.

Description

This application waits for the user to enter a new extension for a specified number of seconds.

See also

Background application
TIMEOUT function

AGI

Synopsis

Executes an AGI compliant application.

Syntax

AGI(command[,args])

Arguments

command	(no description)
args	(no description)

Description

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. As of 1.6.0, this channel will not stop dialplan execution on hangup inside of this application. Dialplan execution will continue normally, even upon hangup until the AGI application signals a desire to stop (either by exiting or, in the case of a net script, by closing the connection). A locally executed AGI script will receive SIGHUP on hangup from the channel except when using DeadAGI. A fast AGI server will correspondingly receive a HANGUP in OOB data. Both of these signals may be disabled by setting the AGISIGHUP channel variable to no before executing the AGI application.

Use the CLI command agi show commnands to list available agi commands.

This application sets the following channel variable upon completion:

AGISTATUS

The status of the attempt to the run the AGI script text string, one of: SUCCESS FAILURE NOTFOUND HANGUP

See also

EAGI application
DeadAGI application

EAGI

Synopsis

Executes an EAGI compliant application.

Syntax

EAGI()

Arguments

Description

Using 'EAGI' provides enhanced AGI, with incoming audio available out of band on file descriptor 3.

See also

AGI application
DeadAGI application

DeadAGI

Synopsis

Executes AGI on a hungup channel.

Syntax

DeadAGI()

Arguments

Description

See also

AGI application
EAGI application

JabberSend

Synopsis

Send a Jabber Message

Syntax

JabberSend(Jabber,JID,Message)

Arguments

Jabber	Client or transport Asterisk uses to connect to Jabber.
JID	XMPP/Jabber JID (Name) of recipient.
Message	Message to be sent to the buddy.

Description

Allows user to send a message to a receipent via XMPP.

JabberStatus

Synopsis

Retrieve the status of a jabber list member

Syntax

JabberStatus(Jabber,JID,Variable)

Arguments

Jabber	Client or transport Asterisk users to connect to Jabber.
JID	XMPP/Jabber JID (Name) of recipient.
Variable	Variable to store the status of requested user.

Description

This application is deprecated. Please use the JABBER_STATUS() function instead.

Retrieves the numeric status associated with the specified buddy JID. The return value in the Variablewill be one of the following.

Online.

Chatty.

Away.

Extended Away.

Do Not Disturb.

Offline.

Not In Roster.

Monitor

Synopsis

Monitor a channel.

Syntax

Monitor([file_format[,fname_base[,options]]])

Arguments

file_format	optional, if not set, defaults to wav
fname_base	if set, changes the filename used to the one specified.
options	m when the recording ends mix the two leg files into one and delete the two leg files. If the variable MONITOR_EXEC is set, the application referenced in it will be executed instead of soxmix/sox and the raw leg files will NOT be deleted automatically. soxmix/sox or MONITOR_EXEC is handed 3 arguments, the two leg files and a target mixed file name which is the same as the leg file names only without the in/out designator. If MONITOR_EXEC_ARGS is set, the contents will be passed on as additional arguments to MONITOR_EXEC. Both MONITOR_EXEC and the Mix flag can be set from the administrator interface. b Don't begin recording unless a call is bridged to another channel. i Skip recording of input stream (disables m option). o Skip recording of output stream (disables m option).

Description

Used to start monitoring a channel. The channel's input and output voice packets are logged to files until the channel hangs up or monitoring is stopped by the StopMonitor application.

By default, files are stored to /var/spool/asterisk/monitor/. Returns -1 if monitor files can't be opened or if the channel is already monitored, otherwise 0.

See also

StopMonitor application

StopMonitor

Synopsis

Stop monitoring a channel.

Syntax

StopMonitor()

Arguments

Description

Stops monitoring a channel. Has no effect if the channel is not monitored.

ChangeMonitor

Synopsis

Change monitoring filename of a channel.

Syntax

ChangeMonitor(filename_base)

Arguments

filename_base

The new filename base to use for monitoring this channel.

Description

Changes monitoring filename of a channel. Has no effect if the channel is not monitored.

PauseMonitor

Synopsis

Pause monitoring of a channel.

Syntax

PauseMonitor()

Arguments

Description

Pauses monitoring of a channel until it is re-enabled by a call to UnpauseMonitor.

See also

UnpauseMonitor application

UnpauseMonitor

Synopsis

Unpause monitoring of a channel.

Syntax

UnpauseMonitor()

Arguments

Description

Unpauses monitoring of a channel on which monitoring had previously been paused with PauseMonitor.

See also

PauseMonitor application

ODBC_Commit

Synopsis

Commits a currently open database transaction.

Syntax

ODBC_Commit([transaction ID])

Arguments

transaction ID

(no description)

Description

Commits the database transaction specified by transaction ID or the current active transaction, if not specified.

ODBC_Rollback

Synopsis

Rollback a currently open database transaction.

Syntax

ODBC_Rollback([transaction ID])

Arguments

transaction ID

(no description)

Description

Rolls back the database transaction specified by transaction ID or the current active transaction, if not specified.

AGENT

Synopsis

Gets information about an Agent

Syntax

AGENT(agentid[,item])

Arguments

agentid	(no description)
item	The valid items to retrieve are: (default) The status of the agent (LOGGEDIN | LOGGEDOUT) The password of the agent The name of the agent MusicOnHold class The name of the active channel for the Agent (AgentLogin)

Description

IAXPEER

Synopsis

Gets IAX peer information.

Syntax

IAXPEER(peername[,item])

Arguments

peername	If peername is specified to this value, return the IP address of the endpoint of the current channel
item	If peername is specified, valid items are: (default) The IP address. The peer's status (if qualify=yes) The configured mailbox. The configured context. The epoch time of the next expire. Is it dynamic? (yes/no). The configured Caller ID name. The configured Caller ID number. The configured codecs. Preferred codec index number x (beginning with 0)

Description

See also

SIPPEER function

IAXVAR

Synopsis

Sets or retrieves a remote variable.

Syntax

IAXVAR(varname)

Arguments

varname

(no description)

Description

SIP_HEADER

Synopsis

Gets the specified SIP header.

Syntax

SIP_HEADER(name[,number])

Arguments

name	(no description)
number	If not specified, defaults to 1.

Description

Since there are several headers (such as Via) which can occur multiple times, SIP_HEADER takes an optional second argument to specify which header with that name to retrieve. Headers start at offset 1.

SIPPEER

Synopsis

Gets SIP peer information.

Syntax

SIPPEER(peername[,item])

Arguments

peername

(no description)

item

(default) The ip address. The port number. The configured mailbox. The configured context. The epoch time of the next expire. Is it dynamic? (yes/no). The configured Caller ID name. The configured Caller ID number. The configured Callgroup. The configured Pickupgroup. The configured codecs. Status (if qualify=yes). Registration extension. Call limit (call-limit). Configured call level for signalling busy. Current amount of calls. Only available if call-limit is set. Default language for peer. Account code for this peer. Current user agent id for peer. A channel variable configured with setvar for this peer. Preferred codec index number x (beginning with zero).

Description

SIPCHANINFO

Synopsis

Gets the specified SIP parameter from the current channel.

Syntax

SIPCHANINFO(item)

Arguments

item	The IP address of the peer. The source IP address of the peer. The URI from the From: header. The URI from the Contact: header. The useragent. The name of the peer. 1 if T38 is offered or enabled in this channel, otherwise 0.

Description

CHECKSIPDOMAIN

Synopsis

Checks if domain is a local domain.

Syntax

CHECKSIPDOMAIN(domain)

Arguments

domain

(no description)

Description

This function checks if the domain in the argument is configured as a local SIP domain that this Asterisk server is configured to handle. Returns the domain name if it is locally handled, otherwise an empty string. Check the domain= configuration in sip.conf.

QUEUE_VARIABLES

Synopsis

Return Queue information in variables.

Syntax

QUEUE_VARIABLES(queuename)

Arguments

queuename

Maxmimum number of calls allowed. The strategy of the queue. Number of calls currently in the queue. Current average hold time. Number of completed calls for the queue. Number of abandoned calls. Queue service level. Current service level performance.

Description

Makes the following queue variables available.

Returns 0 if queue is found and setqueuevar is defined, -1 otherwise.

QUEUE_MEMBER

Synopsis

Count number of members answering a queue.

Syntax

QUEUE_MEMBER(queuename,option)

Arguments

queuename	(no description)
option	Returns the number of logged-in members for the specified queue. Returns the number of logged-in members for the specified queue available to take a call. Returns the total number of members for the specified queue.

Description

Returns the number of members currently associated with the specified queuename.

QUEUE_MEMBER_COUNT

Synopsis

Count number of members answering a queue.

Syntax

QUEUE_MEMBER_COUNT(queuename)

Arguments

queuename

(no description)

Description

Returns the number of members currently associated with the specified queuename.

This function has been deprecated in favor of the QUEUE_MEMBER() function

See also

QUEUE_MEMBER_LIST function

QUEUE_WAITING_COUNT

Synopsis

Count number of calls currently waiting in a queue.

Syntax

QUEUE_WAITING_COUNT([queuename])

Arguments

queuename

(no description)

Description

Returns the number of callers currently waiting in the specified queuename.

QUEUE_MEMBER_LIST

Synopsis

Returns a list of interfaces on a queue.

Syntax

QUEUE_MEMBER_LIST(queuename)

Arguments

queuename

(no description)

Description

Returns a comma-separated list of members associated with the specified queuename.

See also

QUEUE_MEMBER_COUNT function

QUEUE_MEMBER_PENALTY

Synopsis

Gets or sets queue members penalty.

Syntax

QUEUE_MEMBER_PENALTY(queuename,interface)

Arguments

queuename	(no description)
interface	(no description)

Description

Gets or sets queue members penalty.

VALID_EXTEN

Synopsis

Determine whether an extension exists or not.

Syntax

VALID_EXTEN([context,extension[,priority]])

Arguments

context	Defaults to the current context
extension	(no description)
priority	Priority defaults to 1.

Description

Returns a true value if the indicated context, extension, and priority exist.

SPEECH_SCORE

Synopsis

Gets the confidence score of a result.

Syntax

SPEECH_SCORE([nbest_number,]result_number)

Arguments

nbest_number	(no description)
result_number	(no description)

Description

Gets the confidence score of a result.

SPEECH_TEXT

Synopsis

Gets the recognized text of a result.

Syntax

SPEECH_TEXT([nbest_number,]result_number)

Arguments

nbest_number	(no description)
result_number	(no description)

Description

Gets the recognized text of a result.