Updated at: 2022-02-24 GMT+08:00

Pushing Device Acknowledgment Notifications

Typical Scenario

After an NA subscribes to device acknowledgment notifications (the notification type is messageConfirm) 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 acknowledgment message (for example, the command is delivered or executed).

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to device acknowledgment 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 handleMessageConfirm(NotifyMessageConfirmDTO $body)

Class

PushMessageReceiver

Parameter Description

NotifyMessageConfirmDTO structure

Parameter

Mandatory or Optional

Location

Description

$notifyType

Mandatory

body

Indicates the notification type. The value is messageConfirm.

$header

Mandatory

body

For details, see MessageConfirmHeader structure.

$body

Mandatory

body

Based on the service definition, an acknowledgment message can carry information such as status change.

MessageConfirmHeader 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.

$status

Mandatory

body

Indicates the command status.

  • sent: The command has been sent.
  • delivered: The command has been received.
  • executed: The command has been executed.

$timestamp

Mandatory

body

Indicates the timestamp. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"messageConfirm",
    "header":{
        "requestId":"***********",
        "from":"***********",
        "to":"***********",
        "status":"delivered",
        "timestamp":"20151212T121212Z"
    },
    "body":{

    }
}

Response Example

Response:
Status Code: 200 OK
close