文档首页/ 智能设施云平台/ API参考/ API列表/ 流转数据通知结构体定义/ 设备事件上报通知
更新时间：2025-08-19 GMT+08:00
查看PDF
分享

设备事件上报通知

功能介绍

应用服务器在调用设施云平台的创建规则触发条件（Resource:device.event，Event:report）、创建规则动作、修改规则触发条件接口配置并激活规则后，当设施云平台添加空间时，设施云平台会向应用服务器推送通知消息。

URI

POST /应用服务器创建设备事件上报通知规则时的Url决定

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

resource

是

String

参数说明：订阅的资源名称。

取值范围：device.event。

event

是

String

参数说明：订阅的资源事件。

取值范围：report。

event_time

是

String

参数说明：资源事件生成时间。

取值范围：yyyyMMdd'T'HHmmss'Z' UTC字符串，如：20151212T121212Z。若需要显示本地时区，您需要自己进行时间转换。

request_id

否

String

参数说明：消息ID，由设备侧指定或平台生成，用于跟踪业务流程。

notify_data

是

DeviceEventReportNotifyData object

参数说明：设备的自定义字段列表。
表2 DeviceEventReportNotifyData

参数

是否必选

参数类型

描述

header

是

NotifyDataHeader object

参数说明：推送消息header。

body

是

DeviceEventReport object

参数说明：推送消息body。
表3 NotifyDataHeader

参数

是否必选

参数类型

描述

app_id

否

String

参数说明：应用ID。

取值范围：长度不超过265的字符串。

device_id

否

String

参数说明：设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。

取值范围：长度不超过265的字符串。

node_id

否

String

参数说明：设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。

取值范围：长度不超过265的字符串。

product_id

否

String

参数说明：产品ID，用于唯一标识一个产品，在注册产品时由物联网平台分配获得。

取值范围：长度不超过265的字符串。

gateway_id

否

String

参数说明：网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。

取值范围：长度不超过265的字符串。

tags

否

Array of TagDTO objects

参数说明：要绑定到指定资源的标签列表，标签列表中各项标签键值之间不允许重复，一个资源最多可以绑定10个标签。
表4 TagDTO

参数

是否必选

参数类型

描述

tag_key

是

String

参数说明：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。

tag_value

否

String

参数说明：标签值。
表5 DeviceEventReport

参数

是否必选

参数类型

描述

services

是

Array of DeviceServiceEvent objects

参数说明：事件内容。
表6 DeviceServiceEvent

参数

是否必选

参数类型

描述

service_id

是

String

参数说明：服务ID, 在设备关联的产品模型中定义。

event_type

是

String

参数说明：事件类型, 在设备关联的产品模型中定义。

event_time

否

String

参数说明：推送时间, 时间格式为:yyyyMMdd'T'HHmmss'Z', 如：20151212T121212Z。

paras

否

Object

参数说明：事件参数, 由用户自己定义。

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

-

String

-

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数说明：错误码。

取值范围：长度8-36。

error_msg

String

参数说明：错误描述。

取值范围：长度2-512。

请求示例

{
  "resource" : "device.event",
  "event" : "report",
  "event_time" : "20151212T121212Z,",
  "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776",
  "notify_data" : {
    "header" : {
      "app_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
      "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
      "node_id" : "ABC123456789",
      "product_id" : "ABC123456789",
      "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
      "tags" : [ {
        "tag_key" : "testTagName",
        "tag_value" : "testTagValue"
      } ]
    },
    "body" : {
      "services" : [ {
        "service_id" : "temp",
        "event_type" : "event_type",
        "event_time" : "20151212T121212Z",
        "paras" : "params"
      } ]
    }
  }
}

响应示例

状态码：200

OK

{
  "result" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

相关文档