Updated on 2022-02-24 GMT+08:00

Pushing Device Data Change Notifications

Typical Scenario

After an NA subscribes to device data change notifications (the notification type is deviceDataChanged) on the IoT platform, the IoT platform sends a notification message to the NA when the device reports data of a single service attribute.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to device data change notifications.

Note

The NA must return a response code after receiving a message pushed by the IoT platform.

API Prototype

Method

POST

URL

The URL is determined by callbackUrl in the subscription request sent by the NA.

Transport Protocol

HTTPS/HTTP

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is deviceDataChanged.

requestId

Optional

String(1-128)

body

Indicates the sequence number of the message, which uniquely identifies the message.

deviceId

Mandatory

String

body

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.

gatewayId

Mandatory

String

body

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.

service

Mandatory

DeviceServiceData

body

Indicates service data of the device. For details, see DeviceServiceData structure.

DeviceServiceData structure

Parameter

Mandatory or Optional

Type

Location

Description

serviceId

Mandatory

String

body

Identifies a service.

serviceType

Mandatory

String

body

Indicates the service type.

data

Mandatory

ObjectNode

body

Indicates service data information.

eventTime

Mandatory

String

body

Indicates the time when an event occurs. The value is in the format of yyyymmddThhmmssZ. An example value is 20151212T121212Z.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type: application/json
Body:
{
  "notifyType": "deviceDataChanged",
  "requestId": "*************",
  "deviceId": "********************************",
  "gatewayId": "*************",
  "service": {
    "serviceId": "Brightness",
    "serviceType": "Brightness",
    "data": {
      "brightness": 80
    },
    "eventTime": "20170311T163657Z"
  }
}

Response Example

Response:
Status Code: 200 OK