Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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 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 If the None - OUTBOUND_GROUP variable is set, all peer channels created by this application will be put into that group (as in Set(GROUP()=...). If the If the None - OUTBOUND_GROUP_ONCE variable is set, all peer channels created by this application will be put into that group (as in Set(GROUP()=...). Unlike If the None - 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

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 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 - Play an announcement to the called party, where x is the prompt to be played
      • x - The file to play to the called 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.
    • 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. 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 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 - 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.
      • called
      • calling
      • progress
    • e - Execute the h extension for peer after the call ends
    • f - 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 - When the caller hangs up, transfer the called party to the specified destination and start execution at that location. Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('').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. Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('').Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars (''). Using this option from a Macro() or GoSub() might not make sense as there would be no return points.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 - 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.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. 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 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 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 - 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: If set, this variable causes Asterisk to play the prompts to the caller. If set, this variable causes Asterisk to play the prompts to the callee. If specified, filename specifies the sound prompt to play when the timeout is reached. If not set, the time remaining will be announced. If specified, filename specifies the sound prompt to play when the call begins. If not set, the time remaining will be announced. 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.
      • x - Maximum call time, in milliseconds
      • y - Warning time, in milliseconds
      • z - Repeat time, in milliseconds
    • 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.
      • class
    • M - 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: If set, this action will be taken after the macro finished executing. 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.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()
      • macro - Name of the macro that should be executed.
      • arg - Macro arguments
    • 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.
      • 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 Caller*ID is present, do not screen the call.
    • o - 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 - 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 - 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
    • r - 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 indications.conf
    • S - Hang up the call x seconds after the called party has answered the call.
      • x
    • s - 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 - 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. 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.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.
      • x - Name of the subroutine to execute via Gosub
      • arg - Arguments for the Gosub routine
    • u - 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

Import Version

This documentation was imported from Asterisk version SVN-branch-1.8-r349044.

  • No labels