NodeJS-AsteriskManager 项目使用教程

1. 项目目录结构及介绍

NodeJS-AsteriskManager 项目的目录结构如下：

lib/                      # 存放项目核心代码的目录
    - actions.js          # 包含AMI命令的函数
    - events.js           # 包含事件处理逻辑的函数
    - index.js            # NodeJS-AsteriskManager 的主体逻辑
    - util.js             # 一些工具函数

node_modules/             # 项目依赖的模块

test/                     # 测试文件

README.md                 # 项目说明文件
LICENSE                   # 项目许可证文件
package.json              # 项目配置文件

• lib/：这个目录包含了项目的核心JavaScript代码。
• node_modules/：存放项目所依赖的第三方Node.js模块。
• test/：存放项目的测试代码。
• README.md：Markdown格式的项目说明文件，介绍了项目的相关信息和使用方法。
• LICENSE：项目所使用的许可证信息。
• package.json：项目的配置文件，定义了项目的名称、版本、描述、依赖等元数据。

2. 项目的启动文件介绍

项目的启动文件是位于根目录下的 index.js 文件。以下是启动文件的简单介绍：

// 引入 NodeJS-AsteriskManager 模块
const ami = require('./lib/index');

// 创建连接到AMI服务器的实例
// 参数包括：端口号、服务器地址、用户名、密码以及是否监听事件
const amiconnection = ami('port', 'host', 'username', 'password', true);

// 保持连接
amiconnection.keepConnected();

// 监听AMI事件
amiconnection.on('managerevent', function(evt) {
    // 处理事件
});

// 监听特定AMI事件，例如挂断事件
amiconnection.on('hangup', function(evt) {
    // 处理挂断事件
});

// 监听AMI动作的响应
amiconnection.on('response', function(evt) {
    // 处理响应
});

// 发送AMI动作，例如发起呼叫
amiconnection.action({
    'action': 'originate',
    'channel': 'SIP/myphone',
    'context': 'default',
    'exten': 1234,
    'priority': 1,
    'variable': {
        'name1': 'value1',
        'name2': 'value2'
    }
}, function(err, res) {
    // 处理动作的响应
});

启动文件负责初始化AMI连接，监听事件，以及发送AMI动作。

3. 项目的配置文件介绍

项目的配置文件是 package.json，它包含了项目的元数据、依赖和脚本等信息。以下是配置文件的一些关键字段：

{
  "name": "NodeJS-AsteriskManager",
  "version": "0.2.0",
  "description": "NodeJS Asterisk Manager API",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "events": "^1.1.1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/pipobscure/NodeJS-AsteriskManager.git"
  },
  "author": "Philipp Dunkel",
  "license": "MIT"
}

• name：项目的名称。
• version：项目的版本号。
• description：项目的简短描述。
• main：项目的入口文件。
• scripts：定义了一些可以运行的脚本，例如启动项目的 start 脚本。
• dependencies：项目依赖的Node.js模块。
• repository：项目的仓库信息，包括类型和URL。
• author：项目作者。
• license：项目使用的许可证类型。