Pushing a Device Service Information Change Notification
Typical Scenario
After an application subscribes to device service information change notifications (the notification type is serviceInfoChanged) on the platform, the platform sends a notification to the application when the platform delivers a command to the device to modify the device service information.
API Function
This API is used by the platform to push notifications to an application that has subscribed to device service information change notifications.
Note
- When Subscribing to Device 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 server.
- An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.
- If the callback URL is not the address of the application server, 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 | def handleServiceInfoChanged(self) |
| Class | PushMessageReceiver |
Parameter Description
The input parameter is request.json.
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| nsicDTO | Mandatory | NotifyServiceInfoChangedDTO | body | For details, see NotifyServiceInfoChangedDTO structure. |
NotifyServiceInfoChangedDTO structure
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| notifyType | Mandatory | Enum | body | Indicates the notification type. The value is serviceInfoChanged. |
| deviceId | Mandatory | String | body | Uniquely identifies a device. |
| gatewayId | Mandatory | String | body | Uniquely identifies a gateway. |
| serviceId | Mandatory | String | body | Identifies a service. |
| serviceType | Mandatory | String | body | Indicates the service type. |
| serviceInfo | Mandatory | ServiceInfo | body | Indicates the device service information, which is incrementally reported. For details, see ServiceInfo structure. |
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| muteCmds | Optional | List<String> | body | Indicates the device command list. |
Response Parameters
Status Code: 200 OK
Request Example
Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
"notifyType":"serviceInfoChanged",
"deviceId":"*******",
"serviceId":"*******",
"serviceType":"*******",
"gatewayId":"*******",
"serviceInfo":{
"muteCmds":"VIDEO_RECORD"
}
} Normal Response Example
response: Status Code: 200 OK
Last Article: Pushing Batch Device Data Change Notifications
Next Article: Pushing a Device Deletion Notification
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.