PAGI 项目技术文档

本文档旨在帮助用户详细了解并使用 PAGI（PHP Asterisk Gateway Interface）项目，该项目为开发者提供了一个用于创建 IVR（Interactive Voice Response）应用的框架，基于 Asterisk 的 AGI（Asterisk Gateway Interface）。

1. 安装指南

要安装 PAGI，您需要使用 Composer。在您的 composer.json 文件中添加以下依赖：

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

然后运行 composer install 来安装库。

2. 项目使用说明

在使用 PAGI 前，请确保包含了 Composer 提供的自动加载器：

require __DIR__ . '/vendor/autoload.php';

PAGI 提供了多种节点（Nodes）和控制器（NodeController），可以帮助您简化 IVR 应用的构建和测试。

• 节点（Nodes）：节点是 IVR 应用的构建块，允许您播放声音文件、处理用户输入等。
• 节点控制器（NodeController）：节点控制器允许您根据节点结果控制呼叫流程，例如在取消或完成输入时跳转节点。

您可以从 doc/examples/node/example.php 和 doc/examples/nodecontroller/example.php 中找到使用示例。

3. 项目 API 使用文档

PAGI 提供了多个门面（Facades），用于访问 CDR 变量、通道变量、主叫 ID 等。以下是部分可用 API 的简要说明：

• PAGI\Client\CDR：用于访问 CDR 变量。
• PAGI\Client\ChannelVariables：用于访问通道变量和 Asterisk 环境变量。
• PAGI\Client\CallerID：用于访问主叫 ID 变量。
• PAGI\Client\Result：用于封装 AGI 命令的结果。
• PAGI\CallSpool\CallFile：用于创建和管理呼叫文件。
• PAGI\Logger\Asterisk：提供对 Asterisk 日志的访问。

每个操作都会返回一个 Result 对象，某些操作还会返回装饰了额外功能的 Result 对象，例如 PlayResult、ReadResult 等。

4. 项目安装方式

PAGI 的安装方式已在安装指南中详细说明，以下是安装步骤的总结：

1. 在 composer.json 中添加 PAGI 的依赖。
2. 运行 composer install 来安装库。
3. 包含 Composer 提供的自动加载器。

通过遵循上述步骤，您可以轻松安装并开始使用 PAGI 项目。