[svn-commits] jsmith: branch group/appdocsxml r135064 - in /team/group/appdocsxml: apps/ doc/
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Fri Aug 1 09:05:03 CDT 2008
Author: jsmith
Date: Fri Aug 1 09:05:03 2008
New Revision: 135064
URL: http://svn.digium.com/view/asterisk?view=rev&rev=135064
Log:
Check in some changes to the XML format that I wrote while on a very long plane ride to Korea... I sure like planes that have power plugs right at your seat!
Modified:
team/group/appdocsxml/apps/app_dial.c
team/group/appdocsxml/doc/xmldocumentation.txt
Modified: team/group/appdocsxml/apps/app_dial.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_dial.c?view=diff&rev=135064&r1=135063&r2=135064
==============================================================================
--- team/group/appdocsxml/apps/app_dial.c (original)
+++ team/group/appdocsxml/apps/app_dial.c Fri Aug 1 09:05:03 2008
@@ -65,328 +65,352 @@
/*** DOCUMENTATION
<application name="Dial" language="en_US">
<synopsis>
- Place a call and connect to the current channel.
+ Attempt to connect to another device or endpoint and bridge the call.
</synopsis>
+ <syntax>
+ <parameter name="Technology/Resource" required="true" argsep="&">
+ <argument name="Technology2/Resource2" multiple="true">
+ <para>Optional extra devices to dial in parallel</para>
+ <para>If you need more then one enter them as
+ Technology2/Resource2&Technology3/Resourse3&.....</para>
+ </argument>
+ <para>Specification of the device(s) to dial. These must be in the format of
+ <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
+ represents a particular channel driver, and <replaceable>Resource</replaceable>
+ represents a resource available to that particular channel driver.</para>
+ </parameter>
+ <parameter name="timeout" required="false">
+ <para>Specifies the number of seconds we attempt to dial the specified devices</para>
+ <para>If not specified, this defaults to 136 years.</para>
+ </parameter>
+ <parameter name="options" required="false">
+ <optionlist>
+ <option name="A">
+ <argument name="x" required="true">
+ <para>The file to play to the called party</para>
+ </argument>
+ <para>Play an announcement to the called party, where <replaceable>x</replaceable> is the prompt to be played</para>
+ </option>
+ <option name="C">
+ <para>Reset the call detail record (CDR) for this call.</para>
+ </option>
+ <option name="c">
+ <para>If the Dial() application cancels this call, always set the flag to tell the channel
+ driver that the call is answered elsewhere.</para>
+ </option>
+ <option name="d">
+ <para>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 <variable>EXITCONTEXT</variable> variable,
+ if it exists.</para>
+ </option>
+ <option name="D" argsep=":">
+ <argument name="called" />
+ <argument name="calling" />
+ <para>Send the specified DTMF strings <emphasis>after</emphasis> the called
+ party has answered, but before the call gets bridged. The
+ <replaceable>called</replaceable> DTMF string is sent to the called party, and the
+ <replaceable>calling</replaceable> DTMF string is sent to the calling party. Both arguments
+ can be used alone.</para>
+ </option>
+ <option name="e">
+ <para>Execute the <literal>h</literal> extension for peer after the call ends</para>
+ </option>
+ <option name="f">
+ <para>Force the callerid of the <emphasis>calling</emphasis> channel to be set as the
+ extension associated with the channel using a dialplan <literal>hint</literal>.
+ For example, some PSTNs do not allow CallerID to be set to anything
+ other than the number assigned to the caller.</para>
+ </option>
+ <option name="F" argsep="^">
+ <argument name="context" required="false" />
+ <argument name="exten" required="false" />
+ <argument name="priority" required="true" />
+ <para>When the caller hangs up, transfer the called party
+ to the specified destination and continue execution at that location.</para>
+ </option>
+ <option name="g">
+ <para>Proceed with dialplan execution at the next priority in the current extension if the
+ destination channel hangs up.</para>
+ </option>
+ <option name="G" argsep="^">
+ <argument name="context" required="false" />
+ <argument name="exten" required="false" />
+ <argument name="priority" required="true" />
+ <para>If the call is answered, transfer the calling party to
+ the specified <replaceable>priority</replaceable> and the called party to the specified
+ <replaceable>priority</replaceable> plus one.</para>
+ <note>
+ <para>You cannot use any additional action post answer options in conjunction with this option.</para>
+ </note>
+ </option>
+ <option name="h">
+ <para>Allow the called party to hang up by sending the <literal>*</literal> DTMF digit.</para>
+ </option>
+ <option name="H">
+ <para>Allow the calling party to hang up by hitting the <literal>*</literal> DTMF digit.</para>
+ </option>
+ <option name="i">
+ <para>Asterisk will ignore any forwarding requests it may receive on this dial attempt.</para>
+ </option>
+ <option name="k">
+ <para>Allow the called party to enable parking of the call by sending
+ the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
+ </option>
+ <option name="K">
+ <para>Allow the calling party to enable parking of the call by sending
+ the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
+ </option>
+ <option name="L" argsep=":">
+ <argument name="x" required="true">
+ <para>Maximum call time, in milliseconds</para>
+ </argument>
+ <argument name="y">
+ <para>Warning time, in milliseconds</para>
+ </argument>
+ <argument name="z">
+ <para>Repeat time, in milliseconds</para>
+ </argument>
+ <para>Limit the call to <replaceable>x</replaceable> milliseconds. Play a warning when <replaceable>y</replaceable> milliseconds are
+ left. Repeat the warning every <replaceable>z</replaceable> milliseconds until time expires.</para>
+ <para>This option is affected by the following variables:</para>
+ <variablelist>
+ <variable name="LIMIT_PLAYAUDIO_CALLER">
+ <value name="yes" default="true" />
+ <value name="no" />
+ <para>If set, this variable causes Asterisk to play the prompts to the caller.</para>
+ </variable>
+ <variable name="LIMIT_PLAYAUDIO_CALLEE">
+ <value name="yes" />
+ <value name="no" default="true"/>
+ <para>If set, this variable causes Asterisk to play the prompts to the callee.</para>
+ </variable>
+ <variable name="LIMIT_TIMEOUT_FILE">
+ <value name="filename"/>
+ <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play when the timeout is reached. If not set, the time remaining will be announced.</para>
+ </variable>
+ <variable name="LIMIT_CONNECT_FILE">
+ <value name="filename"/>
+ <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play when the call begins. If not set, the time remaining will be announced.</para>
+ </variable>
+ <variable name="LIMIT_WARNING_FILE">
+ <value name="filename"/>
+ <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play as a warning when time <replaceable>x</replaceable> is reached. If not set, the time remaining will be announced.</para>
+ </variable>
+ </variablelist>
+ </option>
+ <option name="m">
+ <argument name="class" required="false"/>
+ Provide hold music to the calling party until a requested
+ channel answers. A specific music on hold <replaceable>class</replaceable>
+ (as defined in <filename>musiconhold.conf</filename>) can be specified.
+ </option>
+ <option name="M" argsep="^">
+ <argument name="macro" required="true">
+ <para>Name of the macro that should be executed.</para>
+ </argument>
+ <argument name="arg" multiple="true">
+ <para>Macro arguments</para>
+ </argument>
+ <para>Execute the specified <replaceable>macro</replaceable> for the <emphasis>called</emphasis> channel
+ before connecting to the calling channel. Arguments can be specified to the Macro
+ using <literal>^</literal> as a delimiter. The macro can set the variable
+ <variable>MACRO_RESULT</variable> to specify the following actions after the macro is
+ finished executing:</para>
+ <variablelist>
+ <variable name="MACRO_RESULT">
+ <para>If set, this action will be taken after the macro finished executing.</para>
+ <value name="ABORT">
+ <para>Hangup both legs of the call</para>
+ </value>
+ <value name="CONGESTION">
+ <para>Behave as if line congestion was encountered</para>
+ </value>
+ <value name="BUSY">
+ <para>Behave as if a busy signal was encountered</para>
+ </value>
+ <value name="CONTINUE">
+ <para>Hangup the called party and allow the calling party to continue dialplan execution at the next priority</para>
+ </value>
+ <!-- TODO: Fix this syntax up, once we've figured out how to specify the GOTO syntax -->
+ <value name="GOTO:<context>^<exten>^<priority>">
+ <para>Transfer the call to the specified destination.</para>
+ </value>
+ </variable>
+ </variablelist>
+ <note>
+ <para>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.</para>
+ </note>
+ </option>
+ <option name="n">
+ <para>This option is a modifier for the call screening/privacy mode. (See the
+ <literal>p</literal> and <literal>P</literal> options.) It specifies
+ that no introductions are to be saved in the <directory>priv-callerintros</directory>
+ directory.</para>
+ </option>
+ <option name="N">
+ <para>This option is a modifier for the call screening/privacy mode. It specifies
+ that if Caller*ID is present, do not screen the call.</para>
+ </option>
+ <option name="o">
+ <para>Specify that the Caller*ID that was present on the <emphasis>calling</emphasis> channel
+ be set as the Caller*ID on the <emphasis>called</emphasis> channel. This was the
+ behavior of Asterisk 1.0 and earlier.</para>
+ </option>
+ <option name="O">
+ <argument name="mode">
+ <para>With <replaceable>mode</replaceable> either not specified or set to <literal>1</literal>,
+ the originator hanging up will cause the phone to ring back immediately.</para>
+ <para>With <replaceable>mode</replaceable> set to <literal>2</literal>, when the operator
+ flashes the trunk, it will ring their phone back.</para>
+ </argument>
+ <para>Enables <emphasis>operator services</emphasis> 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.</para>
+ </option>
+ <option name="p">
+ <para>This option enables screening mode. This is basically Privacy mode
+ without memory.</para>
+ </option>
+ <option name="P">
+ <argument name="x" />
+ <para>Enable privacy mode. Use <replaceable>x</replaceable> 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.</para>
+ </option>
+ <option name="r">
+ <para>Indicate ringing to the calling party, even if the called party isn't actuallying rininging. Pass no audio to the calling
+ party until the called channel has answered.</para>
+ </option>
+ <option name="S">
+ <argument name="x" required="true" />
+ <para>Hang up the call <replaceable>x</replaceable> seconds <emphasis>after</emphasis> the called party has
+ answered the call.</para>
+ </option>
+ <option name="t">
+ <para>Allow the called party to transfer the calling party by sending the
+ DTMF sequence defined in <filename>features.conf</filename>.</para>
+ </option>
+ <option name="T">
+ <para>Allow the calling party to transfer the called party by sending the
+ DTMF sequence defined in <filename>features.conf</filename>.</para>
+ </option>
+ <option name="U" argsep="^">
+ <argument name="x" required="true">
+ <para>Name of the subroutine to execute via Gosub</para>
+ </argument>
+ <argument name="arg" multiple="true" required="false">
+ <para>Arguments for the Gosub routine</para>
+ </argument>
+ <para>Execute via Gosub the routine <replaceable>x</replaceable> for the <emphasis>called</emphasis> channel before connecting
+ to the calling channel. Arguments can be specified to the Gosub
+ using <literal>^</literal> as a delimiter. The Gosub routine can set the variable
+ GOSUB_RESULT to specify the following actions after the Gosub returns.</para>
+ <variablelist>
+ <variable name="GOSUB_RESULT">
+ <value name="ABORT">
+ <para>Hangup both legs of the call.</para>
+ </value>
+ <value name="CONGESTION">
+ <para>Behave as if line congestion was encountered.</para>
+ </value>
+ <value name="BUSY">
+ <para>Behave as if a busy signal was encountered.</para>
+ </value>
+ <value name="CONTINUE">
+ <para>Hangup the called party and allow the calling party
+ to continue dialplan execution at the next priority.</para>
+ </value>
+ <!-- TODO: Fix this syntax up, once we've figured out how to specify the GOTO syntax -->
+ <value name="GOTO:<context>^<exten>^<priority>">
+ <para>Transfer the call to the
+ specified priority. Optionally, an extension, or
+ extension and priority can be specified.</para>
+ </value>
+ </variable>
+ </variablelist>
+ <note>
+ <para>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.</para>
+ </note>
+ </option>
+ <option name="w">
+ <para>Allow the called party to enable recording of the call by sending
+ the DTMF sequence defined for one-touch recording in <filename>features.conf</filename>.</para>
+ </option>
+ <option name="W">
+ <para>Allow the calling party to enable recording of the call by sending
+ the DTMF sequence defined for one-touch recording in <filename>features.conf</filename>.</para>
+ </option>
+ <option name="x">
+ <para>Allow the called party to enable recording of the call by sending
+ the DTMF sequence defined for one-touch automixmonitor in <filename>features.conf</filename></para>
+ </option>
+ <option name="X">
+ <para>Allow the calling party to enable recording of the call by sending
+ the DTMF sequence defined for one-touch automixmonitor in <filename>features.conf</filename></para>
+ </option>
+ </optionlist>
+ </parameter>
+ <parameter name="URL">
+ <para>The optional URL will be sent to the called party if the channel driver supports it.</para>
+ </parameter>
+ </syntax>
<description>
- This application will place calls to one or more specified channels. As soon
+ <para>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
+ be hung up.</para>
+
+ <para>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
+ ends the call.</para>
+
+ <para>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.
+ however, the variable will be unset after use.</para>
+
+ <para>This application sets the following channel variables:</para>
+ <variablelist>
+ <variable name="DIALEDTIME">
+ This is the time from dialing a channel until when it is disconnected.
+ </variable>
+ <variable name="ANSWEREDTIME">
+ This is the amount of time for actual call.
+ </variable>
+ <variable name="DIALSTATUS">
+ This is the status of the call
+ <value name="CHANUNAVAIL" />
+ <value name="CONGESTION" />
+ <value name="NOANSWER" />
+ <value name="BUSY" />
+ <value name="ANSWER" />
+ <value name="CANCEL" />
+ <value name="DONTCALL">
+ For the Privacy and Screening Modes.
+ Will be set if the called party chooses to send the calling partey to the <literal>Go Away</literal> script.
+ </value>
+ <value name="TORTURE">
+ For the Privacy and Screening Modes.
+ Will be set if the called party chooses to send the calling partey to the <literal>torture</literal> script.
+ </value>
+ <value name="INVALIDARGS" />
+ </variable>
+ </variablelist>
</description>
- <variable name="DIALEDTIME">
- This is the time from dialing a channel until when it is disconnected.
- </variable>
- <variable name="ANSWEREDTIME">
- This is the amount of time for actual call.
- </variable>
- <variable name="DIALSTATUS">
- This is the status of the call
- <value name="CHANUNAVAIL" />
- <value name="CONGESTION" />
- <value name="NOANSWER" />
- <value name="BUSY" />
- <value name="ANSWER" />
- <value name="CANCEL" />
- <value name="DONTCALL">
- For the Privacy and Screening Modes.
- Will be set if the called party chooses to send the calling partey to the 'Go Away' script.
- </value>
- <value name="TORTURE">
- For the Privacy and Screening Modes.
- Will be set if the called party chooses to send the calling partey to the 'torture' script.
- </value>
- <value name="INVALIDARGS" />
- </variable>
- <parameter name="Technology/Resource" required="true" argsep="&">
- <argument name="Technology2/Resource2">
- Optional extra 'devices' to dial.
- If you need more then one enter them like this:
- Technology2/Resource2&Technology3/Resourse3&.....
- </argument>
- Device to dial
- </parameter>
- <parameter name="timeout" required="false">
- How many seconds do we want to try to dial the Resource(s).
- If not specified, try 136 years.
- </parameter>
- <parameter name="options">
- <option name="A">
- <argument name="x" required="true">
- The file to play to the called party
- </argument>
- Play an announcement to the called party, using 'x' as the file
- </option>
- <option name="C">
- Reset the CDR for this call.
- </option>
- <option name="c">
- If DIAL cancels this call, always set the flag to tell the channel
- driver that the call is answered elsewhere.
- </option>
- <option name="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.
- </option>
- <option name="D" argsep=":">
- <argument name="called" />
- <argument name="calling" />
- Send the specified DTMF strings *after* the called\n
- 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 parameters can be used
- alone.
- </option>
- <option name="e">
- execute the 'h' extension for peer after the call ends
- </option>
- <option name="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.
- </option>
- <option name="F" argsep="^">
- <argument name="context" />
- <argument name="exten" />
- <argument name="pri" required="true" />
- When the caller hangs up, transfer the called party
- to the specified context and extension and continue execution.
- </option>
- <option name="g">
- Proceed with dialplan execution at the current extension if the
- destination channel hangs up.
- </option>
- <option name="G" argsep="^">
- <argument name="context" />
- <argument name="exten" />
- <argument name="pri" required="true" />
- If the call is answered, transfer the calling party to
- the specified priority and the called party to the specified priority+1.
- Optionally, an extension, or extension and context may be specified.
- Otherwise, the current extension is used. You cannot use any additional
- action post answer options in conjunction with this option.
- </option>
- <option name="h">
- Allow the called party to hang up by sending the '*' DTMF digit.
- </option>
- <option name="H">
- Allow the calling party to hang up by hitting the '*' DTMF digit.
- </option>
- <option name="i">
- Asterisk will ignore any forwarding requests it may receive on this
- dial attempt.
- </option>
- <option name="k">
- Allow the called party to enable parking of the call by sending
- the DTMF sequence defined for call parking in features.conf.
- </option>
- <option name="K">
- Allow the calling party to enable parking of the call by sending
- the DTMF sequence defined for call parking in features.conf.
- </option>
- <option name="L" args="x,y,z" argsep=":">
- <argument name="x" required="true">
- Maximum calltime in miliseconds
- </argument>
- <argument name="y" />
- <argument name="z" />
- Limit the call to 'x' ms. Play a warning when 'y' ms are
- left. Repeat the warning every 'z' ms.
- <variable name="LIMIT_PLAYAUDIO_CALLER">
- <value name="yes" default="true" />
- <value name="no" />
- Play sounds to the caller.
- </variable>
- <variable name="LIMIT_PLAYAUDIO_CALLEE">
- <value name="yes" />
- <value name="no" />
- Play sounds to the callee.
- </variable>
- <variable name="LIMIT_TIMEOUT_FILE">
- <value name="filename">
- If not set, the time remaining will be said.
- </value>
- File to play when time is up.
- </variable>
- <variable name="LIMIT_CONNECT_FILE">
- <value name="filename">
- If not set, the time remaining will be said.
- </value>
- File to play when call begins.
- </variable>
- <variable name="LIMIT_WARNING_FILE">
- <value name="filename">
- If not set, the time remaining will be said.
- </value>
- File to play as warning if 'y' is defined.
- </variable>
- </option>
- <option name="m">
- <argument name="class" />
- Provide hold music to the calling party until a requested
- channel answers. A specific MusicOnHold class can be
- specified.
- </option>
- <option name="M" args="x,arg" argsep="^">
- <argument name="x" required="true">
- Macro name that should be executed.
- </argument>
- <argument name="arg">
- Macro arguments seperated by ^
- </argument>
- Execute the 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.
- <variable name="MACRO_RESULT">
- If set, this action will be taken after the macro finished executing.
- <value name="ABORT">
- Hangup both legs of the call.
- </value>
- <value name="CONGESTION">
- Behave as if line congestion was encountered.
- </value>
- <value name="BUSY">
- Behave as if a busy signal was encountered.
- </value>
- <value name="CONTINUE">
- Hangup the called party and allow the calling party to continue dialplan execution at the next priority.
- </value>
- <value name="GOTO:<context>^<exten>^<priority>">
- Transfer the call to the specified priority. Optionally, an extension, or extension and priority can be specified.
- </value>
- </variable>
- 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.
- </option>
- <option name="n">
- This option is a modifier for the screen/privacy mode. It specifies
- that no introductions are to be saved in the priv-callerintros
- directory.
- </option>
- <option name="N">
- This option is a modifier for the screen/privacy mode. It specifies
- that if callerID is present, do not screen the call.
- </option>
- <option name="o">
- Specify that the CallerID that was present on the *calling* channel
- be set as the CallerID on the *called* channel. This was the
- behavior of Asterisk 1.0 and earlier.
- </option>
- <option name="O">
- <argument name="x" />
- "Operator Services" mode (Zaptel channel to Zaptel channel
- only, if specified on non-Zaptel interface, 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 hangs up (the operator). Specified
- without an arg, or with 1 as an arg, the originator hanging up
- will cause the phone to ring back immediately. With a 2 specified,
- when the "operator" flashes the trunk, it will ring their phone
- back.
- </option>
- <option name="p">
- This option enables screening mode. This is basically Privacy mode
- without memory.
- </option>
- <option name="P">
- <argument name="x" />
- Enable privacy mode. Use 'x' as the family/key in the database if
- it is provided. The current extension is used if a database
- family/key is not specified.
- </option>
- <option name="r">
- Indicate ringing to the calling party. Pass no audio to the calling
- party until the called channel has answered.
- </option>
- <option name="S">
- <argument name="x" required="true" />
- Hang up the call after 'x' seconds *after* the called party has
- answered the call.
- </option>
- <option name="t">
- Allow the called party to transfer the calling party by sending the
- DTMF sequence defined in features.conf.
- </option>
- <option name="T">
- Allow the calling party to transfer the called party by sending the
- DTMF sequence defined in features.conf.
- </option>
- <option name="U" argsep="^">
- <argument name="x" required="true">
- routine to execute via Gosub
- </argument>
- <argument name="arg">
- Arguments for the Gosub routine
- </argument>
- 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.
- <variable name="GOSUB_RESULT">
- <value name="ABORT">
- Hangup both legs of the call.
- </value>
- <value name="CONGESTION">
- Behave as if line congestion was encountered.
- </value>
- <value name="BUSY">
- Behave as if a busy signal was encountered.
- </value>
- <value name="CONTINUE">
- Hangup the called party and allow the calling party
- to continue dialplan execution at the next priority.
- </value>
- <value name="GOTO:<context>^<exten>^<priority>">
- Transfer the call to the
- specified priority. Optionally, an extension, or
- extension and priority can be specified.
- </value>
- </variable>
- 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.
- </option>
- <option name="w">
- Allow the called party to enable recording of the call by sending
- the DTMF sequence defined for one-touch recording in features.conf.
- </option>
- <option name="W">
- Allow the calling party to enable recording of the call by sending
- the DTMF sequence defined for one-touch recording in features.conf.
- </option>
- <option name="x">
- Allow the called party to enable recording of the call by sending
- the DTMF sequence defined for one-touch automixmonitor in features.conf
- </option>
- <option name="X">
- Allow the calling party to enable recording of the call by sending
- the DTMF sequence defined for one-touch automixmonitor in features.conf
- </option>
- </parameter>
- <parameter name="URL">
- The optional URL will be sent to the called party if the channel supports it.
- </parameter>
</application>
<application name="RetryDial" language="en_US">
<synopsis>
@@ -394,14 +418,14 @@
</synopsis>
<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.
+ If no channel can be reached, the <replaceable>announce</replaceable> file will be played.
+ Then, it will wait <replaceable>sleep</replaceable> number of seconds before retrying the call.
+ After <replaceable>retries</replaceable> number of attempts, the calling channel will continue at the next priority in the dialplan.
+ If the <replaceable>retries</replaceable> 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
+ The <replaceable>dialargs</replaceable> are specified in the same format that arguments are provided
to the Dial application.
</description>
<option name="announce" required="true">
Modified: team/group/appdocsxml/doc/xmldocumentation.txt
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/doc/xmldocumentation.txt?view=diff&rev=135064&r1=135063&r2=135064
==============================================================================
--- team/group/appdocsxml/doc/xmldocumentation.txt (original)
+++ team/group/appdocsxml/doc/xmldocumentation.txt Fri Aug 1 09:05:03 2008
@@ -10,14 +10,18 @@
Nodes:
application - required, defines the application name
synopsis - required, small description of the application
+ syntax - required, lists all options
+ parameter - optional, 1 or more nodes describing the application parameters
+ option - optional, 1 or more nodes describing the parameter options
+ argument - optional, 1 or more nodes describing the option arguments
+ variablelist - optional, a list of variables effected by the option
+ variable - optional, 1 or more nodes describing option specific variables
+ value - optional, 1 or more nodes describing the possible values of this variable
description - required, longer description of the application
- variable - optional, 1 or more nodes describing the dialplan variables this application uses
- value - optional, 1 or more nodes describing the possible values of this variable
- parameter - optional, 1 or more nodes describing the application parameters
- option - optional, 1 or more nodes describing the parameter options
- argument - optional, 1 or more nodes describing the option arguments
+ variablelist - optional, a list of variables effected by the application
variable - optional, 1 or more nodes describing option specific variables
value - optional, 1 or more nodes describing the possible values of this variable
+ examples - optional, 1 or more examples
Attributes per node:
application:
@@ -52,9 +56,14 @@
argument: If not specified, it means the option takes no arguments.
* name - required, The name of the option argument
* required - optional, defines wether this argument is required.
- possible values:
- false - This argument is not required. This is the default if the attribute is omitted.
- true - This argument is required.
+ - possible values:
+ false - This argument is not required. This is the default if the attribute is omitted.
+ true - This argument is required.
+ * multiple - optional, specifies whether or not there can be multiple arguments of the same type
+ - possible values:
+ false - This argument is can not be repeated. This is the default if the attribute is omitted.
+ true - This argument can be repeated, using argsep to separate the arguments
+
There's a special parameter node for the Options of an application/function
This node has 1 or more <option name="foo"> children.
@@ -66,27 +75,39 @@
<synopsis>
Small description of MyApp
</synopsis>
+ <syntax>
+ <parameter name="myoption" argsep="^" required="true">
+ <argument name="foo" required="true">
+ <para>argument description</para>
+ </argument>
+ <para>Description of the parameter</para>
+ <para>Another paragraph</para>
+ <para>The parameter is also affected by the following
+ variables:</para>
+ <variablelist>
+ <variable name="MYAPP_VAR_FOO" access="rw">
+ <value name="bar" default="true">
+ <para>description of this value</para>
+ </value>
+ <para>description of this variable</para>
+ </variable>
+ </variablelist>
+ </parameter>
+ </syntax>
<description>
- Long description of MyApp.
- You can tell the user what it does here
+ <para>Long description of MyApp.</para>
+ <para>You can tell the user what it does here</para>
+ <variablelist>
+ <variable name="myvar" access="ro">
+ <value name="myvarvalue" default="true">
+ <para>tell what this value means</para>
+ </value>
+ <para>description of the variable</para>
+ </variable>
+ </variablelist>
</description>
- <variable name="myvar" access="ro">
- <value name="myvarvalue" default="true">
- tell what this value means
- </value>
- description of the variable
- </variable>
- <parameter name="myoption" argsep="^" required="true">
- <argument name="foo" required="true">
- argument description
- </argument>
- <variable name="MYAPP_VAR_FOO" access="rw">
- <value name="bar" default="true">
- description
- </value>
- description
- </variable>
- parameter description
- </parameter>
+ <examples>
+ <para>MyApp(foo^bar)</para>
+ </examples>
</application>
***/
More information about the svn-commits
mailing list