Add the Ring time in the CONNECT on the queue_log and on the Manager event AgentConnect
[asterisk/asterisk.git] / doc / tex / ajam.tex
1 \section{Asynchronous Javascript Asterisk Manger (AJAM)}
2
3 AJAM is a new technology which allows web browsers or other HTTP enabled 
4 applications and web pages to directly access the Asterisk Manger 
5 Interface (AMI) via HTTP.  Setting up your server to process AJAM 
6 involves a few steps:
7
8 \subsection{Setup the Asterisk HTTP server}
9
10 \begin{enumerate}
11 \item Uncomment the line "enabled=yes" in /etc/asterisk/http.conf to enable
12    Asterisk's builtin micro HTTP server.
13
14 \item If you want Asterisk to actually deliver simple HTML pages, CSS, 
15    javascript, etc. you should uncomment "enablestatic=yes"
16
17 \item Adjust your "bindaddr" and "bindport" settings as appropriate for 
18    your desired accessibility
19
20 \item Adjust your "prefix" if appropriate, which must be the beginning of
21    any URI on the server to match.  The default is "asterisk" and the 
22    rest of these instructions assume that value.
23 \end{enumerate}
24
25 \subsection{Allow Manager Access via HTTP}
26
27 \begin{enumerate}
28 \item Make sure you have both "enabled = yes" and "webenabled = yes" setup 
29    in /etc/asterisk/manager.conf
30
31 \item You may also use "httptimeout" to set a default timeout for HTTP 
32    connections.
33
34 \item Make sure you have a manager username/secret
35 \end{enumerate}
36
37 Once those configurations are complete you can reload or restart 
38 Asterisk and you should be able to point your web browser to specific 
39 URI's which will allow you to access various web functions.  A complete 
40 list can be found by typing "show http" at the Asterisk CLI.
41
42 examples:
43
44 http://localhost:8088/asterisk/manager?action=login\&username=foo\&secret=bar
45
46 This logs you into the manager interface's "HTML" view.  Once you're 
47 logged in, Asterisk stores a cookie on your browser (valid for the 
48 length of httptimeout) which is used to connect to the same session.  
49
50 http://localhost:8088/asterisk/rawman?action=status
51
52 Assuming you've already logged into manager, this URI will give you a 
53 "raw" manager output for the "status" command.
54
55 http://localhost:8088/asterisk/mxml?action=status
56
57 This will give you the same status view but represented as AJAX data, 
58 theoretically compatible with RICO (http://www.openrico.org).
59
60 http://localhost:8088/asterisk/static/ajamdemo.html
61
62 If you have enabled static content support and have done a make install, 
63 Asterisk will serve up a demo page which presents a live, but very 
64 basic, "astman" like interface.  You can login with your username/secret 
65 for manager and have a basic view of channels as well as transfer and 
66 hangup calls.  It's only tested in Firefox, but could probably be made
67 to run in other browsers as well.
68
69 A sample library (astman.js) is included to help ease the creation of 
70 manager HTML interfaces.
71
72 Note that for the demo, there is no need for *any* external web server.
73
74 \subsection{Integration with other web servers}
75
76 Asterisk's micro HTTP server is *not* designed to replace a general 
77 purpose web server and it is intentionally created to provide only the 
78 minimal interfaces required.  Even without the addition of an external 
79 web server, one can use Asterisk's interfaces to implement screen pops 
80 and similar tools pulling data from other web servers using iframes, 
81 div's etc.  If you want to integrate CGI's, databases, PHP, etc.  you 
82 will likely need to use a more traditional web server like Apache and 
83 link in your Asterisk micro HTTP server with something like this:
84
85 ProxyPass /asterisk http://localhost:8088/asterisk