Add a couple of manager commands to chan_skinny
[asterisk/asterisk.git] / doc / manager_1_1.txt
index 5d5324e..76e5cd1 100644 (file)
@@ -1,6 +1,12 @@
 Changes to manager version 1.1:
 -------------------------------
 
+- Action: IAXregistry
+       Modules: chan_iax2
+       Purpose:
+               To list all IAX2 peers in the IAX registry with their registration status.
+       Variables:
+         ActionID: <id>                Action ID for this transaction. Will be returned.
 
 * SYNTAX CLEANUPS
 -----------------
@@ -44,6 +50,9 @@ Changes to manager version 1.1:
        - Now has "CalleridNum" for numeric caller id, like Newchannel
        - The event does not send "<unknown>" for unknown caller IDs just an empty field
 
+- Newexten and VarSet events
+       - Now are part of the new Dialplan privilege class, instead of the Call class
+
 - Dial event
        - Event Dial has new headers, to comply with other events
        - Source        -> Channel              Channel name (caller)
@@ -96,14 +105,14 @@ Changes to manager version 1.1:
 
 - The MeetmeJoin now has caller ID name and Caller ID number fields (like MeetMeLeave)
 
-- Action ZapShowChannels
+- Action DAHDIShowChannels
        Header changes
-       - Channel:      -> ZapChannel
+       - Channel:      -> DAHDIChannel
        For active channels, the Channel: and Uniqueid: headers are added
-       You can now add a "ZapChannel: " argument to zapshowchannels actions
+       You can now add a "DAHDIChannel: " argument to DAHDIshowchannels actions
        to only get information about one channel.
 
-- Event ZapShowChannelsComplete
+- Event DAHDIShowChannelsComplete
        New header
        - (new)         -> Items:       Reports number of channels reported
 
@@ -111,6 +120,13 @@ Changes to manager version 1.1:
        Added new headers for SayEnvelope, SayCID, AttachMessage, CanReview
         and CallOperator voicemail configuration settings.
 
+- Action Originate
+       Now requires the new Originate privilege.
+       If you call out to a subshell in Originate with the Application parameter,
+               you now also need the System privilege.
+
+- Event QueueEntry now also returns the Uniqueid field like other events from app_queue.
+
 * NEW ACTIONS
 -------------
 - Action: ModuleLoad
@@ -169,7 +185,68 @@ Changes to manager version 1.1:
          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.
                
+- Action: Atxfer
+       Modules: none
+       Purpose:
+               Initiate an attended transfer
+       Variables:
+               Channel: The transferer channel's name
+               Exten: The extension to transfer to
+               Priority: The priority to transfer to
+               Context: The context to transfer to
+
+- Action: SipShowRegistry
+       Modules: chan_sip
+       Purpose:
+               To request that the manager send a list of RegistryEntry events.
+       Variables:
+         ActionId: <id>                Action ID for this transaction. Will be returned.
+
+- Action: QueueReload
+       Modules: app_queue
+       Purpose:
+               To reload queue rules, a queue's members, a queue's parameters, or all of the aforementioned
+       Variable:
+               Queuename: <name> The name of the queue to take action on. If no queue name is specified, then all queues are affected
+               Rules: <yes or no> Whether to reload queue_rules.conf
+               Members: <yes or no> Whether to reload the queue's members
+               Parameters: <yes or no> Whether to reload the other queue options
+
+- Action: QueueReset
+       Modules: app_queue
+       Purpose:
+               Reset the statistics for a queue
+       Variables:
+               Queuename: <name> The name of the queue on which to reset statistics
+
+- Action: SKINNYdevices
+       Modules: chan_skinny
+       Purpose:
+               To list all SKINNY devices configured.
+       Variables:
+               ActionId: <id> Action ID for this transaction. Will be returned.
+
+- Action: SKINNYlines
+       Modules: chan_skinny
+       Purpose:
+               To list all SKINNY lines configured.
+       Variables:
+               ActionId: <id> Action ID for this transaction. Will be returned.
+
+- Action SKINNYshowdevice
+       Modules: chan_skinny
+       Purpose:
+               To list the information about a specific SKINNY device.
+       Variables:
+               Device: <device> Device to show information about.
 
+- Action SKINNYshowline
+       Modules: chan_skinny
+       Purpose:
+               To list the information about a specific SKINNY line.
+       Variables:
+               Line: <line> Line to show information about.
+               
 * NEW EVENTS
 ------------
 
@@ -276,7 +353,49 @@ Changes to manager version 1.1:
                HoldTime: 47
        If an actionID was specified for the QueueSummary action, it will be appended as the
        last line of the QueueSummary event.
-               
+
+- Event: AgentRingNoAnswer
+       Modules: app_queue
+       Purpose: Reports when a queue member was rung but there was no answer.
+       Example:
+               Event: AgentRingNoAnswer
+               Queue: Support
+               Uniqueid: 1177530895.2
+               Channel: SIP/1000-53aee458
+               Member: SIP/1000
+               MemberName: Thaddeus McClintock
+               Ringtime: 10
+
+- Event: RegistryEntry
+       Modules: chan_sip
+       Purpose: Reports the state of the SIP registrations. This event is generated by
+                issuing a QueueSummary AMI action.
+               The RegistrationTime header is expressed as epoch.
+       Example:
+               Event: RegistryEntry
+               Host: sip.myvoipprovider.com
+               Port: 5060
+               Username: guestuser
+               Refresh: 105
+               State: Registered
+               RegistrationTime: 1219161830
+       If an actionID was specified for the SipShowRegistry action, it will be appended as the
+       last line of the RegistrationsComplete event.
+
+- Event: ChanSpyStart
+       Modules: app_chanspy
+       Purpose: Reports when an active channel starts to be monitored by someone.
+       Example:
+               Event: ChanSpyStart
+               SpyerChannel: SIP/4321-13bba124
+               SpyeeChannel: SIP/1234-56ecc098
+
+- Event: ChanSpyStop
+       Modules: app_chanspy
+       Purpose: Reports when an active channel stops to be monitored by someone.
+       Example:
+               Event: ChanSpyStop
+               SpyeeChannel: SIP/1234-56ecc098
 
 * TODO
 ------