API 心跳包

当连接 PBX 的第三方应用的 IP 地址、监听端口或者 URL 有变更的时候，可通过 API 的心跳包接口对 IP、Port 和 URL 进行更新。

当第三方应用和 API 没有交互的时候，可利用此接口定期发送请求从而更新 token 的有效时长，避免 token 在 30分钟超时后被清除，造成事件不会上报以及请求失败。

注： 发送一次心跳包请求可使 token 的有效时长延长为30分钟。

Endpoint

POST /api/v1.1.0/heartbeat?token={token}

请求参数

名称 是否必需 类型 描述
ipaddr 是 String 第三方应用变更后的 IP 地址。
port 是 String 第三方应用变更后的监听端口。
url 否 String 第三方应用服务器获取 API 报告的 URL。
注： 如果不带此参数，则 PBX 默认向第三方应用服务器的 IP 地址发送 API 报告。
urltag 否 String 指定 URL 的类型：
  • 0：定义url 的值为相对路径。PBX 会将相对路径的url与第三方服务器 IP 地址结合起来，发送 API 报告到具体的路径。

    例如：第三方服务器 IP 地址为192.168.5.122；监听端口为8260；url设置为 report；则 PBX 发送 API 报告到192.168.5.122:8260/report 。

  • 1：定义url的值为绝对路径。

    例如：第三方服务器 IP 地址为192.168.5.122；url 设置为192.168.5.122:8260/report；则 PBX 发送 API 报告到192.168.5.122:8260/report 。

    注： 使用绝对路径，可以避免复杂网络环境下，API 报告无法发送成功的问题。

实际示例

请求示例

第三方应用发送 API 心跳包对IP、Port 和 URL 进行更新。IP 地址变更为192.168.5.122，端口号变更为8280，URL 变更为192.168.5.122:8280/report。
POST /api/v1.1.0/heartbeat?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "url": "192.168.5.122:8260/report",urltag: "1"
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success"
}