API 事件概述

Yeastar P 系列软件版 API 事件提供了全面的事件记录和变化追踪，以帮助开发者监控 PBX 资源。你可以根据需要选择 WebSocket 或 Webhook 作为事件监控方式，并订阅 PBX 事件。如此一来，一旦相关的事件发生，PBX 将主动向第三方应用发送事件报告。

WebSocket 监控

Yeastar P 系列软件版 API 支持通过 WebSocket 协议向第三方应用发送事件通知。WebSocket 协议是一种计算机通信协议，可在单个 TCP 连接上提供服务器和客户端之间的持久的全双工通信。

第三方应用与 Yeastar P 系列软件版建立 WebSocket 连接并订阅所需的事件后，无需轮询 PBX 就可以收到事件驱动的响应，从而实现实时事件监控。详情请参见使用 WebSocket 监控事件。

限制条件

WebSocket 连接的有效时长为 60 秒。
如果 60 秒内第三方应用和 PBX 之间没有任何数据交互，WebSocket 连接将自动断开。
注：可使用 heartbeat 请求保持 WebSocket 连接的有效性。
WebSocket 连接的建立需要一个有效的访问 token，此 token 有效时长为 30 分钟。
你需要获取新的访问 token 或刷新访问 token 来保持 WebSocket 连接。

交互流程

客户端 (第三方应用) 和服务器 (Yeastar P 系列软件版) 之间 WebSocket 连接的数据交互流程如下所示：

在最开始的握手阶段，第三方应用通过 HTTP 发送请求，要求升级到 WebSocket。PBX 响应一个 HTTP 状态代码 101，表示协议将从 HTTP 切换到 WebSocket。升级成功后，在此 TCP 连接上发生的通信将遵循 WebSocket 协议。

在 WebSocket 连接的整个过程中，PBX 和第三方应用都可以随时向对方发送消息。如果任何一方关闭了连接，WebSocket 连接将被终止。

Webhook 是一种基于 HTTP 的回调机制，当 PBX 发生特定事件时，Webhook 将实时主动地推送事件通知到预定义的 URL。更多信息，请参见使用 Webhook 监控事件。

交互流程: 在 PBX 管理网页上配置 Webhook URL 并指定订阅事件后，当指定的事件发生时，PBX 会自动将事件通知发送给第三方应用。每次 PBX 发送事件通知时，第三方应用应返回一个表示成功的 HTTP 响应（2xx），表示消息已成功接收。

Yeastar P 系列软件版提供全面的事件监控，开发者可按需订阅。PBX 支持的事件监控包含但不限于以下：

详细的事件列表，请参见 API 事件概览。