物联网开发平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联网开发平台 > 应用端开发指南 > 应用端 API > 长连接通信 > 心跳

心跳

最近更新时间：2023-10-17 14:30:11

我的收藏

本页目录：

1. 接口描述

接口请求域名：wss://iot.cloud.tencent.com/iotstudio_v2_weapp_1 设备保活，通过该接口更新设备时间戳，保持设备监听状态，同时保持 WebSocket 连接。可以多次调用，每60s调用一次。

2. 输入参数

名称
类型
必选
描述
action
String
是
公共参数，本接口取值：YunApi。
reqId
String
是
公共参数，标示请求序列，唯一请求 ID，可自行生成。
params
Object
是
调用接口传入的详细参数，请参见 YunApiParam。

3. 输出参数

名称
类型
描述
reqId
String
公共参数，标示请求序列，与入参相同。
error
String
状态码,为空表示正确。
error_message
String
错误详细说明，为空表示正确。
data
Object
心跳接口的服务器回包，请参见 HeartBeatData。

4. 示例

输入示例 （发送前需将数据转换为 json 字符串）

ws.send(JSON.stringify({
    "action":"YunApi",
    "reqId":"req0001",
    "params":{
        "Action": "AppDeviceTraceHeartBeat",
        "ActionParams": {
            "DeviceIds": ["产品ID/DeviceName","产品ID/DeviceName"],
            "AccessToken": "f6******************3aad",
            "RequestId":"rest-client"
        }
    }
}))
输出示例：成功
{
    "error":"",
    "error_message":"",
    "data":{
        "Response": {
            "RequestId":"rest-client"
        }
    },
    "reqId":"req0001"
}
输出示例：失败（服务器错误）
{
    "error":"-1",
    "error_message":"后台连接出错，请联系管理员",
    "data":{},
    "reqId":"req0001"
}
输出示例：失败（逻辑错误）
{
    "error":"",
    "error_message":"",
    "data":{
        "Response": {
            "Error":{
                "Code": "UnauthorizedOperation.APPNoPermissionToStudioProduct",
                "Message": "App对操作该产品无权限"
            },
            "RequestId":"rest-client"
        }
    },
    "reqId":"req0001"
}

中国站