NB-IoT Device Command Status Change Notification

Updated on 2022-02-24 GMT+08:00

View PDF

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

When Creating Device Commands, 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 server.
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 server, the NA must implement the original callback API.

API Description

Callback URL	https://server:port/v1.0.0/messageReceiver/cmd
Callback API	def handleNBCommandStateChanged(self)
Class	PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter	Mandatory or Optional	Type	Location	Description
nNBcscDTO	Mandatory	NotifyNBCommandStatusChangedDTO	body	For details, see NotifyNBCommandStatusChangedDTO structure.

NotifyNBCommandStatusChangedDTO structure

Parameter	Mandatory or Optional	Type	Location	Description
deviceId	Mandatory	String	body	Uniquely identifies a device.
commandId	Mandatory	String	body	Identifies a command, which is generated by the IoT platform during device creation.
result	Mandatory	NBCommandResult	body	For details, see NBCommandResult structure.

NBCommandResult structure

Parameter	Mandatory or Optional	Type	Location	Description
resultCode	Mandatory	String	body	Indicates the command status result. SENT: The IoT platform has delivered a command to the device but has not received a response from the device. DELIVERED: The IoT platform receives a response from a device. SUCCESS: The IoT platform receives a command result and the result is success. FAIL: The IoT platform receives a command result and the result is a failure.
resultDetail	Mandatory	ObjectNode	body	Indicates the user-defined fields carried in the command result.

Parameter

Mandatory or Optional

Type

Location

Description

resultCode

Mandatory

String

body

Indicates the command status result.

SENT: The IoT platform has delivered a command to the device but has not received a response from the device.
DELIVERED: The IoT platform receives a response from a device.
SUCCESS: The IoT platform receives a command result and the result is success.
FAIL: The IoT platform receives a command result and the result is a failure.

resultDetail

Mandatory

ObjectNode

body

Indicates the user-defined fields carried in the command result.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "deviceId":"*********",
    "commandId":"***********",
    "result":{
        "resultCode":"DELIVERED",
        "resultDetail":"None"
    }
}