IAX2Provision()

Synopsis

Provision a calling IAXy with a given template.

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.

Syntax

IAX2Provision([template])

Arguments

• template - If not specified, defaults to default.
  

DAHDISendKeypadFacility()

Synopsis

Send digits out of band over a PRI.

Description

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

Syntax

DAHDISendKeypadFacility(digits)

Arguments

• digits

DAHDISendCallreroutingFacility()

Synopsis

Send an ISDN call rerouting/deflection facility message.

Description

This application will send an ISDN switch specific call rerouting/deflection facility message over the current channel. Supported switches depend upon the version of libpri in use.

Syntax

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

Arguments

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

DAHDIAcceptR2Call()

Synopsis

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

Description

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

Syntax

DAHDIAcceptR2Call(charge)

Arguments

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

SIPDtmfMode()

Synopsis

Change the dtmfmode for a SIP call.

Description

Changes the dtmfmode for a SIP call.

Syntax

SIPDtmfMode(mode)

Arguments

• mode

SIPAddParameter()

Synopsis

Add a SIP parameter to the From header in the outbound call.

Description

Adds a parameter to a SIP call placed with DIAL.

Use this with care. Adding the wrong tags may jeopardize the SIP dialog.

Always returns 0.

Syntax

SIPAddParameter(Parameter,Content)

Arguments

• Parameter
• Content

SIPAddHeader()

Synopsis

Add a SIP header to the outbound call.

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.

Syntax

SIPAddHeader(Header,Content)

Arguments

• Header
• Content

SIPRemoveHeader()

Synopsis

Remove SIP headers previously added with SIPAddHeader

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.

Syntax

SIPRemoveHeader([Header])

Arguments

• Header

SIPSendCustomINFO()

Synopsis

Send a custom INFO frame on specified channels.

Description

SIPSendCustomINFO() allows you to send a custom INFO message on all active SIP channels or on channels with the specified User Agent. This application is only available if TEST_FRAMEWORK is defined.

Syntax

SIPSendCustomINFO(Data,[UserAgent])

Arguments

• Data
• UserAgent

AELSub()

Synopsis

Launch subroutine built with AEL

Description

Execute the named subroutine, defined in AEL, from another dialplan language, such as extensions.conf, Realtime extensions, or Lua.

The purpose of this application is to provide a sane entry point into AEL subroutines, the implementation of which may change from time to time.

Syntax

AELSub(routine,[args])

Arguments

• routine - Named subroutine to execute.
  
• args

Macro()

Synopsis

Macro Implementation.

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 , , 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.

Syntax

Macro(name,arg1,[arg2[,...]]])

Arguments

• name - The name of the macro
  
• args
  • arg1
  • arg2

See Also

• Application_MacroExit
• Application_Goto
• Application_Gosub

MacroIf()

Synopsis

Conditional Macro implementation.

Description

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

Arguments and return values as in application Macro()

Syntax

MacroIf(expr:macroiftrue:[macroiffalse])

Arguments

• expr
• destination
  • macroiftrue
  • macroiffalse

See Also

• Application_GotoIf
• Application_GosubIf
• Function_IF

MacroExclusive()

Synopsis

Exclusive Macro Implementation.

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()

Syntax

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

Arguments

• name - The name of the macro
  
• arg1
• arg2

See Also

• Application_Macro

MacroExit()

Synopsis

Exit from Macro.

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

• Application_Macro

Dial()

