API token 续活

token 有效时长为30分钟，你必须使用此接口定期延长 token 时效，保证 PBX 和应用服务器的正常通信。

注：
  • 调用一次此接口，可使 token 的有效时长延长至30分钟。
  • 如果你选择 HTTP 事件推送，你也可以通过此接口更改事件推送的 URL 地址和端口。

请求地址

{base_url}/{api_path}/heartbeat?token={token}

请求参数

参数 是否必选 类型 描述
ipaddr 是 String 应用服务器的 IP 地址。
version 否 String 发送事件报告格式的版本。
注：
  • 本文档使用事件报告版本为 2.0.0。
  • 如果不带此参数，默认发送的事件报告版本为 1.0.0，建议设置此参数，获取正确格式的事件报告。
port 否 String

应用服务器要监听此端口，接收 PBX 发送的事件报告。

注： 如果你选择 报告发送方式 为 HTTP，此参数必填。

默认值：8260。
url 否 String 应用服务器获取事件报告的 URL。
注：
  • 此参数仅适用于 报告发送方式 为 HTTP 的情况。
  • 如果不带此参数，则 PBX 默认向应用服务器的 IP 地址发送事件报告。
urltag 否 String 指定 URL 的类型。
注： 此参数仅适用于 报告发送方式 为 HTTP 的情况。

取值范围：

  • 0：定义url的值为相对路径。PBX 会将相对路径的url与应用服务器的 IP 地址结合起来，发送事件报告到具体的路径。

    例如：应用服务器 IP 地址为110.22.2.3；监听端口为8260；url设置为report；则 PBX 发送事件报告到110.22.2.3:8260/report 。

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

    例如：应用服务器 IP 地址为110.22.2.3；url设置为110.22.2.3:8260/report；则 PBX 发送事件报告到110.22.2.3:8260/report 。

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

默认值：0。

示例

请求示例 

POST /api/v2.0.0/heartbeat?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "ipaddr": "192.168.6.24",
    "port": 8260,
    "version":"2.0.0"
}
响应示例
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}