Asterisk+manager+Interface(CN).doc

Asterisk manager API（AMI）文档(中文版)

1 概述

Asterisk 控制接口（AMI）允许管理客户端程序连接到一个 asterisk 实例并且可以通过

TCP/IP 流发送命令或读取事件。这在试图跟踪 asterisk 的状态或其中的电话客户端状态时

很有用，AMI 说明了客户端基于的一般(可能是动态的)规则。

一种简单的"key: value"协议用于已连接的管理客户端和 asterisk ＰＢＸ之间的信息传递。每

行都用回车换行（）来结束。

2 命令集功能介绍

$timeout = 100;

$ipaddr = "127.0.0.1";

$ipport = "5038";

$socket = fsockopen($ipaddr,$ipport,$errno,$errstr,$timeout);

if (!$socket)

{

echo "$errstr ($errno) <br\>";

}

else

{

while (!feof($socket))

{

echo fgets($socket,128);

}

}

fclose($socket);

?>

程序运行后显示如下：

[root@uccp_2 test]# ./test.php

connect IP:(127.0.0.1) successsocket (Resource id #4)Asterisk Call Manager/1.1

回车换行由于区分每一行，空行（两个连续回车换行）用于表明命令结束， Asterisk 开始

处理命令。

2.1.2 数据包类型

数据包的类型通过一下几种关键字来划分

Action:一个由管理客户端发送到 Asterisk 的数据包，请求执行特定的动作。只有有限的几

种动作供客户端使用，每个动作是由 Asterisk 服务器上的模块所决定的。一次只能执行一

个动作，该动作数据包包含了动作名称以及执行所必需的参数。

Response:Asterisk 对管理客户端动作的响应。

Event: 有关 Asterisk 核心或扩展模块发生事件的信息。

2.1.3 建立管理连接和用户身份验证

Action: login

Username: admin

Secret: secret

cat manager.conf

[general]

displaysystemname = yes

enabled = yes

webenabled = no

port = 5038

;httptimeout = 60

permit=10.0.65.0/255.255.255.0

writetimeout = 100

read = system,call,log,verbose,command,agent,user

write = system,call,log,verbose,command,agent,user

你还可以通过"Events: off"阻止事件数据包发送到你的连接。例如：

Action: login

Username: admin

Secret: secret

Events: off

动作数据包：

向 Asterisk 发送动作时，额外的关键字可以提供进一步的动作信息。例如，你可能希望指

Action: <action type><CRLF>

<Key 1>: <Value 1><CRLF>

<Key 2>: <Value 2><CRLF>

...

Variable: <Variable 2>=<Value 2><CRLF>

...

通过 CLI 命令 show manager commands 的输出结果就是管理动作列表。

具体如下：

2.2 AbsoluteTimeout:设置通道超时

这个命令将要求 Asterisk 在指定秒数后挂断特定的通道，从而有效地结束通话。

参数：

Channel :哪些渠道挂断，如 SIP/123-1c20

Timeout :到通道应挂断的秒数

例子：

请求信息

Action: AbsoluteTimeout

返回成功信息

Response: Success

返回失败信息

File：文件名

例子：

发送请求

ACTION: ChangeMonitor

Channel: SIP/x7065558529-1c20

File: 20050103-140105_cc51

返回失败信息

返回成功信息

2.4 Command：发送 CLI 命令

发送 Asterisk CLI 命令。

参数：

Command：Asterisk CLI 命令。

例子：

发送请求