设备动作响应上报

更新时间:2023-06-15 05:34:49

本文介绍设备动作响应上报的 API。

接口描述

根据设备 ID,上报指定设备对控制指令的响应。如果设备收到控制指令但是没有响应,则认为下发的控制指令执行失败。

接口地址

POST: /v1.0/iot-03/3rdcloud/devices/{device_id}/action-resp/report

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue涂鸦设备 ID。

body 说明

参数名类型参数位置是否必填说明
msg_idStringbodytrue下发动作指令的请求 ID,⻓度不超过 32 个字符。请求和响应消息通过该值建⽴关联关系。
codeIntegerbodyfalse下发动作请求响应 code,默认值为 0
  • 0:成功
  • 0:失败
dataObjectbodyfalse设备动作输出参数。

data 说明

参数名类型参数位置是否必填说明
action_codeStringbodyfalse动作 code,功能标识符。
output_paramsObjectbodyfalse动作执⾏的输出参数。

返回参数

参数名类型说明
resultBoolean响应结果。
codeString参见错误码,成功为空。
msgString请求失败的信息,成功为空。
successBoolean请求是否成功。
  • true:成功
  • false:失败
tLong请求响应的时间戳,长度 13 位。

请求示例

POST: /v1.0/iot-03/3rdcloud/devices/6cf4171005d11e2ca7****/action-resp/report
{
  "msg_id": "ed23rty159292****",
  "code": 0,
  "data": {
    "action_code": "turn_direction",
    "output_params": {
      "turn_left": 80,
      "turn_right": 30
    }
  }
}

返回示例

{
    "result": true,
    "t": 1650000809253,
    "success": true
}

错误码

参考 错误码