Document that SIPshowpeer and SKINNYshowline now include
[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 - Action IAXpeerlist
131         Now includes if the IAX link is a trunk or not
132
133 - Action IAXpeers
134         Now includes if the IAX link is a trunk or not
135
136 - Action Ping
137         Response now includes a timestamp
138
139 - Action SIPshowpeer
140         Response now includes the configured parkinglot
141
142 - Action SKINNYshowline
143         Response now includes the configured parkinglot
144
145 * NEW ACTIONS
146 -------------
147 - Action: ModuleLoad
148         Modules: loader.c
149         Purpose:
150                 To be able to unload, reload and unload modules from AMI.
151         Variables: 
152           ActionID: <id>          Action ID for this transaction. Will be returned.
153           Module: <name>          Asterisk module name (including .so extension)
154                                   or subsystem identifier:
155                                 cdr, enum, dnsmgr, extconfig, manager, rtp, http
156           LoadType: load | unload | reload
157                           The operation to be done on module
158         If no module is specified for a reload loadtype, all modules are reloaded
159
160 - Action: ModuleCheck
161         Modules: loader.c
162         Purpose:
163                 To check version of a module - if it's loaded
164         Variables:
165           ActionID: <id>          Action ID for this transaction. Will be returned.
166           Module: <name>          Asterisk module name (not including extension)
167         Returns:
168                 If module is loaded, returns version number of the module
169                 
170                 Note: This will have to change. I don't like sending Response: failure
171                 on both command not found (trying this command in earlier versions of
172                 Asterisk) and module not found.
173                 Also, check if other manager actions behave that way.
174
175 - Action: QueueSummary
176         Modules: app_queue
177         Purpose:
178                 To request that the manager send a QueueSummary event (see the NEW EVENTS
179             section for more details).
180         Variables:
181           ActionID: <id>                Action ID for this transaction. Will be returned.
182           Queue: <name>                 Queue for which the summary is desired
183
184 - Action: QueuePenalty
185         Modules: app_queue
186         Purpose:
187                 To change the penalty of a queue member from AMI
188         Variables:
189           Interface: <tech/name>        The interface of the member whose penalty you wish to change
190           Penalty:  <number>            The new penalty for the member. Must be nonnegative.
191           Queue:  <name>                        If specified, only set the penalty for the member for this queue;
192                                                                         Otherwise, set the penalty for the member in all queues to which
193                                                                         he belongs.
194
195 - Action: QueueRule
196         Modules: app_queue
197         Purpose:
198                 To list queue rules defined in queuerules.conf
199         Variables:
200           Rule: <name>                  The name of the rule whose contents you wish to list. If this variable
201                                                                 is not present, all rules in queuerules.conf will be listed.
202                 
203 - Action: Atxfer
204         Modules: none
205         Purpose:
206                 Initiate an attended transfer
207         Variables:
208                 Channel: The transferer channel's name
209                 Exten: The extension to transfer to
210                 Priority: The priority to transfer to
211                 Context: The context to transfer to
212
213 - Action: SipShowRegistry
214         Modules: chan_sip
215         Purpose:
216                 To request that the manager send a list of RegistryEntry events.
217         Variables:
218           ActionId: <id>                Action ID for this transaction. Will be returned.
219
220 - Action: QueueReload
221         Modules: app_queue
222         Purpose:
223                 To reload queue rules, a queue's members, a queue's parameters, or all of the aforementioned
224         Variable:
225                 Queuename: <name> The name of the queue to take action on. If no queue name is specified, then all queues are affected
226                 Rules: <yes or no> Whether to reload queue_rules.conf
227                 Members: <yes or no> Whether to reload the queue's members
228                 Parameters: <yes or no> Whether to reload the other queue options
229
230 - Action: QueueReset
231         Modules: app_queue
232         Purpose:
233                 Reset the statistics for a queue
234         Variables:
235                 Queuename: <name> The name of the queue on which to reset statistics
236
237 - Action: SKINNYdevices
238         Modules: chan_skinny
239         Purpose:
240                 To list all SKINNY devices configured.
241         Variables:
242                 ActionId: <id> Action ID for this transaction. Will be returned.
243
244 - Action: SKINNYlines
245         Modules: chan_skinny
246         Purpose:
247                 To list all SKINNY lines configured.
248         Variables:
249                 ActionId: <id> Action ID for this transaction. Will be returned.
250
251 - Action SKINNYshowdevice
252         Modules: chan_skinny
253         Purpose:
254                 To list the information about a specific SKINNY device.
255         Variables:
256                 Device: <device> Device to show information about.
257
258 - Action SKINNYshowline
259         Modules: chan_skinny
260         Purpose:
261                 To list the information about a specific SKINNY line.
262         Variables:
263                 Line: <line> Line to show information about.
264
265 - Action: CoreSettings
266         Modules: manager.c
267         Purpose: To report core settings, like AMI and Asterisk version,
268                 maxcalls and maxload settings.
269                 * Integrated in SVN trunk as of May 4th, 2007
270         Example:
271                 Response: Success
272                 ActionID: 1681692777
273                 AMIversion: 1.1
274                 AsteriskVersion: SVN-oej-moremanager-r61756M
275                 SystemName: EDVINA-node-a
276                 CoreMaxCalls: 120
277                 CoreMaxLoadAvg: 0.000000
278                 CoreRunUser: edvina
279                 CoreRunGroup: edvina
280
281 - Action: CoreStatus
282         Modules: manager.c
283         Purpose: To report current PBX core status flags, like
284                 number of concurrent calls, startup and reload time.
285                 * Integrated in SVN trunk as of May 4th, 2007
286         Example:
287                 Response: Success
288                 ActionID: 1649760492
289                 CoreStartupTime: 22:35:17
290                 CoreReloadTime: 22:35:17
291                 CoreCurrentCalls: 20
292
293                 
294 * NEW EVENTS
295 ------------
296
297 - Event: Transfer
298         Modules: res_features, chan_sip
299         Purpose:
300                 Inform about call transfer, linking transferer with transfer target
301                 You should be able to trace the call flow with this missing piece
302                 of information. If it works out well, the "Transfer" event should
303                 be followed by a "Bridge" event
304                 The transfermethod: header informs if this is a pbx core transfer
305                 or something done on channel driver level. For SIP, check the example:
306         Example:
307                 
308                 Event: Transfer
309                 Privilege: call,all
310                 TransferMethod: SIP
311                 TransferType: Blind
312                 Channel: SIP/device1-01849800
313                 SIP-Callid: 091386f505842c87016c4d93195ec67d@127.0.0.1
314                 TargetChannel: SIP/device2-01841200
315                 TransferExten: 100
316                 TransferContext: default
317
318 - Event: ChannelUpdate
319         Modules: chan_sip.c, chan_iax2.c
320         Purpose:
321                 Updates channel information with ID of PVT in channel driver, to
322                 be able to link events on channel driver level.
323                 * Integrated in SVN trunk as of May 4th, 2007
324
325         Example:
326
327                 Event: ChannelUpdate
328                 Privilege: system,all
329                 Uniqueid: 1177271625.27
330                 Channel: SIP/olle-01843c00
331                 Channeltype: SIP
332                 SIPcallid: NTQzYWFiOWM4NmE0MWRkZjExMzU2YzQ3OWQwNzg3ZmI.
333                 SIPfullcontact: sip:olle@127.0.0.1:49054
334
335 - Event: NewAccountCode
336         Modules: cdr.c
337         Purpose: To report a change in account code for a live channel
338         Example:
339                 Event: NewAccountCode
340                 Privilege: call,all
341                 Channel: SIP/olle-01844600
342                 Uniqueid: 1177530895.2
343                 AccountCode: Stinas account 1234848484
344                 OldAccountCode: OllesAccount 12345
345
346 - Event: ModuleLoadReport
347         Modules: loader.c
348         Purpose: To report that module loading is complete. Some aggressive
349                 clients connect very quickly to AMI and needs to know when
350                 all manager events embedded in modules are loaded
351                 Also, if this does not happen, something is seriously wrong.
352                 This could happen to chan_sip and other modules using DNS.
353         Example:
354                 Event: ModuleLoad
355                 ModuleLoadStatus: Done
356                 ModuleSelection: All
357                 ModuleCount: 24
358
359 - Event: QueueSummary
360         Modules: app_queue
361         Purpose: To report a summary of queue information. This event is generated by
362                 issuing a QueueSummary AMI action.
363         Example:
364                 Event: QueueSummary
365                 Queue: Sales
366                 LoggedIn: 12
367                 Available: 5
368                 Callers: 10
369                 HoldTime: 47
370         If an actionID was specified for the QueueSummary action, it will be appended as the
371         last line of the QueueSummary event.
372
373 - Event: AgentRingNoAnswer
374         Modules: app_queue
375         Purpose: Reports when a queue member was rung but there was no answer.
376         Example:
377                 Event: AgentRingNoAnswer
378                 Queue: Support
379                 Uniqueid: 1177530895.2
380                 Channel: SIP/1000-53aee458
381                 Member: SIP/1000
382                 MemberName: Thaddeus McClintock
383                 Ringtime: 10
384
385 - Event: RegistryEntry
386         Modules: chan_sip
387         Purpose: Reports the state of the SIP registrations. This event is generated by
388                 issuing a QueueSummary AMI action.
389                 The RegistrationTime header is expressed as epoch.
390         Example:
391                 Event: RegistryEntry
392                 Host: sip.myvoipprovider.com
393                 Port: 5060
394                 Username: guestuser
395                 Refresh: 105
396                 State: Registered
397                 RegistrationTime: 1219161830
398         If an actionID was specified for the SipShowRegistry action, it will be appended as the
399         last line of the RegistrationsComplete event.
400
401 - Event: ChanSpyStart
402         Modules: app_chanspy
403         Purpose: Reports when an active channel starts to be monitored by someone.
404         Example:
405                 Event: ChanSpyStart
406                 SpyerChannel: SIP/4321-13bba124
407                 SpyeeChannel: SIP/1234-56ecc098
408
409 - Event: ChanSpyStop
410         Modules: app_chanspy
411         Purpose: Reports when an active channel stops to be monitored by someone.
412         Example:
413                 Event: ChanSpyStop
414                 SpyeeChannel: SIP/1234-56ecc098
415
416 * TODO
417 ------
418