File: Application_Queue.html

package info (click to toggle)
asterisk 1%3A1.8.13.1~dfsg1-3%2Bdeb7u3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 49,336 kB
  • sloc: ansic: 497,975; sh: 11,763; cpp: 5,934; makefile: 3,065; perl: 3,019; yacc: 2,147; xml: 498; sql: 387; tcl: 113; php: 62; python: 42
file content (126 lines) | stat: -rw-r--r-- 7,433 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>Asterisk Project : Application_Queue</title>
	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
    </head>

    <body>
	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
		    <tr>
			    <td valign="top" class="pagebody">
				    <div class="pageheader">
					    <span class="pagetitle">
                            Asterisk Project : Application_Queue
                                                    </span>
				    </div>
				    <div class="pagesubheading">
					    This page last changed on Sep 20, 2011 by <font color="#0050B2">wikibot</font>.
				    </div>

				    <h1><a name="Application_Queue-Queue%28%29"></a>Queue()</h1>

<h3><a name="Application_Queue-Synopsis"></a>Synopsis</h3>
<p>Queue a call for a call queue.</p>

<h3><a name="Application_Queue-Description"></a>Description</h3>
<p>In addition to transferring the call, a call may be parked and then picked up by another user. </p>

<p>This application will return to the dialplan if the queue does not exist, or any of the join options cause the caller to not enter the queue. </p>

<p>This application does not automatically answer and should be preceeded by an application such as Answer(), Progress(), or Ringing(). </p>

<p>This application sets the following channel variable upon completion: </p>
<ul>
	<li><tt>QUEUESTATUS</tt> - The status of the call as a text string.
	<ul>
		<li><tt>TIMEOUT</tt></li>
		<li><tt>FULL</tt></li>
		<li><tt>JOINEMPTY</tt></li>
		<li><tt>LEAVEEMPTY</tt></li>
		<li><tt>JOINUNAVAIL</tt></li>
		<li><tt>LEAVEUNAVAIL</tt></li>
		<li><tt>CONTINUE</tt></li>
	</ul>
	</li>
</ul>


<h3><a name="Application_Queue-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Queue(queuename[,options[,URL[,announceoverride[,timeout[,AGI[,macro[,gosub[,rule[,position]]]]]]]]])</pre>
</div></div>

<h5><a name="Application_Queue-Arguments"></a>Arguments</h5>

<ul>
	<li><tt>queuename</tt></li>
	<li><tt>options</tt>
	<ul>
		<li><tt>C</tt> - Mark all calls as "answered elsewhere" when cancelled.</li>
		<li><tt>c</tt> - Continue in the dialplan if the callee hangs up.</li>
		<li><tt>d</tt> - data-quality (modem) call (minimum delay).</li>
		<li><tt>h</tt> - Allow <b>callee</b> to hang up by pressing <tt>*</tt>.</li>
		<li><tt>H</tt> - Allow <b>caller</b> to hang up by pressing <tt>*</tt>.</li>
		<li><tt>n</tt> - No retries on the timeout; will exit this application and go to the next step.</li>
		<li><tt>i</tt> - Ignore call forward requests from queue members and do nothing when they are requested.</li>
		<li><tt>I</tt> - Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on this dial attempt.</li>
		<li><tt>r</tt> - Ring instead of playing MOH. Periodic Announcements are still made, if applicable.</li>
		<li><tt>R</tt> - Ring instead of playing MOH when a member channel is actually ringing.</li>
		<li><tt>t</tt> - Allow the <b>called</b> user to transfer the calling user.</li>
		<li><tt>T</tt> - Allow the <b>calling</b> user to transfer the call.</li>
		<li><tt>w</tt> - Allow the <b>called</b> user to write the conversation to disk via Monitor.</li>
		<li><tt>W</tt> - Allow the <b>calling</b> user to write the conversation to disk via Monitor.</li>
		<li><tt>k</tt> - Allow the <b>called</b> party to enable parking of the call by sending the DTMF sequence defined for call parking in <tt>features.conf</tt>.</li>
		<li><tt>K</tt> - Allow the <b>calling</b> party to enable parking of the call by sending the DTMF sequence defined for call parking in <tt>features.conf</tt>.</li>
		<li><tt>x</tt> - Allow the <b>called</b> user to write the conversation to disk via MixMonitor.</li>
		<li><tt>X</tt> - Allow the <b>calling</b> user to write the conversation to disk via MixMonitor.</li>
	</ul>
	</li>
	<li><tt>URL</tt> - <em>URL</em> will be sent to the called party if the channel supports it.</li>
	<li><tt>announceoverride</tt></li>
	<li><tt>timeout</tt> - Will cause the queue to fail out after a specified number of seconds, checked between each <tt>queues.conf</tt> <em>timeout</em> and <em>retry</em> cycle.</li>
	<li><tt>AGI</tt> - Will setup an AGI script to be executed on the calling party's channel once they are connected to a queue member.</li>
	<li><tt>macro</tt> - Will run a macro on the calling party's channel once they are connected to a queue member.</li>
	<li><tt>gosub</tt> - Will run a gosub on the calling party's channel once they are connected to a queue member.</li>
	<li><tt>rule</tt> - Will cause the queue's defaultrule to be overridden by the rule specified.</li>
	<li><tt>position</tt> - Attempt to enter the caller into the queue at the numerical position specified. <tt>1</tt> would attempt to enter the caller at the head of the queue, and <tt>3</tt> would attempt to place the caller third in the queue.</li>
