</synopsis>
<syntax>
<parameter name="direction" required="true">
- <para>Must be <literal>TX</literal> or <literal>RX</literal>.</para>
+ <para>Must be <literal>TX</literal> or <literal>RX</literal> to
+ store digits, or <literal>remove</literal> to disable.</para>
</parameter>
</syntax>
<description>
<para><replaceable>max_digits</replaceable>: The maximum number of digits to
store in the variable. Defaults to 0 (no maximum). After reading <literal>
maximum</literal> digits, no more digits will be stored.</para>
- <para>For example:</para>
- <para>StoreDTMF(TX,CDR(digits))</para>
- <para>StoreDTMF(RX,testvar,24)</para>
- <para>StoreDTMF(remove)</para>
+ <example title="Store digits in CDR variable">
+ same => n,StoreDTMF(TX,CDR(digits))
+ </example>
+ <example title="Store up to 24 digits">
+ same => n,StoreDTMF(RX,testvar,24)
+ </example>
+ <example title="Disable digit collection">
+ same => n,StoreDTMF(remove)
+ </example>
</description>
</application>
***/
<description>
<para>Executes mpg123 to play the given location, which typically would be a mp3 filename
or m3u playlist filename or a URL. Please read http://en.wikipedia.org/wiki/M3U
- to see how M3U playlist file format is like, Example usage would be
+ to see what the M3U playlist file format is like.</para>
+ <para>User can exit by pressing any key on the dialpad, or by hanging up.</para>
+ <example title="Play an MP3 playlist">
exten => 1234,1,MP3Player(/var/lib/asterisk/playlist.m3u)
- User can exit by pressing any key on the dialpad, or by hanging up.</para>
+ </example>
<para>This application does not automatically answer and should be preceeded by an
application such as Answer() or Progress().</para>
</description>
<value name="NOTDYNAMIC" />
</variable>
</variablelist>
- <para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
+ <example title="Remove queue member">
+ same => n,RemoveQueueMember(techsupport,SIP/3000)
+ </example>
</description>
<see-also>
<ref type="application">Queue</ref>
<value name="NOTFOUND" />
</variable>
</variablelist>
- <para>Example: PauseQueueMember(,SIP/3000)</para>
+ <example title="Pause queue member">
+ same => n,PauseQueueMember(,SIP/3000)
+ </example>
</description>
<see-also>
<ref type="application">Queue</ref>
<value name="NOTFOUND" />
</variable>
</variablelist>
- <para>Example: UnpauseQueueMember(,SIP/3000)</para>
+ <example title="Unpause queue member">
+ same => n,UnpauseQueueMember(,SIP/3000)
+ </example>
</description>
<see-also>
<ref type="application">Queue</ref>
</syntax>
<description>
<para>Allows you to write your own events into the queue log.</para>
- <para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
+ <example title="Log custom queue event">
+ same => n,QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)
+ </example>
</description>
<see-also>
<ref type="application">Queue</ref>
</application>
<application name="QueueUpdate" language="en_US">
<synopsis>
- Writes to the queue_log file for OutBound calls and updates Realtime Data.
+ Writes to the queue_log file for outbound calls and updates Realtime Data.
Is used at h extension to be able to have all the parameters.
</synopsis>
<syntax>
</syntax>
<description>
<para>Allows you to write Outbound events into the queue log.</para>
- <para>Example: exten => h,1,QueueUpdate(${QUEUE}, ${UNIQUEID}, ${AGENT}, ${DIALSTATUS}, ${ANSWEREDTIME}, ${DIALEDTIME} | ${DIALEDNUMBER})</para>
+ <example title="Write outbound event into queue log">
+ exten => h,1,QueueUpdate(${QUEUE}, ${UNIQUEID}, ${AGENT}, ${DIALSTATUS}, ${ANSWEREDTIME}, ${DIALEDTIME} | ${DIALEDNUMBER})
+ </example>
</description>
</application>
<function name="QUEUE_VARIABLES" language="en_US">
*
* \brief Wait for Silence
* - Waits for up to 'x' milliseconds of silence, 'y' times \n
- * - WaitForSilence(500,2) will wait for 1/2 second of silence, twice \n
- * - WaitForSilence(1000,1) will wait for 1 second of silence, once \n
- * - WaitForSilence(300,3,10) will wait for 300ms of silence, 3 times, and return after 10sec \n
*
* \author David C. Troy <dave@popvox.com>
*
playing a message.</para>
<para>Typically you will want to include two or more calls to WaitForSilence when dealing with an answering
machine; first waiting for the spiel to finish, then waiting for the beep, etc.</para>
- <para>Examples:</para>
- <para>WaitForSilence(500,2) will wait for 1/2 second of silence, twice</para>
- <para>WaitForSilence(1000) will wait for 1 second of silence, once</para>
- <para>WaitForSilence(300,3,10) will wait for 300ms silence, 3 times, and returns after 10 sec, even if silence
- is not detected</para>
+ <example title="Wait for half a second of silence, twice">
+ same => n,WaitForSilence(500,2)
+ </example>
+ <example title="Wait for one second of silence, once">
+ same => n,WaitForSilence(1000)
+ </example>
+ <example title="Wait for 300 ms of silence, 3 times, and returns after 10 seconds, even if no silence detected">
+ same => n,WaitForSilence(300,3,10)
+ </example>
<para>Sets the channel variable <variable>WAITSTATUS</variable> to one of these values:</para>
<variablelist>
<variable name="WAITSTATUS">
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.</para>
- <para>For example you have added these 2 headers:</para>
- <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
- <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
- <para></para>
- <para>// remove all headers</para>
- <para>SIPRemoveHeader();</para>
- <para>// remove all P- headers</para>
- <para>SIPRemoveHeader(P-);</para>
- <para>// remove only the PAI header (note the : at the end)</para>
- <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
- <para></para>
+ <example title="Add 2 headers">
+ same => n,SIPAddHeader(P-Asserted-Identity: sip:foo@bar)
+ same => n,SIPAddHeader(P-Preferred-Identity: sip:bar@foo)
+ </example>
+ <example title="Remove all headers">
+ same => n,SIPRemoveHeader()
+ </example>
+ <example title="Remove all P- headers">
+ same => n,SIPRemoveHeader(P-)
+ </example>
+ <example title="Remove only the PAI header (note the : at the end)">
+ same => n,SIPRemoveHeader(P-Asserted-Identity:)
+ </example>
<para>Always returns <literal>0</literal>.</para>
</description>
</application>
</syntax>
<description>
<para>The HINT function can be used to retrieve the list of devices that are
- mapped to a dialplan hint. For example:</para>
- <para>NoOp(Hint for Extension 1234 is ${HINT(1234)})</para>
+ mapped to a dialplan hint.</para>
+ <example title="Hint for extension 1234">
+ same => n,NoOp(Hint for Extension 1234 is ${HINT(1234)})
+ </example>
</description>
</function>
***/
after a channel hangup is detected, set the <variable>AGIEXITONHANGUP</variable>
variable to <literal>yes</literal>.</para>
</note>
- <example title="AGI invocation examples">
- ; Start the AGI script /tmp/my-cool-script.sh, passing it the contents
- ; of the channel variable FOO
- same => n,AGI(/tmp/my-cool-script.sh,${FOO})
-
- ; Start the AGI script my-cool-script.sh located in the astagidir
- ; directory, specified in asterisk.conf
- same => n,AGI(my-cool-script.sh)
-
- ; Connect to the FastAGI server located at 127.0.0.1 and start the script
- ; awesome-script
- same => n,AGI(agi://127.0.0.1/awesome-script)
-
- ; Start AsyncAGI
- same => n,AGI(agi:async)
+ <example title="Start the AGI script /tmp/my-cool-script.sh, passing it the contents of the channel variable FOO">
+ same => n,AGI(/tmp/my-cool-script.sh,${FOO})
+ </example>
+ <example title="Start the AGI script my-cool-script.sh located in the astagidir directory, specified in asterisk.conf">
+ same => n,AGI(my-cool-script.sh)
+ </example>
+ <example title="Connect to the FastAGI server located at 127.0.0.1 and start the script awesome-script">
+ same => n,AGI(agi://127.0.0.1/awesome-script)
+ </example>
+ <example title="Start AsyncAGI">
+ same => n,AGI(agi:async)
</example>
<para>This application sets the following channel variable upon completion:</para>
<variablelist>
<para>Sends the content of <replaceable>message</replaceable> as text message
from the given <replaceable>account</replaceable> to the buddy identified by
<replaceable>jid</replaceable></para>
- <para>Example: JabberSend(asterisk,bob@domain.com,Hello world) sends "Hello world"
- to <replaceable>bob@domain.com</replaceable> as an XMPP message from the account
+ <para>The example below sends "Hello world" to
+ <replaceable>bob@domain.com</replaceable> as an XMPP message from the account
<replaceable>asterisk</replaceable>, configured in xmpp.conf.</para>
+ <example title="Send 'Hello world' to Bob">
+ same => n,JabberSend(asterisk,bob@domain.com,Hello world)
+ </example>
</description>
<see-also>
<ref type="function" module="res_xmpp">JABBER_STATUS</ref>
<description>
<para>Receives a text message on the given <replaceable>account</replaceable>
from the buddy identified by <replaceable>jid</replaceable> and returns the contents.</para>
- <para>Example: ${JABBER_RECEIVE(asterisk,bob@domain.com)} returns an XMPP message
- sent from <replaceable>bob@domain.com</replaceable> (or nothing in case of a time out), to
+ <para>The example below returns an XMPP message sent from
+ <replaceable>bob@domain.com</replaceable> (or nothing in case of a time out), to
the <replaceable>asterisk</replaceable> XMPP account configured in xmpp.conf.</para>
+ <example title="Receive a message">
+ same => n,Set(msg=${JABBER_RECEIVE(asterisk,bob@domain.com)})
+ </example>
</description>
<see-also>
<ref type="function" module="res_xmpp">JABBER_STATUS</ref>
projects / thirdparty / asterisk.git / commitdiff
