Help Center > > API Reference> Northbound PHP SDK API Reference> Service API List> Message Push> Pushing Device Command Response Notifications

Pushing Device Command Response Notifications

Updated at: Aug 28, 2019 GMT+08:00

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 platform service data, 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.
  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

function handleCommandRsp(NotifyCommandRspDTO $body)

Class

PushMessageReceiver

Parameter Description

NotifyCommandRspDTO structure

Parameter

Mandatory or Optional

Location

Description

$notifyType

Mandatory

body

Indicates the notification type. The value is commandRsp.

$header

Mandatory

body

For details, see CommandRspHeader structure.

$body

Mandatory

body

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

CommandRspHeader structure

Parameter

Mandatory or Optional

Location

Description

$requestId

Mandatory

body

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

$from

Mandatory

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

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

body

Identifies a device.

$serviceType

Mandatory

body

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

$method

Mandatory

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?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

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