Pushing a Device Deletion Notification

Typical Scenario

After an application subscribes to device deletion notifications (the notification type is deviceDeleted) on the platform, the platform sends a notification to the application when the device is deleted from the platform.

API Function

This API is used by the platform to push notifications to an application that has subscribed to device deletion notifications.

Note

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

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

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

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

void handleDeviceDeleted(NotifyDeviceDeletedDTO body)

Class

PushMessageReceiver

Parameter Description

NotifyDeviceDeletedDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is deviceDeleted.

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 an indirectly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"deviceDeleted",
    "deviceId":"********************************",
    "gatewayId":"*************"
}

Normal Response Example

Response:
Status Code: 200 OK