aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authormmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b>2007-12-27 17:18:39 +0000
committermmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b>2007-12-27 17:18:39 +0000
commit1c3afe88760ae8a5fa0187f58f0e21922b771ed9 (patch)
treedb0ed523ce6b6f1fdc75121d80fcf8353dd2f71a /doc
parentecca5a02322bfeb6f464978d1631155cdf4425d4 (diff)
Adding documentation for new manager actions and events in app_queue
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@94903 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
-rw-r--r--doc/manager_1_1.txt43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/manager_1_1.txt b/doc/manager_1_1.txt
index 3a4b2d9b4..5d5324eae 100644
--- a/doc/manager_1_1.txt
+++ b/doc/manager_1_1.txt
@@ -141,6 +141,35 @@ Changes to manager version 1.1:
Asterisk) and module not found.
Also, check if other manager actions behave that way.
+- Action: QueueSummary
+ Modules: app_queue
+ Purpose:
+ To request that the manager send a QueueSummary event (see the NEW EVENTS
+ section for more details).
+ Variables:
+ ActionID: <id> Action ID for this transaction. Will be returned.
+ Queue: <name> Queue for which the summary is desired
+
+- Action: QueuePenalty
+ Modules: app_queue
+ Purpose:
+ To change the penalty of a queue member from AMI
+ Variables:
+ Interface: <tech/name> The interface of the member whose penalty you wish to change
+ Penalty: <number> The new penalty for the member. Must be nonnegative.
+ Queue: <name> If specified, only set the penalty for the member for this queue;
+ Otherwise, set the penalty for the member in all queues to which
+ he belongs.
+
+- Action: QueueRule
+ Modules: app_queue
+ Purpose:
+ To list queue rules defined in queuerules.conf
+ Variables:
+ Rule: <name> The name of the rule whose contents you wish to list. If this variable
+ is not present, all rules in queuerules.conf will be listed.
+
+
* NEW EVENTS
------------
@@ -233,6 +262,20 @@ Changes to manager version 1.1:
ModuleLoadStatus: Done
ModuleSelection: All
ModuleCount: 24
+
+- Event: QueueSummary
+ Modules: app_queue
+ Purpose: To report a summary of queue information. This event is generated by
+ issuing a QueueSummary AMI action.
+ Example:
+ Event: QueueSummary
+ Queue: Sales
+ LoggedIn: 12
+ Available: 5
+ Callers: 10
+ HoldTime: 47
+ If an actionID was specified for the QueueSummary action, it will be appended as the
+ last line of the QueueSummary event.
* TODO