All pastes #1036068 Raw Edit

Someone

public text v1 · immutable
#1036068 ·published 2008-06-01 18:20 UTC
rendered paste body
Index: apps/app_dial.c
===================================================================
--- apps/app_dial.c	(revision 119473)
+++ apps/app_dial.c	(working copy)
@@ -66,6 +66,191 @@
 
 static char *synopsis = "Place a call and connect to the current channel";
 
+/*** APP
+	<application name="Dial">
+		<synopsis>
+			Dial(Technology/resourse[&Tech2/resource2...][,timout][,options][,URL])
+		</synopsis>
+		<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.
+		</description>
+		<option name="A" args="x">
+			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 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" args="called,calling" argsep=":">
+			Send the specified DTMF strings *after* the called\n
+			party has answered, but before the call gets bridged. The 'called'\n
+			DTMF string is sent to the called party, and the 'calling' DTMF\n
+			string is sent to the calling party. Both parameters can be used\n
+			alone.\n
+		</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" args="context,exten,pri" argsep="^">
+			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" args="context,exten,pri" argsep="^">
+			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=":">
+			Limit the call to 'x' ms. Play a warning when 'y' ms are
+			left. Repeat the warning every 'z' ms.
+			<optionvar name="LIMIT_PLAYAUDIO_CALLER" values="yes,no" default="yes">
+				Play sounds to the caller.
+			</optionvar>
+			<optionvar name="LIMIT_PLAYAUDIO_CALLEE" values="yes,no">
+				Play sounds to the callee.
+			</optionvar>
+			<optionvar name="LIMIT_TIMEOUT_FILE" values="filename" default="The default is to say the time remaining.">
+				File to play when time is up.
+			</optionvar>
+			<optionvar name="LIMIT_CONNECT_FILE" values="filename" default="The default is to say the time remaining.">
+				File to play when call begins.
+			</optionvar>
+			<optionvar name="LIMIT_WARNING_FILE" values="filename" default="The default is to say the time remaining.">
+				File to play as warning if 'y' is defined.
+			<optionvar>
+		</option>
+		<option name="m" args="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="^">
+			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.
+* ABORT        Hangup both legs of the call.\n"
+* CONGESTION   Behave as if line congestion was encountered.\n"
+* BUSY         Behave as if a busy signal was encountered.\n"
+* CONTINUE     Hangup the called party and allow the calling party\n"
+to continue dialplan execution at the next priority.\n"
+* GOTO:<context>^<exten>^<priority> - Transfer the call to the\n"
+specified priority. Optionally, an extension, or\n"
+extension and priority can be specified.\n"
+You cannot use any additional action post answer options in conjunction\n"
+with this option. Also, pbx services are not run on the peer (called) channel,\n"
+so you will not be able to set timeouts via the TIMEOUT() function in this macro.\n"
+n    - This option is a modifier for the screen/privacy mode. It specifies\n"
+that no introductions are to be saved in the priv-callerintros\n"
+directory.\n"
+N    - This option is a modifier for the screen/privacy mode. It specifies\n"
+that if callerID is present, do not screen the call.\n"
+o    - Specify that the CallerID that was present on the *calling* channel\n"
+be set as the CallerID on the *called* channel. This was the\n"
+behavior of Asterisk 1.0 and earlier.\n"
+O([x]) - \"Operator Services\" mode (Zaptel channel to Zaptel channel\n"
+only, if specified on non-Zaptel interface, it will be ignored).\n"
+When the destination answers (presumably an operator services\n"
+station), the originator no longer has control of their line.\n"
+They may hang up, but the switch will not release their line\n"
+until the destination party hangs up (the operator). Specified\n"
+without an arg, or with 1 as an arg, the originator hanging up\n"
+will cause the phone to ring back immediately. With a 2 specified,\n"
+when the \"operator\" flashes the trunk, it will ring their phone\n"
+back.\n"
+p    - This option enables screening mode. This is basically Privacy mode\n"
+without memory.\n"
+P([x]) - Enable privacy mode. Use 'x' as the family/key in the database if\n"
+it is provided. The current extension is used if a database\n"
+family/key is not specified.\n"
+r    - Indicate ringing to the calling party. Pass no audio to the calling\n"
+party until the called channel has answered.\n"
+S(x) - Hang up the call after 'x' seconds *after* the called party has\n"
+answered the call.\n"
+t    - Allow the called party to transfer the calling party by sending the\n"
+DTMF sequence defined in features.conf.\n"
+T    - Allow the calling party to transfer the called party by sending the\n"
+DTMF sequence defined in features.conf.\n"
+U(x[^arg]) - Execute via Gosub the routine 'x' for the *called* channel before connecting\n"
+to the calling channel. Arguments can be specified to the Gosub\n"
+using '^' as a delimiter. The Gosub routine can set the variable\n"
+GOSUB_RESULT to specify the following actions after the Gosub returns.\n"
+* ABORT        Hangup both legs of the call.\n"
+* CONGESTION   Behave as if line congestion was encountered.\n"
+* BUSY         Behave as if a busy signal was encountered.\n"
+* CONTINUE     Hangup the called party and allow the calling party\n"
+to continue dialplan execution at the next priority.\n"
+* GOTO:<context>^<exten>^<priority> - Transfer the call to the\n"
+specified priority. Optionally, an extension, or\n"
+extension and priority can be specified.\n"
+You cannot use any additional action post answer options in conjunction\n"
+with this option. Also, pbx services are not run on the peer (called) channel,\n"
+so you will not be able to set timeouts via the TIMEOUT() function in this routine.\n"
+w    - Allow the called party to enable recording of the call by sending\n"
+the DTMF sequence defined for one-touch recording in features.conf.\n"
+W    - Allow the calling party to enable recording of the call by sending\n"
+the DTMF sequence defined for one-touch recording in features.conf.\n"
+x    - Allow the called party to enable recording of the call by sending\n"
+the DTMF sequence defined for one-touch automixmonitor in features.conf\n"
+X    - Allow the calling party to enable recording of the call by sending\n"
+the DTMF sequence defined for one-touch automixmonitor in features.conf\n"
+
+
+
+
+	</application>
+ ***/
+
 static char *descrip =
 "  Dial(Technology/resource[&Tech2/resource2...][,timeout][,options][,URL]):\n"
 "This application will place calls to one or more specified channels. As soon\n"