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 Device 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 server.
  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 server, 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

def handleDeviceDeleted(self)

Class

PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter

Mandatory or Optional

Type

Location

Description

nddDTO

Mandatory

NotifyDeviceDeletedDTO

body

For details, see NotifyDeviceDeletedDTO structure.

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

Uniquely identifies a device.

gatewayId

Mandatory

String

body

Uniquely identifies a gateway.

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