Push a Device Deletion Notification
Function
This API is used by the platform to push a device deletion notification to an application after the application calls the APIs for Creating A Rule Triggering Condition (resource is set to device and event to delete), Creating A Rule Action, and Modifying a Rule Triggering Condition to configure and activate a rule.
Precautions
The application must send a response code after receiving a message pushed by the platform.
URI
Request Method |
POST |
---|---|
URI |
HTTP URL determined when the application creates the device deletion notification rule. The AMQP channel does not require the URL. |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
resource |
Yes |
String |
Body |
Subscribed resource name. Set this parameter to device. |
event |
Yes |
String |
Body |
Subscribed event. Set this parameter to delete. |
event_time |
Yes |
String |
Body |
UTC time when the resource event was generated. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z. If necessary, convert the time to display in the local time zone format. |
event_time_ms |
No |
String |
Body |
Time when a resource event is generated. The value is a UTC character string in the format of yyyy-MM-dd'T'HH:mm:ss.SSS'Z', for example, 2015-12-12T12:12:12.000Z. If necessary, convert the time to display in the local time zone format. |
request_id |
No |
String |
Body |
Message ID which is specified by the device or generated by the platform and is used to trace the service process. |
notify_data |
Yes |
DeviceDeleteNotifyData Object |
Body |
Message to push. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
header |
Yes |
NotifyDataHeader Object |
Message header. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
app_id |
No |
String |
Application ID. |
device_id |
No |
String |
Device ID. The ID is unique and is allocated by the platform during device registration. |
node_id |
No |
String |
Device identifier. This parameter is set to the IMEI, MAC address, or serial number. |
product_id |
No |
String |
Product ID. The ID is unique and is allocated by the platform during product registration. |
gateway_id |
No |
String |
Unique gateway ID. 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. |
Example Request
POST https://{Endpoint} HTTP URL determined when the application creates the device deletion notification rule. The AMQP channel does not require the URL. Content-Type: application/json { "resource" : "device", "event" : "delete", "event_time" : "20151212T121212Z", "event_time_ms" : "2015-12-12T12:12:12.000Z", "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776", "notify_data" : { "header" : { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "product_id" : "ABC123456789", "app_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "tags" : [ { "tag_value" : "testTagValue", "tag_key" : "testTagName" } ] } } }
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