As of version 1.4, Asterisk comes packaged with a small web server called AJAM, which may be used to access the Asterisk Manager Interface (AMI) via HTTP. The name "AJAM" is derived from "AJAX"[41] (Asynchronous JavaScript and XML).
Set-up assumes the steps from the section called “The Asterisk Manager Interface (AMI)” have been carried out, plus some additional parameters. You must set webenabled
to yes
in the [general]
section of manager.conf
. Pay attention to httptimeout
, which defines the inactivity timeout after which the user is automatically logged out of the web interface. To activate the web server, set these parameters in http.conf
:
[general]
enabled=yes
enablestatic=yes
bindaddr=127.0.0.1
bindport=8088
prefix=asterisk
enablestatic
need only be activated if the AJAM will be serving static files from /var/lib/asterisk/static-http/
. Normally you would set this to no
, but it is needed for the purposes of the Asterisk-AJAM demo (the section called “AJAM Demo”).
Don't forget to restart!
|
Our assessment is that it almost never makes sense to serve other web applications (that is, those intended strictly for administrator access) through the AJAM interface. It is also doubtful that it was intended to, because the rights assignments through read and write (see the section called “The Asterisk Manager Interface (AMI)”) simply don't offer sufficient granularity. Always assume that a user can initiate actions other than those you have made available on the web page. It is far better to let your application use a PHP script containing only the specific AMI commands it needs to do its job, and to restrict the AMI rights for the accessing user as extra insurance.
|
Example: Getting the number of voicemail messages with AJAM
Again, we are solving the problem addressed in the section called “Example: Getting the number of voicemail messages with expect” and the section called “Example: Getting the number of mailbox messages with PHP”: we want to find out the number of messages in a specified mailbox. The AJAM offers us a few ways to do this:
The AMI waits for queries at
http://localhost:8088/asterisk/manager
. Packet fields are tacked on the end of the URL. Try these addresses in your web browser:
http://localhost:8088/asterisk/manager?action=Login&username=admin&secret=secret5
http://localhost:8088/asterisk/manager?action=MailboxCount&mailbox=123
The response follows in the form of an HTML page, so it's not really suitable for access via a script.
If we replace manager
in the URL with rawman
, we get plain text output. To log in and get a message count from the mailbox, then:
http://localhost:8088/asterisk/rawman?action=Login&username=admin&secret=secret5
Response: Success
Message: Authentication accepted
http://localhost:8088/asterisk/rawman?action=MailboxCount&mailbox=123
Response: Success
Message: Mailbox Message Count
Mailbox: 123
NewMessages: 0
OldMessages: 0
http://localhost:8088/asterisk/rawman?action=Logoff
Response: Goodbye
Message: Thanks for all the fish.
This text output is more script-friendly.
If we want XML instead, we call mxml
instead. The XML output is presented formatted for better readability. In practice, AJAM does not put line breaks inside the XML tags. Either way, a compliant XML parser won't care.
http://localhost:8088/asterisk/mxml?action=Login&username=admin&secret=secret5
<ajax-response>
<response type='object' id='unknown'>
<generic
response='Success'
message='Authentication accepted' />
</response>
</ajax-response>
http://localhost:8088/asterisk/mxml?action=MailboxCount&mailbox=123
<ajax-response>
<response type='object' id='unknown'>
<generic
response='Success'
message='Mailbox Message Count'
mailbox='123'
newmessages='0'
oldmessages='0' />
</response>
</ajax-response>
http://localhost:8088/asterisk/mxml?action=Logoff
<ajax-response>
<response type='object' id='unknown'>
<generic
response='Goodbye'
message='Thanks for all the fish.' />
</response>
</ajax-response>
AJAX and AJAM considerations
AJAX applications - as the name "Asynchronous JavaScript and XML" might suggest - use XML as the standard format, even though it is often criticized for its bloated structure. There are alternatives, such as JSON[42], for example. JSON (JavaScript Object Notation) is - the name gives it away - well-suited for Javascript applications, because the data structure can be converted into an object natively and with little overhead using eval()
. There are countless implementations for PHP, Perl, etc. but a JSON implementation for AJAM does not yet exist. One can, however, convert the plain-text output into JSON on the client side, if that turns out to be easier or if it's easily done using available Javascript libraries. Here's an example to get you thinking:
// We assume the received response and
// simulate it here:
var responseText = 'Response: Success/n'
+'Message: Mailbox Message Count/n'
+'Mailbox: 123/n'
+'NewMessages: 0/n'
+'OldMessages: 0/n';
// Escape single quotation marks:
responseText = responseText.replace( //'/g, "//'" );
// Wrap fields in quotes:
responseText = responseText.replace( /^([a-z/d]*):/s*(.*)/gmi, "'$1':'$2
'," );
// Convert to object:
eval('var packet = {'+ responseText +'}');
// Now you can access the fields as you would with any object:
alert( packet['NewMessages'] ); // returns "0"
When accessing the AJAM with an AJAX application, the ping command is particularly useful for keeping authenticated connections alive.
http://localhost:8088/asterisk/rawman?action=Ping
Response: Pong
A small sample application demonstrating AJAX access may be run at
http://localhost:8088/asterisk/static/ajamdemo.html
. This uses the highly practical JavaScript library prototype[43] for AJAX access and displays, using the Status
the currently active channels. You can use the AJAM demo as a basis for your own AJAX applications.
The Asterisk web server is a minimal implementation and cannot be seen as a wholesale replacement for a "proper" web server that can run PHP scripts or use modules, such as Apache. To unify a system that uses both, you can use Apache as a proxy for AJAM by adding
ProxyPass /ajam http://localhost:8088/asterisk
in the appropriate place in httpd.conf
, so that all requests for /ajam
are passed on to AJAM instead of being served by Apache.
分享到:
相关推荐
Asterisk manager API
The Asterisk Manager Interface (AMI) allows a client program to connect to an Asterisk instance and issue commands or read events over a TCP/IP stream. Integrators will find this particularly useful ...
Asterisk+manager+Interface(CN).doc
Asterisk_manager_API(AMI)文档
Asterisk控制接口(AMI)允管理客端程序接到一个asterisk实例并且可以通过TCP/IP流发送命令或读取事件。 如果你需要进行Asterisk开发,这个文档会非常有用,并且是中文的。 如果英文好,可以直接在www.voip-info.org...
This is a book for anyone who uses Asterisk, but particularly those who already ...external application through the Asterisk Gateway Interface or Asterisk Manager Interface isn’t also possible.
Jami,Java Asterisk Mananger接口是Java客户端通过mananger接口连接到星号PBX的库。
Asterisk Manager Interface客户端C库 libamievent是用C编写的Asterisk Manager Interface的异步事件驱动的客户端库。它使用作为事件循环后端。 使用libamievent,您可以发送AMI命令,还可以订阅对该命令的响应。 ...
通过socket 连接asterisk 并分析asterisk 的Event事件。主要支持asterisk 1.4 版本
这个gem为Asterisk Manager Interface的Ruby或RubyOnRails项目添加了支持 有一个同名的项目,但似乎已停产,所以我决定开始一个新项目 安装 轨道3 添加到您的Gemfile并运行bundle命令进行安装。 gem "ruby-...
Asterisk客户端和Asterisk manager API(AMI)文档。
Asterisk.NET替代产品的开始。 该项目的目标是创建一个管理器连接库,以简化与多个Asterisk服务器的接口。 Asterisk Connection Manager当前是一个非常新的,不完整的文档。
Asterisk manager API(AMI)文档
对于我的项目,我需要Asterisk Manager API的低级接口。 我环顾四周,发现 。 虽然这是一个很好的起点,但对于我来说,它有太多的抽象。 这就是为什么我将其版本基于它,然后从根本上对其进行重构的原因。 最后,...
AM-Asterisk PBX GUI配置/管理系统。 AM提供了用于创建Asterisk配置(.conf)文件HTML界面。 它还允许您远程管理和监视集团电话。
Asterisk 简介 Asterisk 架构 Asterisk程序框图
使用spandsp管理Asterisk接收的传入传真
AMS是一套软件,旨在简化Asterisk PBX服务器的日常管理和监视。 它包含一个守护程序,该守护程序充当Asterisk的Manger Interface的代理,以及一个用于监视和管理的GTK GUI应用程序。
Asterisk:The Futrue of Telephony 是一本详细介绍Asterisk技术的很好的参考书,全英文,原汁原味,参考和使用价值极高。
Asterisk 1.4 the Professionals Guide.pdf