Synopsis

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

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 execution 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:

	same => n,Dial(PJSIP/alice,30)

	same => n,Dial(PJSIP/alice&PJIP/bob,45)

	same => n,Dial(PJSIP/alice,,g)
	same => n,Log(NOTICE, Alice call result: ${DIALSTATUS})

	same => n,Dial(PJSIP/alice,,TX)

	same => n,Dial(PJSIP/alice,,L(60000:30000:10000))

	same => n,Dial(PJSIP/alice&PJSIP/bob,,Q(NO_ANSWER))

	[default]
	

	exten => callee_channel,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
	same => n,Log(NOTICE, I'm called on channel ${CHANNEL} prior to it starting the dial attempt)
	same => n,Return()
	

	exten => called_channel,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
	same => n,Log(NOTICE, I'm called on outbound channel ${CHANNEL} prior to it being used to dial someone)
	same => n,Return()
	

	exten => _X.,1,NoOp()
	same => n,Dial(PJSIP/alice,,b(default^called_channel^1(my_gosub_arg1^my_gosub_arg2))B(default^callee_channel^1(my_gosub_arg1^my_gosub_arg2)))
	same => n,Hangup()

	[my_gosub_routine]
	

	exten => s,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
	same => n,Playback(hello)
	same => n,Return()
	
	[default]
	

	exten => _X.,1,NoOp()
	same => n,Dial(PJSIP/alice,,U(my_gosub_routine^my_gosub_arg1^my_gosub_arg2))
	same => n,Hangup()

	same => n,Dial(PJSIP/alice,,G(jump_to_here))
	same => n(jump_to_here),Goto(confbridge)
	same => n,Goto(confbridge)
	same => n(confbridge),ConfBridge(${EXTEN})

• DIALEDTIME - This is the time from dialing a channel until when it is disconnected.
• DIALEDTIME_MS - This is the milliseconds version of the DIALEDTIME variable.
• ANSWEREDTIME - This is the amount of time for actual call.
• ANSWEREDTIME_MS - This is the milliseconds version of the ANSWEREDTIME variable.
• RINGTIME - This is the time from creating the channel to the first RINGING event received. Empty if there was no ring.
• RINGTIME_MS - This is the milliseconds version of the RINGTIME variable.
• PROGRESSTIME - This is the time from creating the channel to the first PROGRESS event received. Empty if there was no such event.
• PROGRESSTIME_MS - This is the milliseconds version of the PROGRESSTIME variable.
• DIALEDPEERNAME - The name of the outbound channel that answered the call.
• DIALEDPEERNUMBER - The number that was dialed for the answered outbound channel.
• FORWARDERNAME - If a call forward occurred, the name of the forwarded channel.
• 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

Syntax

Dial(Technology/Resource&[Technology2/Resource2[&...]],[timeout,[options,[URL]]]])

Arguments

• Technology/Resource
  • 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.
    
  • Technology2/Resource2 - Optional extra devices to dial in parallel
    If you need more than one enter them as Technology2/Resource2&Technology3/Resource3&.....
    
• timeout - Specifies the number of seconds we attempt to dial the specified devices.
  If not specified, this defaults to 136 years.
  
• options
  • A( x:y ) - Play an announcement to the called and/or calling parties, where x is the prompt to be played to the called party and y is the prompt to be played to the caller. The files may be different and will be played to each party simultaneously.
    
    • x - The file to play to the called party
      
    • y - The file to play to the calling party
      
  • a - Immediately answer the calling channel when the called channel answers in all cases. Normally, the calling channel is answered when the called channel answers, but when options such as A() and M() are used, the calling channel is not answered until all actions on the called channel (such as playing an announcement) are completed. This option can be used to answer the calling channel before doing anything on the called channel. You will rarely need to use this option, the default behavior is adequate in most cases.
    
  • b( context^exten^priority ) - Before initiating an outgoing call, Gosub to the specified location using the newly created channel. The Gosub will be executed for each destination channel.
    
    • context
    • exten
    • priority( params )
      • arg1[^arg1...]
      • argN
  • B( context^exten^priority ) - Before initiating the outgoing call(s), Gosub to the specified location using the current channel.
    
    • context
    • exten
    • priority( params )
      • arg1[^arg1...]
      • argN
  • C - Reset the call detail record (CDR) for this call.
    
  • c - If the Dial() application cancels this call, always set HANGUPCAUSE to '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.
    NOTE: Many SIP and ISDN phones cannot send DTMF digits until the call is connected. If you wish to use this option with these phones, you can use the Answer application before dialing.
    
  • D( called:calling:progress ) - 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 to the called party immediately after receiving a PROGRESS message.
    See SendDTMF for valid digits.
    
    • called
    • calling
    • progress
  • e - Execute the h extension for peer after the call ends
    
  • f( x ) - If x is not provided, force the CallerID sent on a call-forward or deflection to the dialplan extension of this Dial() using a dialplan hint. For example, some PSTNs do not allow CallerID to be set to anything other than the numbers assigned to you. If x is provided, force the CallerID sent to x.
    
    • x
  • F( context^exten^priority ) - When the caller hangs up, transfer the called party to the specified destination and start execution at that location.
    NOTE: Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('_').
    
    • context
    • exten
    • priority
  • F - When the caller hangs up, transfer the called party to the next priority of the current extension and start execution at that location.
    NOTE: Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('_').
    NOTE: Using this option from a Macro() or GoSub() might not make sense as there would be no return points.
    
  • g - Proceed with dialplan execution at the next priority in the current extension if the destination channel hangs up.
    
  • G( context^exten^priority ) - If the call is answered, transfer the calling party to the specified priority and the called party to the specified priority plus one.
    NOTE: You cannot use any additional action post answer options in conjunction with this option.
    
    • context
    • exten
    • priority
  • h - Allow the called party to hang up by sending the DTMF sequence defined for disconnect in features.conf.
    
  • H - Allow the calling party to hang up by sending the DTMF sequence defined for disconnect in features.conf.
    NOTE: Many SIP and ISDN phones cannot send DTMF digits until the call is connected. If you wish to allow DTMF disconnect before the dialed party answers with these phones, you can use the Answer application before dialing.
    
  • i - Asterisk will ignore any forwarding requests it may receive on this dial attempt.
    
  • I - Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on 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( x:y:z ) - 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 - If set, this variable causes Asterisk to play the prompts to the caller.
      
      • YES default: (true)
      • NO
    • LIMIT_PLAYAUDIO_CALLEE - If set, this variable causes Asterisk to play the prompts to the callee.
      
      • YES
      • NO default: (true)
    • LIMIT_TIMEOUT_FILE - If specified, filename specifies the sound prompt to play when the timeout is reached. If not set, the time remaining will be announced.
      
      • FILENAME
    • LIMIT_CONNECT_FILE - If specified, filename specifies the sound prompt to play when the call begins. If not set, the time remaining will be announced.
      
      • FILENAME
    • LIMIT_WARNING_FILE - 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.
      
      • FILENAME
    • x - Maximum call time, in milliseconds
      
    • y - Warning time, in milliseconds
      
    • z - Repeat time, in milliseconds
      
  • m( class ) - 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.
    
    • class
  • M( macro^arg ) - 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:
    NOTE: You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are run on the peer (called) channel, so you will not be able to set timeouts via the TIMEOUT() function in this macro.
    WARNING: 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().
    NOTE: Macros are deprecated, GoSub should be used instead, see the U option.
    
    • 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.
    • macro - Name of the macro that should be executed.
      
    • arg - Macro arguments
      
  • n( delete ) - 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 directory.
    
    • delete - With delete either not specified or set to 0, the recorded introduction will not be deleted if the caller hangs up while the remote party has not yet answered.
      With delete set to 1, the introduction will always be deleted.
      
  • N - This option is a modifier for the call screening/privacy mode. It specifies that if CallerID is present, do not screen the call.
    
  • o( x ) - If x is not provided, specify that the CallerID that was present on the calling channel be stored as the CallerID on the called channel. This was the behavior of Asterisk 1.0 and earlier. If x is provided, specify the CallerID stored on the called channel. Note that o(${CALLERID(all)}) is similar to option o without the parameter.
    
    • x
  • O( mode ) - 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.
    
    • mode - 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.
      
  • p - This option enables screening mode. This is basically Privacy mode without memory.
    
  • P( x ) - 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.
    
    • x
  • Q( cause ) - Specify the Q.850/Q.931 cause to send on unanswered channels when another channel answers the call. As with Hangup(), cause can be a numeric cause code or a name such as NO_ANSWER, USER_BUSY, CALL_REJECTED or ANSWERED_ELSEWHERE (the default if Q isn't specified). You can also specify 0 or NONE to send no cause. See the causes.h file for the full list of valid causes and names.
    NOTE: chan_sip does not support setting the cause on a CANCEL to anything other than ANSWERED_ELSEWHERE.
    
    • cause
  • r( tone ) - Default: 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.
    
    • tone - Indicate progress to calling party. Send audio 'tone' from the indications.conf tonezone currently in use.
      
  • R - Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. Allow interruption of the ringback if early media is received on the channel.
    
  • S( x ) - Hang up the call x seconds after the called party has answered the call.
    
    • x
  • s( x ) - Force the outgoing CallerID tag parameter to be set to the string x.
    Works with the f option.
    
    • x
  • t - Allow the called party to transfer the calling party by sending the DTMF sequence defined in features.conf. This setting does not perform policy enforcement on transfers initiated by other methods.
    
  • T - Allow the calling party to transfer the called party by sending the DTMF sequence defined in features.conf. This setting does not perform policy enforcement on transfers initiated by other methods.
    
  • U( x^arg ) - 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.
    NOTE: You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are run on the called channel, so you will not be able to set timeouts via the TIMEOUT() function in this routine.
    
    • 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 destination.
    • x - Name of the subroutine context to execute via Gosub. The subroutine execution starts in the named context at the s exten and priority 1.
      
    • arg - Arguments for the Gosub routine
      
  • u( x ) - Works with the f option.
    
    • x - Force the outgoing callerid presentation indicator parameter to be set to one of the values passed in x: allowed_not_screened allowed_passed_screen allowed_failed_screen allowed prohib_not_screened prohib_passed_screen prohib_failed_screen prohib unavailable
      
  • 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.
  

See Also

• Application_RetryDial
• Application_SendDTMF
• Application_Gosub
• Application_Macro

RetryDial()

Synopsis

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

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.

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
  

See Also

• Application_Dial

SpeechCreate()

Synopsis

Create a Speech Structure.

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.

Sets the ERROR channel variable to 1 if the engine cannot be used.

Syntax

SpeechCreate(engine_name)

Arguments

• engine_name

SpeechActivateGrammar()

Synopsis

Activate a grammar.

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.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechActivateGrammar(grammar_name)

Arguments

• grammar_name

SpeechStart()

Synopsis

Start recognizing voice in the audio stream.

Description

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

Hangs up the channel on failure. If this is not desired, use TryExec.

SpeechBackground()

Synopsis

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

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.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

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

Arguments

• sound_file
• 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.
    

SpeechDeactivateGrammar()

Synopsis

Deactivate a grammar.

Description

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

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechDeactivateGrammar(grammar_name)

Arguments

• grammar_name - The grammar name to deactivate
  

SpeechProcessingSound()

Synopsis

Change background processing sound.

Description

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

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechProcessingSound(sound_file)

Arguments

• sound_file

SpeechDestroy()

Synopsis

End speech recognition.

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.

Hangs up the channel on failure. If this is not desired, use TryExec.

SpeechLoadGrammar()

Synopsis

Load a grammar.

Description

Load a grammar only on the channel, not globally.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechLoadGrammar(grammar_name,path)

Arguments

• grammar_name
• path

SpeechUnloadGrammar()

Synopsis

Unload a grammar.

Description

Unload a grammar.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechUnloadGrammar(grammar_name)

Arguments

• grammar_name

VoiceMail()

Synopsis

Leave a Voicemail message.

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:

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

Syntax

VoiceMail(mailbox1&[mailbox2[&...]],[options]])

Arguments

• mailboxs
  • mailbox1
  • mailbox2
• options
  • b - Play the busy greeting to the calling party.
    
  • d( c ) - Accept digits for a new extension in context c, if played during the greeting. Context defaults to the current context.
    
    • c
  • e - Play greetings as early media -- only answer the channel just before accepting the voice message.
    
  • 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.
    
  • S - Skip the playback of instructions for leaving a message to the calling party, but only if a greeting has been recorded by the mailbox user.
    
  • t( x ) - Play a custom beep tone to the caller instead of the default one. If this option is used but no file is specified, the beep is suppressed.
    
    • x
  • u - Play the unavailable greeting.
    
  • U - Mark message as URGENT.
    
  • P - Mark message as PRIORITY.
    

See Also

• Application_VoiceMailMain

VoiceMailMain()

Synopsis

Check Voicemail messages.

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.

The VoiceMailMain application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VoiceMailMain([mailbox@[context,[options]]])

Arguments

• mailbox
  • mailbox
  • context
• 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( folder ) - Skip folder prompt and go directly to folder specified. Defaults to INBOX (or 0).
    
    • folder

See Also

• Application_VoiceMail

VMAuthenticate()

Synopsis

Authenticate with Voicemail passwords.

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.

The VMAuthenticate application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VMAuthenticate([mailbox@[context,[options]]])

Arguments

• mailbox
  • mailbox
  • context
• options
  • s - Skip playing the initial prompts.
    

VoiceMailPlayMsg()

Synopsis

Play a single voice mail msg from a mailbox by msg id.

Description

This application sets the following channel variable upon completion:

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

Syntax

VoiceMailPlayMsg([mailbox@[context,]]msg_id)

Arguments

• mailbox
  • mailbox
  • context
• msg_id - The msg id of the msg to play back.
  

VMSayName()

Synopsis

Play the name of a voicemail user

Description

This application will say the recorded name of the voicemail user specified as the argument to this application. If no context is provided, default is assumed.

Similar to the Background() application, playback of the recorded name can be interrupted by entering an extension, which will be searched for in the current context.

Syntax

VMSayName([mailbox@[context]])

Arguments

• mailbox
  • mailbox
  • context

Exec()

Synopsis

Executes dialplan application.

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.

Syntax

Exec(arguments)

Arguments

• appname
  • arguments

TryExec()

Synopsis

Executes dialplan application, always returning.

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.

Syntax

TryExec(arguments)

Arguments

• appname
  • arguments

ExecIf()

Synopsis

Executes dialplan application, conditionally.

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.

Syntax

ExecIf(expression:appiftrue:[appiffalse])

Arguments

• expression
• execapp
  • appiftrue
  • appiffalse

SendDTMF()

Synopsis

Sends arbitrary DTMF digits

Description

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

Syntax

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

Arguments

• digits - List of digits 0-9,*#,a-d,A-D to send also w for a half second pause, W for a one second pause, and f or F for a flash-hook if the channel supports flash-hook.
  
• timeout_ms - Amount of time to wait in ms between tones. (defaults to .25s)
  
• duration_ms - Duration of each digit
  
• channel - Channel where digits will be played
  

See Also

• Application_Read

StreamEcho()

Synopsis

Echo media, up to 'N' streams of a type, and DTMF back to the calling party

Description

If a "num" (the number of streams) is not given then this simply echos back any media or DTMF frames (note, however if '#' is detected then the application exits) read from the calling channel back to itself. This means for any relevant frame read from a particular stream it is written back out to the associated write stream in a one to one fashion.

However if a "num" is specified, and if the calling channel allows it (a new offer is made requesting the allowance of additional streams) then any any media received, like before, is echoed back onto each stream. However, in this case a relevant frame received on a stream of the given "type" is also echoed back out to the other streams of that same type. It should be noted that when operating in this mode only the first stream found of the given "type" is allowed from the original offer. And this first stream found is also the only stream of that "type" granted read (send/receive) capabilities in the new offer whereas the additional ones are set to receive only.

Syntax

StreamEcho([num,[type]])

Arguments

• num - The number of streams of a type to echo back. If '0' is specified then all streams of a type are removed.
  
• type - The media type of the stream(s) to add or remove (in the case of "num" being '0'). This can be set to either "audio" or "video" (default). If "num" is empty (i.e. not specified) then this parameter is ignored.
  

Read()

Synopsis

Read a variable.

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

Syntax

Read(variable&filename&[filename2[&...]],[maxdigits,[options,[attempts,[timeout]]]]])

