Pushing Device Service Information Change Notifications

Typical Scenario

After an NA subscribes to device service information change notifications (the notification type is serviceInfoChanged) on the IoT platform, the IoT platform sends a notification message to the NA when the IoT platform delivers a command to the device to modify the device service information.

API Function

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

Note

1. When subscribing to platform service data, an NA must subscribe to the specified callback address in the API description. The server and port in the callback address are the public IP address and specified port of the NA.

2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.

3. If the callback address is not the address of the NA, the NA must implement the original callback API. For details on the API content, see Message Push in the Huawei IoT Platform Northbound API Reference.

API Description

Callback URL	https://server:port/v1.0.0/messageReceiver
Callback API	void handleServiceInfoChanged(NotifyServiceInfoChangedDTO body)
Class	PushMessageReceiver

Parameter Description

NotifyServiceInfoChangedDTO structure

Parameter	Mandatory or Optional	Type	Location	Description
notifyType	Mandatory	Enum	body	Indicates the notification type. The value is serviceInfoChanged.
deviceId	Mandatory	String	body	Identifies a device.
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 a non-directly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates.
serviceId	Mandatory	String	body	Identifies a service.
serviceType	Mandatory	String	body	Indicates the service type.
serviceInfo	Mandatory	ServiceInfo	body	Indicates the masked device service information, which is incrementally reported. For details, see ServiceInfo structure.

ServiceInfo structure

Parameter	Mandatory or Optional	Type	Location	Description
muteCmds	Optional	List<String>	body	Indicates the device command list.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"serviceInfoChanged",
    "deviceId":"*******",
    "serviceId":"*******",
    "serviceType":"*******",
    "gatewayId":"*******",
    "serviceInfo":{
        "muteCmds":"VIDEO_RECORD"
    }
}