Updated at: 2022-02-24 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).

This API applies to devices that use MQTT, for example, devices that have integrated the AgentLite SDK.

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

The NA must return a response code after receiving a message pushed by the IoT platform.

API Prototype

Method

POST

URL

The URL is determined by callbackUrl in the subscription request sent by the NA.

Transport Protocol

HTTPS/HTTP

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is commandRsp.

header

Mandatory

Header

body

For details, see the description of the Header field.

body

Mandatory

ObjectNode

body

Indicates the content of a response message.

Header field description

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. The value of this parameter is allocated by the IoT platform during device registration.

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
close