Merge anthm's monitor fixes (better default path, set variable for monitor) (bug...
[asterisk/asterisk.git] / doc / manager.txt
1 The Asterisk Manager TCP/IP API
2 ===============================
3
4 The manager is a client/server model over TCP. With the manager interface,
5 you'll be able to control the PBX, originate calls, check mailbox status,
6 monitor channels and queues as well as execute Asterisk commands.
7
8 Management users are configured in the configuration file manager.conf and are 
9 given permissions for read and write, where write represents their ability 
10 to perform this class of "action", and read represents their ability to 
11 receive this class of "event".
12
13 Command Syntax
14 --------------
15 Management communication consists of tags of the form "header: value", 
16 terminated with an empty newline (\r\n) in the style of SMTP, HTTP, and
17 other headers.
18
19
20 The first tag MUST be one of the following:
21
22     * Action: An action requested by the CLIENT to the Asterisk SERVER. Only one "Action" may be outstanding at any time.
23     * Response: A response to an action from the Asterisk SERVER to the CLIENT.
24     * Event: An event reported by the Asterisk SERVER to the CLIENT 
25
26
27 Manager commands
28 ----------------
29 Output from the CLI command 'show manager' command:
30
31     * Ping: Ping
32     * Logoff: Logoff Manager
33     * Hangup: Hangup Channel
34     * Status: Status
35     * Redirect: Redirect
36     * Originate: Originate Call
37     * MailboxStatus: Check Mailbox
38     * Command: Execute Command
39     * ExtensionState: Check Extension Status
40     * AbsoluteTimeout: Set Absolute Timeout
41     * MailboxCount: Check Mailbox Message Count
42     * Monitor: Monitor a channel
43     * StopMonitor: Stop monitoring a channel
44     * ChangeMonitor: Change monitoring filename of a channel
45     * IAXpeers: List IAX Peers (Defaults to IAX2)
46     * IAX1peers: List IAX version 1 Peers
47     * Queues: Queues
48     * QueueStatus: Queue Status 
49
50
51 Command Summary
52 --------------
53
54 Command: Command
55 Parameters: Command
56
57 Command: ExtensionState
58 Parameters: Exten, Context, ActionID
59
60 Command: Hangup
61 Parameters: Channel
62
63 Command: Logoff
64 Parameters: None
65
66 Command: MailboxCount
67 Parameters: Mailbox, ActionID
68
69 Command: MailboxStatus
70 Parameters: Mailbox, ActionID
71
72 Command: Originate
73 Parameters: Channel, Exten, Context, Priority, Timeout, 
74 CallerID, Variable, Account, Application, Data, Async
75
76 Command: Ping
77 Parameters: None
78
79 Command: Redirect
80 Parameters: Channel, ExtraChannel, Exten, Context, Priority
81
82 Command: Timeout
83 Parameters: Channel, Timeout
84
85
86 Examples
87 --------
88 Login - Log a user into the manager interface.
89
90    Action: Login
91    Username: testuser
92    Secret: testsecret
93
94 Originate - Originate a call from a channel to an extension.
95
96    Action: Originate
97    Channel: sip/12345
98    Exten: 1234
99    Context: default
100
101 Originate - Originate a call from a channel to an extension without waiting
102 for call to complete.
103
104    Action: Originate
105    Channel: sip/12345
106    Exten: 1234
107    Context: default
108    Async: yes
109
110
111 Redirect with ExtraChannel:
112   Attempted goal:
113   Have a 'robot' program Redirect both ends of an already-connected call
114   to a meetme room using the ExtraChannel feature through the management interface.
115
116   Action: Redirect
117   Channel: Zap/1-1
118   ExtraChannel: SIP/3064-7e00 (varies)
119   Exten: 680
120   Priority: 1
121
122 Where 680 is an extension that sends you to a MeetMe room.
123
124 There are a number of GUI tools that use the manager interface, please search
125 the mailing list archives and the documentation page on the http://www.asterisk.org
126 web site for more information.
127
128
129
130
131 -----------------