Arguments

• variable - The input digits will be stored in the given variable name.
  
• filenames
  • filename - file(s) to play before reading digits or tone with option i
    
  • filename2
• 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.
    
  • t - Terminator digit(s) to use for ending input. Default is #. If you need to read the digit # literally, you should remove or change the terminator character. Multiple terminator characters may be specified. If no terminator digit is present, input cannot be ended using digits and you will need to rely on duration and max digits for ending input.
    
• 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.
  

See Also

• Application_SendDTMF

SkelGuessNumber()

Synopsis

An example number guessing game

Description

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

Syntax

SkelGuessNumber(level,[options])

Arguments

• level
• options
  • c - The computer should cheat
    
  • n - How many games to play before hanging up
    

MinivmRecord()

Synopsis

Receive Mini-Voicemail and forward via e-mail.

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

• MVM_RECORD_STATUS - This is the status of the record operation
  • SUCCESS
  • USEREXIT
  • FAILED

Syntax

MinivmRecord(username@domain,[options])

Arguments

• mailbox
  • username - Voicemail username
    
  • domain - 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( gain ) - Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB).
    
    • gain - Amount of gain to use
      

MinivmGreet()

Synopsis

Play Mini-Voicemail prompts.

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

Syntax

MinivmGreet(username@domain,[options])

Arguments

• mailbox
  • username - Voicemail username
    
  • domain - 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.
    

MinivmNotify()

Synopsis

Notify voicemail owner about new messages.

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

Syntax

MinivmNotify(username@domain,[options])

Arguments

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

MinivmDelete()

Synopsis

Delete Mini-Voicemail voicemail messages.

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

Syntax

MinivmDelete(filename)

Arguments

• filename - File to delete
  

MinivmAccMess()

Synopsis

Record account specific messages.

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

Syntax

MinivmAccMess(username@domain,[options])

Arguments

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

MinivmMWI()

Synopsis

Send Message Waiting Notification to subscriber(s) of 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.

Syntax

MinivmMWI(username@domain,urgent,new,old)

Arguments

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

GetCPEID()

Synopsis

Get ADSI CPE ID.

Description

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

JACK()

Synopsis

Jack Audio Connection Kit

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.

Syntax

JACK([options])

Arguments

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