API 请求概述

本文介绍 Yeastar P 系列云 PBX API 的通信协议、通信端口和 API 请求交互流程。

通信协议

Yeastar P 系列云 PBX 支持 HTTPS 协议请求通信。所有 API 请求均使用 HTTPS GET 和 POST 方式调用。

通信端口

API 调用的通信端口与 PBX 网页访问端口一致,即 HTTPS 端口 443。

API 请求交互流程

通过 API 建立连接后,第三方应用作为客户端,而 PBX 作为服务器。两者之间的 API 请求流程如下图所示。

第三方应用每次发起请求时,就建立了一个新的 TCP 连接。在 PBX 返回一个响应后,TCP 连接关闭。

在第一个请求中,第三方应用需要发送凭据,用于请求一个访问 token。PBX 验证凭据后返回访问 token。在后续的请求中,第三方应用都需要在请求中带上这个访问 token,用于认证。PBX 在校验到有效的访问 token 后,返回请求的资源。