使用 WebSocket 监控事件

使用前提

建立 WebSocket 连接

请求 URL

要开启一个 WebSocket 连接，你需要在请求 URL 中使用一个特殊的协议 wss：

wss://{pbx_domain}/{api_path}/subscribe?access_token={access_token}

订阅事件

建立 WebSocket 连接后，你需要编辑并发送事件订阅信息。这样一来，PBX 将在事件发生时自动向第三方应用发送订阅的事件报告。

请求信息

可在 API 事件报告概览 中查询想要订阅的事件 ID，并根据以下格式编辑和发送事件订阅信息：

{"topic_list":[eventid1,eventid2,...]}

示例

请求

订阅 通话状态变更 和 新通话记录 事件。

{"topic_list":[30011,30012]}

响应

{
    "errcode": 0,
    "errmsg": "SUCCESS"
}

在通话状态发生变更，或通话结束时，PBX 会主动向第三方应用发送事件报告。

保持 WebSocket 连接

出于安全目的，如果 60 秒内第三方应用和 PBX 之间无任何数据交互，WebSocket 连接将被断开。