Pushing an NB-IoT Device Command Status Change Notification
Typical Scenario
When an application creates a device command with the callback URL specified, the platform pushes a notification to the application if the command status changes (failed, successful, timeout, sent, or delivered).
API Function
The platform pushes notifications to applications when the command status changes.
Note
- When Creating a Device Command, 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.
- An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.
- If the callback URL is not the address of the application server, the application 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 platform during device creation. |
| result | Mandatory | NBCommandResult | body | For details, see NBCommandResult structure. |
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| resultCode | Mandatory | String | body | Indicates the command status result.
|
| 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"
}
} Normal Response Example
response: Status Code: 200 OK
Last Article: Pushing a Firmware Upgrade Result Notification
Next Article: Command Delivery
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.