设备事件上报

更新时间:2023-06-15 05:35:07

本文介绍设备事件上报的 API。

接口描述

设备事件上报,是指设备上报的瞬时通知消息。消息可以包含多个输出参数,需要被外部感知和处理。

接口地址

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

请求参数

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

body 说明

参数名类型参数位置是否必填说明
msg_idStringbodytrue本次请求的唯⼀标识,⻓度不超过 32 个字符。
dataObjectbodytrue事件输出参数。

data 说明

参数名类型参数位置是否必填说明
event_codeStringbodytrue事件 code,功能标识符。
event_timeLongbodytrue事件发⽣时间,13 位标准时间戳。
output_paramsObjectbodyfalse事件输出参数。

返回参数

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

请求示例

POST: /v1.0/iot-03/3rdcloud/devices/6cf4171005d11e2ca7****/event/report
{
  "msg_id": "ed23rty159292****",
  "data": {
    "event_code": "read_face",
    "event_time": 1592920221212,
    "output_params": {
      "sex": "man",
      "age": 23
    }
  }
}

返回示例

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

错误码

参考 错误码