Merge queue-reset branch to Asterisk
[asterisk/asterisk.git] / doc / manager_1_1.txt
1 Changes to manager version 1.1:
2 -------------------------------
3
4 - Action: IAXregistry
5         Modules: chan_iax2
6         Purpose:
7                 To list all IAX2 peers in the IAX registry with their registration status.
8         Variables:
9           ActionID: <id>                Action ID for this transaction. Will be returned.
10
11 * SYNTAX CLEANUPS
12 -----------------
13
14 - Response: headers are now either
15         "Success"       - Action OK, this message contains response
16         "Error"         - Action failed, reason in Message: header
17         "Follows"       - Action OK, response follows in following Events.
18
19 - Manager version changed to 1.1
20
21 * CHANGED EVENTS AND ACTIONS
22 ----------------------------
23 - The Hold/Unhold events
24         - Both are now "Hold" events
25                 For hold, there's a "Status: On" header, for unhold, status is off
26         - Modules chan_sip/chan_iax2
27
28 - The Ping Action
29         - Now use Response: success
30         - New header "Ping: pong" :-)
31
32 - The Events action
33         - Now use Response: Success
34         - The new status is reported as "Events: On" or "Events: Off"
35
36 - The JabberSend action
37         - The Response: header is now the first header in the response
38         - now sends "Response: Error" instead of "Failure"
39
40 - Newstate and Newchannel events
41         - these have changed headers
42         "State"         -> ChannelStateDesc     Text based channel state
43                         -> ChannelState         Numeric channel state
44         - The events does not send "<unknown>" for unknown caller IDs just an empty field
45
46 - Newchannel event
47         - Now includes "AccountCode"
48
49 - Newstate event
50         - Now has "CalleridNum" for numeric caller id, like Newchannel
51         - The event does not send "<unknown>" for unknown caller IDs just an empty field
52
53 - Newexten and VarSet events
54         - Now are part of the new Dialplan privilege class, instead of the Call class
55
56 - Dial event
57         - Event Dial has new headers, to comply with other events
58         - Source        -> Channel              Channel name (caller)
59         - SrcUniqueID   -> UniqueID             Uniqueid
60         (new)           -> Dialstring           Dialstring in app data
61
62 - Link and Unlink events
63         - The "Link" and "Unlink" bridge events in channel.c are now renamed to "Bridge"
64         - The link state is in the bridgestate: header as "Link" or "Unlink"
65         - For channel.c bridges, "Bridgetype: core" is added. This opens up for
66           bridge events in rtp.c 
67         - The RTP channel also reports Bridge: events with bridgetypes
68                 - rtp-native    RTP native bridge
69                 - rtp-direct    RTP peer-2-peer bridge (NAT support only)
70                 - rtp-remote    Remote (re-invite) bridge. (Not reported yet)
71
72 - The "Rename" manager event has a renamed header, to use the same
73         terminology for the current channel as other events
74         - Oldname       -> Channel              
75
76 - The "NewCallerID" manager event has a renamed header
77         - CallerID      -> CallerIDnum
78         - The event does not send "<unknown>" for unknown caller IDs just an empty field
79         
80 - Reload event
81         - The "Reload" event sent at manager reload now has a new header and is now implemented
82         in more modules than manager to alert a reload. For channels, there's a CHANNELRELOAD 
83         event to use.
84         (new)           -> Module: manager | CDR | DNSmgr | RTP | ENUM
85         (new)           -> Status: enabled | disabled
86         - To support reload events from other modules too
87                 - cdr module added
88
89 - Status action replies (Event: Status)
90         Header changes
91         - link          -> BridgedChannel
92         - Account       -> AccountCode
93         - (new)         -> BridgedUniqueid
94
95 - StatusComplete Event
96         New header
97         - (new)         -> Items                Number of channels reported
98         
99
100 - The ExtensionStatus manager command now has a "StatusDesc" field with text description of the state
101
102 - The Registry and Peerstatus events in chan_sip and chan_iax now use "ChannelType" instead of "ChannelDriver"
103
104 - The Response to Action: IAXpeers now have a Response: Success header
105
106 - The MeetmeJoin now has caller ID name and Caller ID number fields (like MeetMeLeave)
107
108 - Action DAHDIShowChannels
109         Header changes
110         - Channel:      -> DAHDIChannel
111         For active channels, the Channel: and Uniqueid: headers are added
112         You can now add a "DAHDIChannel: " argument to DAHDIshowchannels actions
113         to only get information about one channel.
114
115 - Event DAHDIShowChannelsComplete
116         New header
117         - (new)         -> Items:       Reports number of channels reported
118
119 - Action VoicemailUsersList
120         Added new headers for SayEnvelope, SayCID, AttachMessage, CanReview
121         and CallOperator voicemail configuration settings.
122
123 - Action Originate
124         Now requires the new Originate privilege.
125         If you call out to a subshell in Originate with the Application parameter,
126                 you now also need the System privilege.
127
128 - Event QueueEntry now also returns the Uniqueid field like other events from app_queue.
129
130 * NEW ACTIONS
131 -------------
132 - Action: ModuleLoad
133         Modules: loader.c
134         Purpose:
135                 To be able to unload, reload and unload modules from AMI.
136         Variables: 
137           ActionID: <id>          Action ID for this transaction. Will be returned.
138           Module: <name>          Asterisk module name (including .so extension)
139                                   or subsystem identifier:
140                                 cdr, enum, dnsmgr, extconfig, manager, rtp, http
141           LoadType: load | unload | reload
142                           The operation to be done on module
143         If no module is specified for a reload loadtype, all modules are reloaded
144
145 - Action: ModuleCheck
146         Modules: loader.c
147         Purpose:
148                 To check version of a module - if it's loaded
149         Variables:
150           ActionID: <id>          Action ID for this transaction. Will be returned.
151           Module: <name>          Asterisk module name (not including extension)
152         Returns:
153                 If module is loaded, returns version number of the module
154                 
155                 Note: This will have to change. I don't like sending Response: failure
156                 on both command not found (trying this command in earlier versions of
157                 Asterisk) and module not found.
158                 Also, check if other manager actions behave that way.
159
160 - Action: QueueSummary
161         Modules: app_queue
162         Purpose:
163                 To request that the manager send a QueueSummary event (see the NEW EVENTS
164             section for more details).
165         Variables:
166           ActionID: <id>                Action ID for this transaction. Will be returned.
167           Queue: <name>                 Queue for which the summary is desired
168
169 - Action: QueuePenalty
170         Modules: app_queue
171         Purpose:
172                 To change the penalty of a queue member from AMI
173         Variables:
174           Interface: <tech/name>        The interface of the member whose penalty you wish to change
175           Penalty:  <number>            The new penalty for the member. Must be nonnegative.
176           Queue:  <name>                        If specified, only set the penalty for the member for this queue;
177                                                                         Otherwise, set the penalty for the member in all queues to which
178                                                                         he belongs.
179
180 - Action: QueueRule
181         Modules: app_queue
182         Purpose:
183                 To list queue rules defined in queuerules.conf
184         Variables:
185           Rule: <name>                  The name of the rule whose contents you wish to list. If this variable
186                                                                 is not present, all rules in queuerules.conf will be listed.
187                 
188 - Action: Atxfer
189         Modules: none
190         Purpose:
191                 Initiate an attended transfer
192         Variables:
193                 Channel: The transferer channel's name
194                 Exten: The extension to transfer to
195                 Priority: The priority to transfer to
196                 Context: The context to transfer to
197
198 - Action: SipShowRegistry
199         Modules: chan_sip
200         Purpose:
201                 To request that the manager send a list of RegistryEntry events.
202         Variables:
203           ActionId: <id>                Action ID for this transaction. Will be returned.
204
205 - Action: QueueReload
206         Modules: app_queue
207         Purpose:
208                 To reload queue rules, a queue's members, a queue's parameters, or all of the aforementioned
209         Variable:
210                 Queuename: <name> The name of the queue to take action on. If no queue name is specified, then all queues are affected
211                 Rules: <yes or no> Whether to reload queue_rules.conf
212                 Members: <yes or no> Whether to reload the queue's members
213                 Parameters: <yes or no> Whether to reload the other queue options
214
215 - Action: QueueReset
216         Modules: app_queue
217         Purpose:
218                 Reset the statistics for a queue
219         Variables:
220                 Queuename: <name> The name of the queue on which to reset statistics
221
222 * NEW EVENTS
223 ------------
224
225 - Event: Transfer
226         Modules: res_features, chan_sip
227         Purpose:
228                 Inform about call transfer, linking transferer with transfer target
229                 You should be able to trace the call flow with this missing piece
230                 of information. If it works out well, the "Transfer" event should
231                 be followed by a "Bridge" event
232                 The transfermethod: header informs if this is a pbx core transfer
233                 or something done on channel driver level. For SIP, check the example:
234         Example:
235                 
236                 Event: Transfer
237                 Privilege: call,all
238                 TransferMethod: SIP
239                 TransferType: Blind
240                 Channel: SIP/device1-01849800
241                 SIP-Callid: 091386f505842c87016c4d93195ec67d@127.0.0.1
242                 TargetChannel: SIP/device2-01841200
243                 TransferExten: 100
244                 TransferContext: default
245
246 - Event: ChannelUpdate
247         Modules: chan_sip.c, chan_iax2.c
248         Purpose:
249                 Updates channel information with ID of PVT in channel driver, to
250                 be able to link events on channel driver level.
251                 * Integrated in SVN trunk as of May 4th, 2007
252
253         Example:
254
255                 Event: ChannelUpdate
256                 Privilege: system,all
257                 Uniqueid: 1177271625.27
258                 Channel: SIP/olle-01843c00
259                 Channeltype: SIP
260                 SIPcallid: NTQzYWFiOWM4NmE0MWRkZjExMzU2YzQ3OWQwNzg3ZmI.
261                 SIPfullcontact: sip:olle@127.0.0.1:49054
262
263 - Action: CoreSettings
264         Modules: manager.c
265         Purpose: To report core settings, like AMI and Asterisk version,
266                 maxcalls and maxload settings.
267                 * Integrated in SVN trunk as of May 4th, 2007
268         Example:
269                 Response: Success
270                 ActionID: 1681692777
271                 AMIversion: 1.1
272                 AsteriskVersion: SVN-oej-moremanager-r61756M
273                 SystemName: EDVINA-node-a
274                 CoreMaxCalls: 120
275                 CoreMaxLoadAvg: 0.000000
276                 CoreRunUser: edvina
277                 CoreRunGroup: edvina
278
279 - Action: CoreStatus
280         Modules: manager.c
281         Purpose: To report current PBX core status flags, like
282                 number of concurrent calls, startup and reload time.
283                 * Integrated in SVN trunk as of May 4th, 2007
284         Example:
285                 Response: Success
286                 ActionID: 1649760492
287                 CoreStartupTime: 22:35:17
288                 CoreReloadTime: 22:35:17
289                 CoreCurrentCalls: 20
290
291 - Event: NewAccountCode
292         Modules: cdr.c
293         Purpose: To report a change in account code for a live channel
294         Example:
295                 Event: NewAccountCode
296                 Privilege: call,all
297                 Channel: SIP/olle-01844600
298                 Uniqueid: 1177530895.2
299                 AccountCode: Stinas account 1234848484
300                 OldAccountCode: OllesAccount 12345
301
302 - Event: ModuleLoadReport
303         Modules: loader.c
304         Purpose: To report that module loading is complete. Some aggressive
305                 clients connect very quickly to AMI and needs to know when
306                 all manager events embedded in modules are loaded
307                 Also, if this does not happen, something is seriously wrong.
308                 This could happen to chan_sip and other modules using DNS.
309         Example:
310                 Event: ModuleLoad
311                 ModuleLoadStatus: Done
312                 ModuleSelection: All
313                 ModuleCount: 24
314
315 - Event: QueueSummary
316         Modules: app_queue
317         Purpose: To report a summary of queue information. This event is generated by
318                 issuing a QueueSummary AMI action.
319         Example:
320                 Event: QueueSummary
321                 Queue: Sales
322                 LoggedIn: 12
323                 Available: 5
324                 Callers: 10
325                 HoldTime: 47
326         If an actionID was specified for the QueueSummary action, it will be appended as the
327         last line of the QueueSummary event.
328
329 - Event: AgentRingNoAnswer
330         Modules: app_queue
331         Purpose: Reports when a queue member was rung but there was no answer.
332         Example:
333                 Event: AgentRingNoAnswer
334                 Queue: Support
335                 Uniqueid: 1177530895.2
336                 Channel: SIP/1000-53aee458
337                 Member: SIP/1000
338                 MemberName: Thaddeus McClintock
339                 Ringtime: 10
340
341 - Event: RegistryEntry
342         Modules: chan_sip
343         Purpose: Reports the state of the SIP registrations. This event is generated by
344                 issuing a QueueSummary AMI action.
345                 The RegistrationTime header is expressed as epoch.
346         Example:
347                 Event: RegistryEntry
348                 Host: sip.myvoipprovider.com
349                 Port: 5060
350                 Username: guestuser
351                 Refresh: 105
352                 State: Registered
353                 RegistrationTime: 1219161830
354         If an actionID was specified for the SipShowRegistry action, it will be appended as the
355         last line of the RegistrationsComplete event.
356
357 - Event: ChanSpyStart
358         Modules: app_chanspy
359         Purpose: Reports when an active channel starts to be monitored by someone.
360         Example:
361                 Event: ChanSpyStart
362                 SpyerChannel: SIP/4321-13bba124
363                 SpyeeChannel: SIP/1234-56ecc098
364
365 - Event: ChanSpyStop
366         Modules: app_chanspy
367         Purpose: Reports when an active channel stops to be monitored by someone.
368         Example:
369                 Event: ChanSpyStop
370                 SpyeeChannel: SIP/1234-56ecc098
371
372 * TODO
373 ------
374