Pushing a Device Model Addition Notification
Typical Scenario
After an application subscribes to device model addition notifications (the notification type is deviceModelAdded) on the platform, the platform sends a notification to the application when a device product model is added on the platform
API Function
This API is used by the platform to push notifications to an application that has subscribed to device model addition 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 handleDeviceModelAdded(self) |
| Class | PushMessageReceiver |
Parameter Description
The input parameter is request.json.
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| ndmaDTO | Mandatory | NotifyDeviceModelAddedDTO | body | For details, see NotifyDeviceModelAddedDTO structure. |
NotifyDeviceModelAddedDTO structure
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| notifyType | Mandatory | String | body | Indicates the notification type. The value is deviceModelAdded. |
| appId | Mandatory | String | body | Uniquely identifies an application. This parameter is used to identify an application that can call open APIs provided by the platform. |
| deviceType | Mandatory | String | body | Indicates the device type. |
| manufacturerName | Mandatory | String | body | Indicates the operator name. |
| manufacturerId | Mandatory | String | body | Identifies the operator. |
| model | Mandatory | String | body | Indicates the device model. |
| protocolType | Mandatory | String | body | Indicates the protocol used by the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M. |
Response Parameters
Status Code: 200 OK
Request Example
Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
"notifyType":"deviceModelAdded",
"appId":"*****",
"deviceType":"*************",
"manufacturerName":"wulian",
" manufacturerId ":"*************",
"model":"*************",
"protocolType":"zigbee"
} Normal Response Example
response: Status Code: 200 OK
Last Article: Pushing a Device Event Notification
Next Article: Pushing a Device Model Deletion Notification
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.