API 认证机制

本文介绍 API 调用和推送事件报告的认证机制。

认证机制

API 调用采用 token 进行认证；事件报告的认证机制，根据推送方式的不同，采用不同的认证机制。
  • API 调用

    应用服务器需要通过 API 用户名和密码（MD5 加密32位小写字母）向 PBX 获取 API token，每次调用 API 接口都要带上有效的 token。

    注： 通过延长 API token 时效， 保证 token 的有效性。
  • HTTP 事件报告

    应用服务器需要先通过 API 用户名和密码（MD5 加密32位小写字母）向 PBX 获取 API token，并保证 token 的有效性，PBX 才会推送事件报告到应用服务器。

    注： 通过延长 API token 时效， 保证 token 的有效性。
  • TCP 事件报告

    应用服务器向 PBX 建立 TCP 连接后，通过 API 用户名和密码（明文）向 PBX 发送 TCP login 数据包，获取 PBX 认证后， PBX 主动向应用服务器推送事件报告。

    注： PBX 或应用服务器网络异常或重启时，需要重新建立 TCP 连接和发送 TCP login 数据包。

Token 时效

token 的有效时长为 30 分钟。

30 分钟内如果应用服务器和 PBX 没有任何交互 （如：应用服务器向 PBX 发送 API 请求），则 PBX 将会清除该 token。

应用服务器可通过心跳包API token 续活，每发送一次心跳包可使 token 的有效时长延长至 30 分钟。