API 快速入门

本文以Yeastar API demo 为例，为你演示如何配置 API 、调用 API 接口以及如何查看事件报告。

前提条件

在使用 API 之前，确保你已升级 PBX 固件，并在 PBX 网页启用 API 功能和做好相应的配置。

PBX 固件要求，请参见 API 使用前提。

PBX API 设置说明，请参见PBX API 网页设置。

API demo

下载 API demo
点击下载 API demo 2.0 工具。
API demo 界面介绍
查看下面图示，了解 API demo 工具的界面布局。

API demo 测试示例

下面以Yeastar API demo 作为 API 调用工具，为你演示如何使用 API 接口 call/dial 完成分机拨打分机的任务，以及如何查看相关的事件报告。

注： 调用 API 之前，请根据 API 接口参考文档了解使用说明，并查询必需的请求参数。如果 API 调用出错，你可以根据错误代码进行分析和排查错误。
API demo 设置
  1. 在 API demo 中填写 API 版本、 PBX 的 IP 地址和通信端口。

    • 版本号：填写 API 版本号 2.0.0。
      注： 本文档中，所有接口和事件报告均采用的 API 版本为 2.0.0。
    • HTTP/HTTPS：选择通信协议。 。
      注： 本示例中使用的通信端口为 HTTPS 8088。如果你更改了 PBX 的网页访问协议和端口，在 demo 中需要根据 PBX 的实际配置填写。
    • 目标地址：填写 PBX 的 IP 地址。
    • 端口：填写 PBX 的网页端口。本示例填写 8088。
  2. 在 API demo 中配置监听端口，并点击 打开服务器，监听该端口。

    PBX 会通过该端口发送事件报告。

获取 API 授权
  1. 调用 login 接口获取 API token。

API 调用
  1. 调用 call/dial 向分机发起呼叫。

    本例中，演示分机 1001 向分机 1018 发起呼叫，请求参数如下。

    {"caller": "1001","callee": "1018"}

观察调用结果

如果该 API 调用成功后，后续流程为：

  1. 主叫分机 1001 先振铃。
  2. 分机 1001 摘机后，被叫分机 1018 开始振铃。
  3. 分机 1018 接听来电后，双方建立通话。
  4. 任意一方挂机后，通话结束。
查看事件报告

本次呼叫过程中，应用服务器会接收到通话状态变更事件（Call Status）和分机状态变更事件（ExtensionStatus）。

通话结束后，应用服务器还会接收到一条通话记录事件（NewCdr）。