Add manager events for chanspy starting or stopping
[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 * NEW EVENTS
206 ------------
207
208 - Event: Transfer
209         Modules: res_features, chan_sip
210         Purpose:
211                 Inform about call transfer, linking transferer with transfer target
212                 You should be able to trace the call flow with this missing piece
213                 of information. If it works out well, the "Transfer" event should
214                 be followed by a "Bridge" event
215                 The transfermethod: header informs if this is a pbx core transfer
216                 or something done on channel driver level. For SIP, check the example:
217         Example:
218                 
219                 Event: Transfer
220                 Privilege: call,all
221                 TransferMethod: SIP
222                 TransferType: Blind
223                 Channel: SIP/device1-01849800
224                 SIP-Callid: 091386f505842c87016c4d93195ec67d@127.0.0.1
225                 TargetChannel: SIP/device2-01841200
226                 TransferExten: 100
227                 TransferContext: default
228
229 - Event: ChannelUpdate
230         Modules: chan_sip.c, chan_iax2.c
231         Purpose:
232                 Updates channel information with ID of PVT in channel driver, to
233                 be able to link events on channel driver level.
234                 * Integrated in SVN trunk as of May 4th, 2007
235
236         Example:
237
238                 Event: ChannelUpdate
239                 Privilege: system,all
240                 Uniqueid: 1177271625.27
241                 Channel: SIP/olle-01843c00
242                 Channeltype: SIP
243                 SIPcallid: NTQzYWFiOWM4NmE0MWRkZjExMzU2YzQ3OWQwNzg3ZmI.
244                 SIPfullcontact: sip:olle@127.0.0.1:49054
245
246 - Action: CoreSettings
247         Modules: manager.c
248         Purpose: To report core settings, like AMI and Asterisk version,
249                 maxcalls and maxload settings.
250                 * Integrated in SVN trunk as of May 4th, 2007
251         Example:
252                 Response: Success
253                 ActionID: 1681692777
254                 AMIversion: 1.1
255                 AsteriskVersion: SVN-oej-moremanager-r61756M
256                 SystemName: EDVINA-node-a
257                 CoreMaxCalls: 120
258                 CoreMaxLoadAvg: 0.000000
259                 CoreRunUser: edvina
260                 CoreRunGroup: edvina
261
262 - Action: CoreStatus
263         Modules: manager.c
264         Purpose: To report current PBX core status flags, like
265                 number of concurrent calls, startup and reload time.
266                 * Integrated in SVN trunk as of May 4th, 2007
267         Example:
268                 Response: Success
269                 ActionID: 1649760492
270                 CoreStartupTime: 22:35:17
271                 CoreReloadTime: 22:35:17
272                 CoreCurrentCalls: 20
273
274 - Event: NewAccountCode
275         Modules: cdr.c
276         Purpose: To report a change in account code for a live channel
277         Example:
278                 Event: NewAccountCode
279                 Privilege: call,all
280                 Channel: SIP/olle-01844600
281                 Uniqueid: 1177530895.2
282                 AccountCode: Stinas account 1234848484
283                 OldAccountCode: OllesAccount 12345
284
285 - Event: ModuleLoadReport
286         Modules: loader.c
287         Purpose: To report that module loading is complete. Some aggressive
288                 clients connect very quickly to AMI and needs to know when
289                 all manager events embedded in modules are loaded
290                 Also, if this does not happen, something is seriously wrong.
291                 This could happen to chan_sip and other modules using DNS.
292         Example:
293                 Event: ModuleLoad
294                 ModuleLoadStatus: Done
295                 ModuleSelection: All
296                 ModuleCount: 24
297
298 - Event: QueueSummary
299         Modules: app_queue
300         Purpose: To report a summary of queue information. This event is generated by
301                 issuing a QueueSummary AMI action.
302         Example:
303                 Event: QueueSummary
304                 Queue: Sales
305                 LoggedIn: 12
306                 Available: 5
307                 Callers: 10
308                 HoldTime: 47
309         If an actionID was specified for the QueueSummary action, it will be appended as the
310         last line of the QueueSummary event.
311
312 - Event: AgentRingNoAnswer
313         Modules: app_queue
314         Purpose: Reports when a queue member was rung but there was no answer.
315         Example:
316                 Event: AgentRingNoAnswer
317                 Queue: Support
318                 Uniqueid: 1177530895.2
319                 Channel: SIP/1000-53aee458
320                 Member: SIP/1000
321                 MemberName: Thaddeus McClintock
322                 Ringtime: 10
323
324 - Event: RegistryEntry
325         Modules: chan_sip
326         Purpose: Reports the state of the SIP registrations. This event is generated by
327                 issuing a QueueSummary AMI action.
328                 The RegistrationTime header is expressed as epoch.
329         Example:
330                 Event: RegistryEntry
331                 Host: sip.myvoipprovider.com
332                 Port: 5060
333                 Username: guestuser
334                 Refresh: 105
335                 State: Registered
336                 RegistrationTime: 1219161830
337         If an actionID was specified for the SipShowRegistry action, it will be appended as the
338         last line of the RegistrationsComplete event.
339
340 - Event: ChanSpyStart
341         Modules: app_chanspy
342         Purpose: Reports when an active channel starts to be monitored by someone.
343         Example:
344                 Event: ChanSpyStart
345                 SpyerChannel: SIP/4321-13bba124
346                 SpyeeChannel: SIP/1234-56ecc098
347
348 - Event: ChanSpyStop
349         Modules: app_chanspy
350         Purpose: Reports when an active channel stops to be monitored by someone.
351         Example:
352                 Event: ChanSpyStop
353                 SpyeeChannel: SIP/1234-56ecc098
354
355 * TODO
356 ------
357