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
Updated at: Feb 24, 2022 GMT+08:00

Pushing Device Command Response Notifications

Typical Scenario

After an NA subscribes to device command response notifications (the notification type is commandRsp) on the IoT platform, the IoT platform sends a notification message to the NA when the IoT platform delivers a command to the device and the device returns a command response message (for example, the command execution succeeds or fails).

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to device command response notifications.

Note

  1. When Subscribing to Service Data of the IoT Platform, 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, the NA must implement the original callback API. For details on the API content, see Message Push in the Huawei IoT Platform Northbound API Reference.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

def handleCommandRsp(self)

Class

PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter

Mandatory or Optional

Type

Location

Description

ncrDTO

Mandatory

NotifyCommandRspDTO

body

For details, see NotifyCommandRspDTO structure.

NotifyCommandRspDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is commandRsp.

header

Mandatory

CommandRspHeader

body

For details, see CommandRspHeader structure.

body

Mandatory

ObjectNode

body

Indicates the content of the message body of the response command.

CommandRspHeader structure

Parameter

Mandatory or Optional

Type

Location

Description

requestId

Mandatory

String(1-128)

body

Indicates the sequence number of the message, which uniquely identifies the message.

from

Mandatory

String(1-128)

body

Indicates the address of the message sender.

  • Request initiated by a device: /devices/{deviceId}
  • Request initiated by a device service: /devices/{deviceId}/services/{serviceId}

to

Mandatory

String(1-128)

body

Indicates the address of the message recipient. The value is that of from in the request, for example, the user ID of the NA.

deviceId

Mandatory

String

body

Uniquely identifies a device.

serviceType

Mandatory

String

body

Indicates the type of the service to which a command belongs.

method

Mandatory

String(1-128)

body

Indicates a stored response command, for example, INVITE-RSP.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"commandRsp",
    "header":{
        "requestId":"***********",
        "from":"***********",
        "to":"***********",
        "deviceId":"***********",
        "serviceType":"Camera",
        "method":"MUTE_COMMANDS"
    },
    "body":{

    }
}

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