Pushing Device Model Deletion Notifications
Typical Scenario
After an NA subscribes to device model deletion notifications (the notification type is deviceModelDeleted) on the IoT platform, the IoT platform sends a notification message to the NA when a device profile file is deleted from the IoT platform.
API Function
This API is used by the IoT platform to push notification messages to an NA that has subscribed to device model deletion notifications.
Note
- 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.
- An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
- 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 |
function handleDeviceModelDeleted(NotifyDeviceModelDeletedDTO body) |
Class |
PushMessageReceiver |
Parameter Description
NotifyDeviceModelDeletedDTO structure
Parameter |
Mandatory or Optional |
Location |
Description |
---|---|---|---|
$notifyType |
Mandatory |
body |
Indicates the notification type. The value is deviceModelDeleted. |
$appId |
Mandatory |
body |
Uniquely identifies an NA. This parameter is used to identify an NA that can call open APIs provided by the IoT platform. |
$deviceType |
Mandatory |
body |
Indicates the device type. |
$manufacturerName |
Mandatory |
body |
Indicates the operator name. |
$manufacturerId |
Mandatory |
body |
Identifies the operator. |
$model |
Mandatory |
body |
Indicates the device model. |
$protocolType |
Mandatory |
body |
Indicates the protocol type used by the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M. |
Response Parameters
Status Code: 200 OK
Request Example
Method: POST Request: {callbackUrl} Header: Content-Type:application/json Body: { "notifyType":"deviceModelAdded", "appId":"*****", "deviceTyp ":"*************", " manufacturerName":"*************", "manufacturerId ":"*************", "model":"*************", "protocolType":"*************" }
Response Example
Response: Status Code: 200 OK
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot