NB-IoT Device Command Status Change Notification
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.
- 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, the NA must implement the original callback API.
API Description
Callback URL |
https://server:port/v1.0.0/messageReceiver/cmd |
---|---|
Callback API |
function handleNBCommandStateChanged(NotifyNBCommandStatusChangedDTO $body) |
Class |
PushMessageReceiver |
Parameter Description
NotifyNBCommandStatusChangedDTO structure
Parameter |
Mandatory or Optional |
Location |
Description |
---|---|---|---|
$deviceId |
Mandatory |
body |
Uniquely identifies a device. |
$commandId |
Mandatory |
body |
Identifies a command, which is generated by the IoT platform during device creation. |
$result |
Mandatory |
body |
For details, see NBCommandResult structure. |
Parameter |
Mandatory or Optional |
Location |
Description |
---|---|---|---|
$resultCode |
Mandatory |
body |
Indicates the command status result.
|
$resultDetail |
Mandatory |
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":null } }
Response 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