启用 Yeastar P 系列 IPPBX API

连接第三方应用与 Yeastar P 系列 IPPBX 之前，你需要在 PBX 上启用 API 功能，并做好相关配置。

前提条件

你已购买 API 服务。

操作步骤

  1. 登录 PBX 管理网页，进入 应用对接 > 二次开发接口。
  2. 启用 二次开发接口。

  3. 可选： 启用 IP 地址限制，并添加至少一个允许的 IP 地址和子网掩码。
    如果你设置了此项，只有允许的 IP 地址才可以使用 API 功能。
    注： 如果你使用 FQDN 进行远程 API 访问，当你在 FQDN 的 API 访问 功能中添加允许 IP 地址时，添加的 IP 地址会自动加入到 API IP 的允许名单中。更多信息，请参见 通过 Yeastar FQDN 远程访问 API。
  4. 在 高级设置 栏，根据需要启用分机和中继的状态监控功能。
    1. 进入 分机状态监控 页签，启用分机的监控功能。

      表 1.
      设置 说明
      注册状态监控 若启用，当分机的注册状态发生变更，PBX 会向第三方应用发送一个 30007 的事件报告。
      通话状态监控 若启用，当分机的通话状态发生变更，PBX 会向第三方应用发送一个 30008 的事件报告。
      出席状态监控 若启用，当分机的出席状态发生变更，PBX 会向第三方应用发送一个 30009 的事件报告。
    2. 进入 中继状态监控 页签，启用中继的监控功能和来电控制功能。

      表 2.
      设置 说明
      通话状态监控 若启用，当中继的注册状态发生变更，PBX 会向第三方应用发送一个 30010 事件报告。
      呼入来电控制 若启用，当来电通过被监控的中继呼入时，可实现以下功能：
      • PBX 会向第三方应用发送一个 30016 事件报告。
      • 第三方应用可使用 API 接口控制外线来电，包括接受来电和拒接来电。
  5. 点击 保存。

后续操作

从 PBX 上获取 客户端 ID 和 客户端密钥，并使用此凭据请求 API 访问 token。更多信息，请参见 获取访问 Token。