Pushing Device Registration Notifications

Typical Scenario

After an NA subscribes to device registration notifications (the notification type is deviceAdded) on the IoT platform, the IoT platform sends a notification message to the NA when the NA registers a device on the IoT platform by calling the Registering Devices API.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to device registration 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 deviceAdded.
deviceId	Mandatory	String	body	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
gatewayId	Optional	String	body	Identifies a gateway. The gateway ID is the same as the device ID if the device is a directly connected device. If the device is an indirectly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates.
nodeType	Mandatory	String	body	Indicates the device type. ENDPOINT GATEWAY UNKNOWN
deviceInfo	Mandatory	DeviceInfo	body	Indicates information about the device. For details, see DeviceInfo structure.

DeviceInfo structure

Parameter	Mandatory or Optional	Type	Location	Description
nodeId	Mandatory	String(256)	body	Uniquely identifies a device. Generally, the MAC address, serial number, or IMEI is used as the node ID. NOTE: When the IMEI is used as the node ID, the node ID varies depending on the chipset provided by the manufacturer. The unique identifier of a Qualcomm chip is urn:imei:xxxx, where xxxx is the IMEI. The unique identifier of a HiSilicon chip is the IMEI. For details about the unique identifiers of chipsets provided by other manufacturers, contact the manufacturers.
name	Optional	String(256)	body	Indicates the device name.
description	Optional	String(2048)	body	Indicates the device description.
manufacturerId	Optional	String(256)	body	Uniquely identifies a manufacturer.
manufacturerName	Optional	String(256)	body	Indicates the manufacturer name.
mac	Optional	String(256)	body	Indicates the MAC address of the device.
location	Optional	String(2048)	body	Indicates the device location.
deviceType	Optional	String(256)	body	Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway.
model	Optional	String(256)	body	Indicates the device model.
swVersion	Optional	String(256)	body	Indicates the software version of the device.
fwVersion	Optional	String(256)	body	Indicates the firmware version of the device.
hwVersion	Optional	String(256)	body	Indicates the hardware version of the device.
protocolType	Optional	String(256)	body	Indicates the protocol used by the device.
bridgeId	Optional	String(256)	body	Identifies the bridge through which the device accesses the IoT platform.
status	Optional	String	body	Indicates whether the device is online. The value options are ONLINE, OFFLINE, INACTIVE, and ABNORMAL. Before the device is connected to the IoT platform for the first time, the device is in the INACTIVE state. If the device does not report data or send messages to the IoT platform within 25 hours (default value), the device status is ABNORMAL (default value). If the device does not report data or send messages to the IoT platform within 49 hours, the device is in the OFFLINE state.
statusDetail	Optional	String(256)	body	Indicates the device status details, which vary according to the value of status. When status is ONLINE, the value can be NONE, CONFIGURATION_PENDING, UE_REACHABILITY, or AVAILABILITY_AFTER_DDN_FAILURE. When status is OFFLINE, the value can be NONE, COMMUNICATION_ERROR, CONFIGURATION_ERROR, BRIDGE_OFFLINE, FIRMWARE_UPDATING, DUTY_CYCLE, NOT_ACTIVE, LOSS_OF_CONNECTIVITY, or TIME_OUT. When status is INACTIVE, the value can be NONE or NOT_ACTIVE.
mute	Optional	String	body	Indicates whether the device is in the frozen state. Based on the value of this parameter, the IoT platform determines whether to manage and store data reported by the device. TRUE: The device is in the frozen state. FALSE: The device is not in the frozen state.
supportedSecurity	Optional	String	body	Indicates whether the security mode is supported. TRUE: The security mode is supported. FALSE: The security mode is not supported.
isSecurity	Optional	String	body	Indicates whether the security mode is enabled. TRUE: The security mode is enabled. FALSE: The security mode is disabled.
signalStrength	Optional	String(256)	body	Indicates the signal strength of the device.
sigVersion	Optional	String(256)	body	Indicates the SIG version of the device.
serialNumber	Optional	String(256)	body	Indicates the serial number of the device.
batteryLevel	Optional	String(256)	body	Indicates the battery level of the device.

NOTE:

When the device status information is reported over the southbound API, status and statusDetail must be included at the same time. In addition, it is recommended that statusDetail not be used for logical determination.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type: application/json
Body:
{
  "notifyType": "deviceAdded",
  "deviceId": "*****",
  "gatewayId": "*****",
  "nodeType": "GATEWAY",
  "deviceInfo": {
    "nodeId": "******",
    "name": null,
    "description": null,
    "manufacturerId": null,
    "manufacturerName": null,
    "mac": null,
    "location": null,
    "deviceType": null,
    "model": null,
    "swVersion": null,
    "fwVersion": null,
    "hwVersion": null,
    "protocolType": null,
    "bridgeId": null,
    "status": "OFFLINE",
    "statusDetail": "NOT_ACTIVE",
    "mute": null,
    "supportedSecurity": null,
    "isSecurity": null,
    "signalStrength": null,
    "sigVersion": null,
    "serialNumber": null,
    "batteryLevel": null
  }
}