IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Help Center> IoT> API Reference> Northbound Python SDK API Reference> Service API List> Message Push> NB-IoT Device Command Status Change Notification
Updated at: Feb 24, 2022 GMT+08:00

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

  1. 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.
  2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
  3. 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.

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"
    }
}

Response Example

response:
Status Code: 200 OK

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel