README

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

简介

PAMI 意味着 PHP Asterisk 管理接口。正如其名称所暗示的，它只是一组 PHP 类，允许您使用观察者-监听器模式向 AMI 发送命令和/或接收事件。

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

nodejs 的端口可在： http://marcelog.github.com/Nami 找到。erlang 的端口可在： https://github.com/marcelog/erlami 找到。

资源

API
PHP Conference Argentina 2013 的完整 PAGI/PAMI 演讲。请查看幻灯片备注以获取完整文本 :)

PHP 版本

注意：PAMI 需要 PHP 5.3+。由于在 5.3.9 中引入了 stream_get_line() 的错误，5.3.9 和 5.3.10 的 PHP 版本将无法正常工作。请使用 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
拨号
DTMF
分机
挂断
保持
JabberEvent
加入
离开
链接
列出拨号计划
伪装
留言等待
通话保持音乐
新账户代码
新主叫ID
新通道
新分机
新状态
原始响应
已停泊通话
已停泊通话完成
对等方条目
对等方列表完成
对等方状态
队列成员
队列成员添加
队列成员移除
队列成员暂停
队列成员状态
队列参数
队列状态完成
队列摘要完成
注册完成
注册表
重命名
RTCP接收
RTCP接收者
RTCP发送
RTP接收者统计
RTP发送者统计
显示拨号计划完成
状态
状态完成
转接
断开链接
取消停泊通话
用户事件
设置变量
vgsm_me_state
vgsm_net_state
vgsm_sms_rx
语音邮件用户条目
语音邮件用户条目完成

当前支持的操作

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

调试、日志记录

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

$pami->setLogger($logger);

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

开发者

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

测试：运行 PHPUnit。
cs：运行 CodeSniffer。
doc：运行 PhpDocumentor。
md：运行 PHPMD。
构建：这是默认任务，将运行所有其他任务。

运行phing任务

要运行任务，只需这样做

vendor/bin/phing build

贡献

要贡献

确保您打开一个 简洁的 和 简短的 pull request。
加入任何必要的单元测试以适应新的代码或涉及的变化。
运行 phing 并确保在提交 pull request 之前一切正常（让 phpmd 和 CodeSniffer 满意，同时确保 phpDocumentor 不抛出任何警告，因为我们的所有文档都是自动生成的）。
您的代码必须遵循PSR-2规范，CodeSniffer将负责这一点。

许可证

根据Apache许可证版本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支持、JabberEvent和JabberAction中的ScreenName时的贡献。
Scot Opell在帮助调试5.3.9和5.3.10中的stream_get_line()方面的贡献。
Brian (wormling)在尝试和修复asyncagi上的bug方面的贡献。
Henning Bragge在新state事件和队列方面的帮助。
mbonneau在ParkedCall和UnParkedCall事件方面的贡献。

dyegogssouza / pami

维护者

详细信息