远程配置API

签名

远程配置API签名认证方式与API文档方式一致,具体请查阅API文档请求签名说明

推送配置接口

简要描述:

设备推送配置:单推、列表推、全产品推

请求URL:

/api/v1/configs/push

请求方式

POST

请求参数

{
    "productKey":"产品key",
    "deviceName":"设备名称",
    "desc":"配置描述",
    "timestamp":1573808199,
    "pushType":3,
    "groupId":"b2fa6081-9da7-4094-85a8-4e21ac9906a3",
    "isIncludeChildGroup":true,
    "config":{
    }
}

请求参数说明:

参数名 必选 类型 长度 说明
productKey string 产品key
deviceName string 设备名称;列表推时deviceName以Enter换行(即转义字符\r\n)分隔;一次最多推送1000个设备
desc string 配置描述
timestamp long 本次请求的unix时间戳(秒),用于确认请求的有效期。默认情况下,请求时间戳与服务器时间(北京时间)偏差大于600秒则会被拒绝
pushType int 0:单推 1:列表推 2:全产品推;列表推时一次最少一个设备,最多不超过1000个设备 3:群组推
groupId string 群组Id,pushType为3群组推时传递
isIncludeChildGroup bool 是否包含下属所有子组的设备,pushType为3群组推时传递,默认false不包含
config object 配置数据

返回参数

{
    "code":0,
    "message":"成功",
    "reqId":"请求id"
}

返回参数说明

参数名 类型 说明
code int 返回码
message string 返回信息
reqId string 请求id,即推送配置产生的pushId

当次配置结果状态查询接口

简要描述:

根据推送请求ID,查询当次配置推送的结果状态

请求URL:

/api/v1/configs/result?pushId=xxx

请求方式

GET

请求参数说明:

参数名 必选 类型 长度 说明
pushId string 推送配置push接口返回的reqId

返回参数

{
    "code":0,
    "message":"成功",
    "reqId":"请求Id",
    "data":{
        "total_product_device_num":xxx, // 产品设备总数
        "total_push_device_num":xxx, // 推送总设备数
        "push_down_device_num":xxx, // 下推设备数
        "update_ok_device_num":xxx, // 更新成功设备数
        "update_fail_device_num":xxx // 更新失败设备数
    }
}

返回参数说明

参数名 类型 说明
code int 返回码
message string 返回信息
reqId string 请求Id
data object 返回数据
total_product_device_num long 产品设备总数
total_push_device_num long 推送总设备数
push_down_device_num long 下推设备数
update_ok_device_num long 更新成功设备数
update_fail_device_num long 更新失败设备数

错误码

错误码 描述
0 请求成功
460 参数错误
500 服务端内部错误
601 产品或产品设备不存在
1001 用户未登录,请登录后重试

results matching ""

    No results matching ""