注: 发送一次心跳包请求可使 token 的有效时长延长为30分钟。
POST /api/v0.0.1/heartbeat?token={token}
名称 | 是否必需 | 类型 | 描述 |
ipaddr | 是 | String | 第三方应用变更后的 IP 地址。 |
port | 是 | String | 第三方应用变更后的监听端口。 |
url | 否 | String | 第三方应用服务器获取 API 报告的 URL。注: 如果不带此参数,则 PBX 默认向第三方应用服务器的 IP 地址发送 API 报告。 |
urltag | 否 | String |
指定 URL 的类型:
例如:第三方服务器 IP 地址为192.168.5.122;监听端口为8260;url设置为 report;则 PBX 发送 API 报告到192.168.5.122:8260/report 。
例如:第三方服务器 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 地址变更为172.16.6.150,端口号变更为8280,URL 变更为172.16.6.150:8280/report。
POST /api/v0.0.1/heartbeat?token=813b621cfe8eecf445a2ce1f4a079ffe HTTP/1.1 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
{
"ipaddr": "172.16.6.150",
"port": "8280",
"url": "172.16.6.150:8280",
"urltag": "1"
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
"status": "Success"
}