README

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

由 Centre de Gestion des Vosges 分支，目标是更新此库以使其在 php8 及以上版本上运行。

介绍

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() 中引入的错误，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

《Software Developer Journal》的 3 月版包含一篇关于使用 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
挂断
保持
Jabber事件
加入
离开
链接
拨号计划列表
伪装
消息等待
通话保持音乐
新账户代码
新主叫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挂断
DAHDIRestart
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。
build：这是默认任务，将运行所有其他任务。

运行phing任务

要运行任务，只需这样做

vendor/bin/phing build

贡献

要贡献

请确保您打开一个简洁和简短的拉取请求。
添加任何必要的单元测试，以适应新代码或涉及到的更改。
运行phing并确保在提交拉取请求之前一切正常（让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，帮助并提供测试环境以添加串口支持。
Joshua Elson，帮助在加载的asterisk服务器上进行尝试和调试。
Jacob Kiers，帮助引入和测试异步AGI功能，以及CEL事件支持。
Richard Baar，注意到在从套接字、JabberEvent和JabberAction中的ScreenName读取时缺少eof支持。
Scot Opell，帮助调试5.3.9和5.3.10中的stream_get_line()。
Brian (wormling)，尝试并修复asyncagi中的错误。
Henning Bragge，帮助处理newstate事件和队列。
mbonneau，为ParkedCall和UnParkedCall事件提供支持。

bbardet / pami

维护者

详细信息