README

![点击此处支持：PAMI 并在pledgie.com上捐款！](https://pledgie.com/campaigns/30944.png?skin_name=chrome' border='0')

简介

PAMI代表PHP Asterisk Manager Interface。正如其名所示，它只是一组php类，可以让你通过观察者-监听器模式向ami发送命令或接收事件。

背后的想法是，通过SOA或ajax轻松实现操作员控制台、监控器等。

nodejs的端口可在以下位置找到：http://marcelog.github.com/Nami。Erlang的端口可在以下位置找到：https://github.com/marcelog/erlami

资源

API
2013年阿根廷PHP会议的完整PAGI/PAMI演讲。请查看幻灯片备注以获取完整文本 :)

PHP版本

注意：PAMI需要PHP 5.3+。由于在5.3.9中的stream_get_line()中引入了一个错误，因此PHP版本5.3.9和5.3.10将无法工作。请使用5.3.11+或5.3.8（请参阅README.PHP-5.3.9-and-5.3.10）。

安装

将此库添加到您的Composer配置。在composer.json中

  "require": {
    "marcelog/pami": "2.*"
  }

快速入门

对于深入的教程：http://marcelog.github.com/articles/pami_introduction_tutorial_how_to_install.html

// Make sure you include the composer autoload.
require __DIR__ . '/vendor/autoload.php';

$options = array(
    'host' => '2.3.4.5',
    'scheme' => 'tcp://',
    'port' => 9999,
    'username' => 'asd',
    'secret' => 'asd',
    'connect_timeout' => 10,
    'read_timeout' => 10
);
$client = new \PAMI\Client\Impl\ClientImpl($options);

// Registering a closure
$client->registerEventListener(function ($event) {
});

// Register a specific method of an object for event listening
$client->registerEventListener(array($listener, 'handle'));

// Register an IEventListener:
$client->registerEventListener($listener);

使用谓词

在注册事件监听器时可以使用第二个（可选）参数：一个将在调用回调之前评估的闭包。只有当此谓词返回true时，才会调用回调。

use PAMI\Message\Event\DialEvent;

$client->registerEventListener(
    array($listener, 'handleDialStart'),
    function ($event) {
        return $event instanceof DialEvent && $event->getSubEvent() == 'Begin';
    })
);

示例

请参阅docs/examples/quickstart/example.php以获取一个非常基本的示例。

AsterTrace是一个完整的应用程序：https://github.com/marcelog/AsterTrace。

此外，您可能还想查看这篇文章：http://marcelog.github.com/articles/php_asterisk_listener_example_using_pami_and_ding.html

有关使用PAMI异步AGI的示例，请参阅docs/examples/asyncagi

《三月版软件开发者期刊》中有一篇关于使用PAMI和PAGI编写电话应用程序的完整文章。

当前支持的事件

随着时间的推移，将添加更多事件。我只能添加我可以测试和使用的事件，所以您的贡献可能就是关键！ ;)

未知（尚未实现）的事件将被报告为UnknownEvent，因此您仍然可以捕获它们。如果您捕获了其中之一，请报告它！

AgentsComplete
AgentConnect
Agentlogin
Agentlogoff
AGIExec
AsyncAGI
Bridge
BridgeInfoChannel
BridgeInfoComplete
CEL
ChannelUpdate
ConfbridgeEnd
ConfbridgeJoin
ConfbridgeLeave
ConfbridgeList
ConfbridgeListComplete
ConfbridgeMute
ConfbridgeStart
ConfbridgeTalking
ConfbridgeUnmute
CoreShowChannel
CoreShowChannelComplete
DAHDIShowChannel
DAHDIShowChannelsComplete
FullyBooted
DongleSMSStatus
DongleUSSDStatus
DongleNewUSSD
DongleNewUSSDBase64
DongleNewCUSD
DongleStatus
DongleDeviceEntry
DongleShowDevicesComplete
DBGetResponse
Dial
DTMF
Extension
Hangup
Hold
JabberEvent
加入
离开
链接
列出Dialplan
伪装
留言等待
通话保持音乐
新账号代码
新呼叫者ID
新通道
新分机
新状态
起源响应
已挂起通话
挂起通话完成
对等实体条目
对等列表完成
对等状态
队列成员
队列成员添加
队列成员移除
队列成员暂停
队列成员状态
队列参数
队列状态完成
队列摘要完成
注册完成
注册表
重命名
RTCP接收
RTCP接收器
RTCP发送
RTP接收器统计
RTP发送者统计
显示Dialplan完成
状态
状态完成
转移
解除链接
解除挂起通话
用户事件
变量设置
vgsm_me_state
vgsm_net_state
vgsm_sms_rx
语音邮件用户条目
语音邮件用户条目完成

