Help Center > > API Reference> Northbound API Reference> Subscription Management> Push Notification> Pushing Device Acknowledgment Notifications

Pushing Device Acknowledgment Notifications

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

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

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 acknowledgment 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 messageConfirm.

header

Mandatory

Header

body

For details, see the description of the Header field.

body

Mandatory

ObjectNode

body

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

Description of the header field:

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.

status

Mandatory

String(1-32)

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

String(1-32)

body

Indicates the timestamp. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 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

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