Push a Device Message Reporting Notification

Function

After the application calls the API for creating a rule triggering condition (resource is set to device.message and event to report), the API for creating a rule action, and the API for modifying a rule triggering condition, and activates a rule, the platform pushes the result to the server specified by the rule when a device reports message data.

URI

POST /HTTP URL determined when the application creates the device message reporting notification rule. The AMQP channel does not require the URL.

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
resource	Yes	String	Parameter description: subscribed resource name. Set this parameter to device.message.
event	Yes	String	Parameter description: Subscribed resource event. Set this parameter to report.
event_time	Yes	String	Parameter description: UTC time when the resource event was generated. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z. If necessary, convert the time to display in the local time zone format.
event_time_ms	No	String	Parameter description: UTC time when a resource event was generated. The value in the format of yyyy-MM-dd'T'HH:mm:ss.SSS'Z', for example, 2015-12-12T12:12:12.000Z. If necessary, convert the time to display in the local time zone format.
request_id	No	String	Parameter description: message ID, which is specified by the device or generated by the platform, and is used to trace the service process.
notify_data	Yes	DeviceMessageReportNotifyData object	Parameter description: custom field list of the device.

**Table 2** DeviceMessageReportNotifyData
Parameter	Mandatory	Type	Description
header	Yes	NotifyDataHeader object	Parameter description: message header.
body	Yes	DeviceMessageReport object	Parameter description: message body.

**Table 3** NotifyDataHeader
Parameter	Mandatory	Type	Description
app_id	No	String	Parameter description: application ID. Maximum: 256
device_id	No	String	Parameter description: unique device ID, which is allocated by IoTDA during device registration. Maximum: 256
node_id	No	String	Parameter description: device node ID. This parameter is set to the IMEI, MAC address, or serial number. Maximum: 256
product_id	No	String	Parameter description: unique product ID, which is allocated by the platform during product registration. Maximum: 256
gateway_id	No	String	Parameter description: gateway ID, which uniquely identifies a gateway. The gateway ID is the same as the device ID if the device is a directly connected device. If the device is an indirectly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates. Maximum: 256
tags	No	Array of TagV5DTO objects	Parameter description: list of tags to be bound to a specific resource. Each tag key must be unique in the tag list. Up to 10 tags can be bound to a resource.

**Table 4** TagV5DTO
Parameter	Mandatory	Type	Description
tag_key	Yes	String	Parameter description: tag key, which is unique for a resource. If the specified key already exists, the value of the existing tag is overwritten. If the specified key does not exist, a new tag is added.
tag_value	No	String	Parameter description: tag value.

**Table 5** DeviceMessageReport
Parameter	Mandatory	Type	Description
topic	Yes	String	Parameter description: MQTT topic used for device reporting.
content	Yes	Object	Parameter description: message content.
properties	No	MqttPropertiesDTO object	Parameter description: property information carried by the device.

**Table 6** MqttPropertiesDTO
Parameter	Mandatory	Type	Description
correlation_data	No	String	Parameter description: data in the request and response modes of MQTT 5.0. This parameter is optional. Devices can use this parameter to configure data in the request and response modes of MQTT. Maximum: 128
response_topic	No	String	Parameter description: response topic in the request and response modes of MQTT 5.0. This parameter is optional. Devices can use this parameter to configure response topic in the request and response modes of MQTT. Maximum: 128
content_type	No	String	Parameter description: content type of the MQTT 5.0 payload. This parameter is optional. Devices can use this parameter to configure the content type of the MQTT payload. Maximum: 128
user_properties	No	Array of UserPropDTO objects	Parameter description: custom property. This parameter is optional. Devices can use this parameter to configure custom properties.

**Table 7** UserPropDTO
Parameter	Mandatory	Type	Description
prop_key	No	String	Parameter description: key of the custom property. Maximum: 128
prop_value	No	String	Parameter description: value of the custom property. Maximum: 128

Response Parameters

None

Example Requests

Example of a device message reporting notification.

Device message reporting notification.

{
  "resource" : "device.message",
  "event" : "report",
  "event_time" : "20151212T121212Z",
  "event_time_ms" : "2015-12-12T12:12:12.000Z",
  "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776",
  "notify_data" : {
    "header" : {
      "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
      "product_id" : "ABC123456789",
      "app_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
      "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
      "node_id" : "ABC123456789",
      "tags" : [ {
        "tag_value" : "testTagValue",
        "tag_key" : "testTagName"
      } ]
    }
  },
  "body" : {
    "topic" : "topic",
    "content" : "msg",
    "properties" : {
      "response_topic" : "/device/message/response",
      "content_type" : "text/plain",
      "user_properties" : [ {
        "prop_value" : "propValue1",
        "prop_key" : "propKey1"
      } ],
      "correlation_data" : "messageName"
    }
  }
}