当前支持的操作

绝对超时
AGI
代理
代理注销
Atxfer (asterisk 1.8?)
Bridge
桥接信息
更改监控
命令
ConfbridgeList
ConfbridgeMute
ConfbridgeUnmute
核心设置
核心显示通道
核心状态
DAHDIDialOffHookAction
DAHDI挂断
DAHDIRestart
DAHDIShowChannels
DAHDIDNDOn
DAHDIDNDOff
DBGet
DBPut
DBDel
DBDelTree
DongleSendSMS
DongleSendUSSD
DongleSendPDU
DongleReload
DongleStop
DongleStart
DongleRestart
DongleReset
DongleShowDevices
扩展状态
创建配置
获取配置
获取配置JSON
获取变量
Hangup
Jabber发送
本地优化
登录
注销
列出类别
列出命令
邮箱计数
邮箱状态
Meetme列表
Meetme静音
Meetme取消静音
MixMonitor
模块检查
模块加载（拆分为模块加载、模块卸载和模块重新加载）
监控
起源
挂起通话
暂停监控
Ping
播放DTMF
队列
队列添加
队列
队列日志
队列暂停
队列惩罚
队列重新加载
队列移除
队列重置
队列规则
队列摘要
队列状态
队列取消暂停
重定向
重新加载
发送文本
设置变量
显示Dialplan
Sipnotify
Sippeers
Sipqualifypeer
Sipshowpeer
Sipshowregistry
状态
停止MixMonitor
停止监控
取消暂停监控
VGSM_SMS_TX
语音邮件用户列表

调试、日志记录

您可以设置一个PSR-3兼容的记录器

$pami->setLogger($logger);

默认情况下，客户端将使用NullLogger。

开发者

此项目使用phing。当前任务包括

test: 运行PHPUnit。
cs: 运行CodeSniffer。
doc: 运行PhpDocumentor。
md: 运行PHPMD。
build: 这是默认任务，将运行所有其他任务。

运行phing任务

要运行任务，只需做

vendor/bin/phing build

贡献

要贡献

请确保您打开一个简洁的和简短的拉取请求。
添加任何必要的单元测试以适应新代码或涉及的更改。
运行phing并确保在提交拉取请求之前一切正常（使phpmd和CodeSniffer满意，还要确保phpDocumentor不会抛出任何警告，因为我们的所有文档都是自动生成的）。
您的代码必须遵循PSR-2规范，CodeSniffer将负责检查。

许可协议

在Apache License，版本2.0（以下简称“协议”）下授权；除非符合协议规定或书面同意，否则不得使用此文件。您可以在以下位置获得协议副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在协议下分发的软件按“现状”基础分发，不提供任何明示或暗示的保证或条件。有关许可协议的具体语言规定权限和限制，请参阅协议。

感谢以下人员

Jason Blank，在队列功能调试和一些其他ami不一致性方面提供了帮助。
Francesco Usseglio Gaudi，在调试Originate动作方面提供了帮助。
Matías Barletta，为vgms支持提供了帮助。
Eli Hunter，帮助实现tls兼容性。
Freddy dafredmail at googlemail，为其帮助和测试环境添加对dongle的支持。
Joshua Elson，在加载的asterisk服务器上尝试和调试方面提供了帮助。
Jacob Kiers，在引入和测试异步AGI功能以及CEL事件支持方面提供了帮助。
Richard Baar，注意到了从套接字读取时缺少eof支持，以及在JabberAction中的JabberEvent和ScreenName。
Scot Opell，在5.3.9和5.3.10中帮助调试stream_get_line()。
Brian (wormling)，在asyncagi上尝试和修复错误。
Henning Bragge，在新state事件和队列方面提供了帮助。
mbonneau，为ParkedCall和UnParkedCall事件提供了帮助。

marcelog / pami

维护者

详情