Pushing a Message Acknowledgment Notification
Typical Scenario
After an application subscribes to acknowledgment notifications (the notification type is messageConfirm) on the platform, the platform sends a notification to the application when the 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 platform to push notifications to an application that has subscribed to acknowledgment notifications.
Note
1. When subscribing to platform service data, an application must subscribe to the specified callback URL in the API description. The server and port in the callback URL are the public IP address and specified port of the application.
2. An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.
3. If the callback URL is not the address of the application, the application must implement the original callback API. For details on the API content, see Message Push in the Northbound API Reference.
API Description
| Callback URL | https://server:port/v1.0.0/messageReceiver |
|---|---|
| Callback API | void handleMessageConfirm(NotifyMessageConfirmDTO body) |
| Class | PushMessageReceiver |
Parameter Description
NotifyMessageConfirmDTO structure
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| notifyType | Mandatory | String | header | Indicates the notification type. The value is messageConfirm. |
| header | Mandatory | MessageConfirmHeader | header | For details, see MessageConfirmHeader structure. |
| body | Mandatory | ObjectNode | body | Based on the service definition, an acknowledgment message can carry information such as status change. |
MessageConfirmHeader 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.
|
| 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 application. |
| status | Mandatory | String(1-32) | body | Indicates the command status.
|
| 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": {
}
} Normal Response Example
Response: Status Code: 200 OK
Last Article: Pushing a Device Deletion Notification
Next Article: Pushing a Device Command Response Notification
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.