Pushing Command Status Change Notifications

Typical Scenario

When an NA creates a device command with the callback URL specified, the IoT platform pushes a notification message to the NA if the command status changes (failed, successful, timeout, sent, or delivered).

API Function

The IoT platform pushes notification messages to NAs when the command status changes.

Note

The NA must return a response code after receiving a message pushed by the IoT platform.

API Prototype

Method	POST
URL	The URL is determined by callbackUrl in the command request sent by the NA.
Transport Protocol	HTTPS/HTTP

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
deviceId	Mandatory	String	body	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
commandId	Mandatory	string	body	Uniquely identifies a device command. The value of this parameter is allocated by the IoT platform during command delivery.
result	Mandatory	CommandResultForDevice	body	Indicates the command status information. For details, see the CommandResultForDevice structure.

CommandResultForDevice structure

Parameter	Mandatory or Optional	Type	Location	Description
resultCode	Mandatory	String	body	Indicates the command status.
resultDetail	Mandatory	ObjectNode	body	Indicates the detailed information about the command output.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request:
Header:
Content-Type: application/json
Body:
{
  "deviceId": "92d3f8da-200a-4143-8d0d-591a7e11de6c",
  "commandId": "108a9c71462a48e09426e06e844d47ba",
  "result": {
    "resultCode": "SENT",
    "resultDetail": null
  }
}