API 事件推送

本文介绍 云 PBX 的事件推送方式及其通信协议、通信端口和交互流程。

事件推送方式

云 PBX 支持 TCP 短连接向应用服务器推送 HTTP 事件报告。

HTTP 事件推送

通信协议
PBX 采用 TCP 短连接的方式发送 HTTP 事件报告。
短连接时,PBX 每次推送事件都会新建 TCP 连接,应用服务器收到事件后应断开连接。
通信端口
应用服务器请求 获取 API token,登录 PBX 时,需要带 port 参数。port 表示事件报告监听端口。PBX 将事件报告通过该端口发送到应用服务器。
事件报告格式
JSON 格式。
推送前提
选用此方式推送事件报告,应用服务器必须先获取 API token 连接到 PBX,并且保持 token 的有效性,否则应用服务器无法接收到事件报告。
交互流程
下图为 HTTP 事件推送流程示例图。