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
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
Join
Leave
Link
ListDialplan
Masquerade
MessageWaiting
MusicOnHold
NewAccountCode
NewCallerid
Newchannel
Newexten
Newstate
OriginateResponse
ParkedCall
ParkedCallsComplete
PeerEntry
PeerlistComplete
PeerStatus
QueueMember
QueueMemberAdded
QueueMemberRemoved
QueueMemberPause
QueueMemberStatus
QueueParams
QueueStatusComplete
QueueSummaryComplete
RegistrationsComplete
Registry
Rename
RTCPReceived
RTCPReceiver
RTCPSent
RTPReceiverStat
RTPSenderStat
ShowDialPlanComplete
Status
StatusComplete
Transfer
Unlink
UnParkedCall
UserEvent
VarSet
vgsm_me_state
vgsm_net_state
vgsm_sms_rx
VoicemailUserEntry
VoicemailUserEntryComplete

当前支持的操作

绝对超时
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
ExtensionState
创建配置
获取配置
获取ConfigJSON
获取变量
Hangup
JabberSend
本地优化
登录
注销
列出分类
列出命令
邮箱计数
邮箱状态
Meetme列表
Meetme静音
Meetme取消静音
MixMonitor
模块检查
模块加载（拆分为ModuleLoad，ModuleUnload和ModuleReload）
监控
原地生成
停车呼叫
暂停监控
Ping
播放DTMF
队列
队列添加
队列
队列日志
队列暂停
队列处罚
队列重新加载
队列删除
队列重置
队列规则
队列摘要
队列状态
队列取消暂停
重定向
重新加载
发送文本
设置变量
显示拨号计划
Sipnotify
Sippeers
Sipqualifypeer
Sipshowpeer
Sipshowregistry
Status
停止MixMonitor
停止监控
取消暂停监控
VGSM_SMS_TX
VoicemailUsersList

调试、日志记录

您可以可选地设置一个符合PSR-3的记录器

$pami->setLogger($logger);

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

开发者

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

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

运行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支持、JabberEvent和JabberAction中的ScreenName方面提供帮助。
Scot Opell在5.3.9和5.3.10中帮助调试stream_get_line()。
Brian（wormling）尝试并修复了asyncagi上的错误。
Henning Bragge在新state事件和队列方面提供帮助。
mbonneau为ParkedCall和UnParkedCall事件提供帮助。

giannicodemus / pami

维护者

详细信息