如何启用API进行指令交互以及接收通话记录等PBX事件2.0

PBX 事件交互 API 配置指南 本文档旨在指导用户如何启用 API 进行指令交互以及接收通话记录等 PBX 事件。通过阅读本文档，用户将了解如何获取帮助文档、启用 PBX 的 API 接口、登录 API 以及相关的配置设置。 一、获取帮助文档 用户可以通过多种方式获取帮助文档，包括： 1. 在线帮助文档：用户可以访问 Yeastar 官方网站，获取 S 系列 API 的在线帮助文档。 2. PDF 说明档：用户可以联系代理或者信息技术支持获取 PDF 说明档。 二、PBX 启用 API 配置 在连接第三方应用服务器与 PBX 之前，用户需要先启用 PBX 的 API 接口，并做好相应的配置。具体步骤如下： 1. 登录 PBX 网页，进入配置→PBX→常规设置→二次开发接口。 2. 勾选启用。 3. 报告发送方法，默认使用 HTTP。 4. 设置用户名和密码，点击保存和应用。 5. 选择是否监控分机的状态。 6. 选择是否开启中继状态监控。 7. 来电接听控制：勾选来电接听控制之后，当该条中继有来电时先交由第三方应用处理，第三方应用可选择接受或者拒绝该来电。 8. 呼入目的地控制：勾选呼入目的地控制后，当该条中继有来电时将不会直接进入对应呼入路由的目的地，而是有 10 秒的时间等待第三方应用指定该通通话的目的地。 9. 状态监控：勾选中继的状态监控后，当该中继状态有变更时，API 会主动向第三方应用发送中继状态变更的事件报告。 10. 删除黑名单中的 API IP：如果某个 IP 在短时间内，多次尝试登陆 API 接口失败，PBX 会将该 IP 拉入黑名单，并将该 IP 类型标记为“API-IP”。 三、登录 API 用户可以使用 HTTPS 或 HTTP 访问 PBX 的 API 接口。默认情况下，PBX 开启 HTTPS 端口 8088，因此可以使用 HTTPS 访问 API。用户也可以使用 HTTP 访问 API，具体步骤如下： 1. 访问端口：用户可以使用 HTTPS 或 HTTP 访问 PBX 的 API 接口。 2. 使用用户名和密码验证：API 采用用户名和密码的方式验证，只有用户名和密码验证通过的应用服务器，API 才会处理其发送的请求。 请求地址：https://{pbx ip}:{https port}/api/{api version}/login 请求参数： * username：在 PBX 二次开发接口界面设置的用户名。 * password：将 PBX 二次开发接口界面设置的密码通过 MD5 加密，获取 32 位小写密码。 * port：端口号，此端口号为第三方应用用于监听 API 发送的事件报告的端口号。 通过阅读本文档，用户将了解如何启用 API 进行指令交互以及接收通话记录等 PBX 事件。本文档旨在帮助用户快速上手 PBX 的 API 配置，以便更好地使用 PBX 的功能。