</ul>



<h3><a name="Application_Queue-SeeAlso"></a>See Also</h3>

<p><a href="" title="Application_Queue">Application&#95;Queue</a><br/>
<a href="Application_QueueLog.html" title="Application_QueueLog">Application&#95;QueueLog</a><br/>
<a href="Application_AddQueueMember.html" title="Application_AddQueueMember">Application&#95;AddQueueMember</a><br/>
<a href="Application_RemoveQueueMember.html" title="Application_RemoveQueueMember">Application&#95;RemoveQueueMember</a><br/>
<a href="Application_PauseQueueMember.html" title="Application_PauseQueueMember">Application&#95;PauseQueueMember</a><br/>
<a href="Application_UnpauseQueueMember.html" title="Application_UnpauseQueueMember">Application&#95;UnpauseQueueMember</a><br/>
<a href="Function_QUEUE_VARIABLES.html" title="Function_QUEUE_VARIABLES">Function&#95;QUEUE&#95;VARIABLES</a><br/>
<a href="Function_QUEUE_MEMBER.html" title="Function_QUEUE_MEMBER">Function&#95;QUEUE&#95;MEMBER</a><br/>
<a href="Function_QUEUE_MEMBER_COUNT.html" title="Function_QUEUE_MEMBER_COUNT">Function&#95;QUEUE&#95;MEMBER&#95;COUNT</a><br/>
<a href="Function_QUEUE_EXISTS.html" title="Function_QUEUE_EXISTS">Function&#95;QUEUE&#95;EXISTS</a><br/>
<a href="Function_QUEUE_WAITING_COUNT.html" title="Function_QUEUE_WAITING_COUNT">Function&#95;QUEUE&#95;WAITING&#95;COUNT</a><br/>
<a href="Function_QUEUE_MEMBER_LIST.html" title="Function_QUEUE_MEMBER_LIST">Function&#95;QUEUE&#95;MEMBER&#95;LIST</a><br/>
<a href="Function_QUEUE_MEMBER_PENALTY.html" title="Function_QUEUE_MEMBER_PENALTY">Function&#95;QUEUE&#95;MEMBER&#95;PENALTY</a></p>


<h3><a name="Application_Queue-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk version SVN-branch-1.8-r336877.</p>

				    
                    			    </td>
		    </tr>
	    </table>
	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
			<tr>
				<td height="12" background="https://wiki.asterisk.org/wiki/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
			</tr>
		    <tr>
			    <td align="center"><font color="grey">Document generated by Confluence on Oct 04, 2011 12:42</font></td>
		    </tr>
	    </table>
    </body>
</html>