Adding Members to a Device Group
Typical Scenario
An application can call this API to add a new device or an existing device to a specified device group. Before adding a device to a device group, you are advised to query the current number of devices and the maximum number of devices allowed in the device group by calling the API Querying Details of a Device Group.
API Function
This API is used by an application to add devices to a specified device group on the platform.
API Description
1 | DeviceGroupWithDeviceListDTO addDevicesToGroup(DeviceGroupWithDeviceListDTO dgwdlDTO, String accessAppId, String accessToken) throws NorthApiException
|
Parameter Description
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| dgwdlDTO | Mandatory | DeviceGroupWithDeviceListDTO structure | body | For details, see DeviceGroupWithDeviceListDTO structure. |
| accessAppId | Optional | String | query | If the device group belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application. |
| accessToken | Mandatory | String | header | If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API. |
DeviceGroupWithDeviceListDTO structure
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| devGroupId | Mandatory | String(1-50) | body | Identifies a device group. The value of this parameter is returned by the platform after the device group is added. |
| deviceIds | Mandatory | List<String>(1000) | body | Identifies the devices to be added to the device group. |
Response Parameters
DeviceGroupWithDeviceListDTO structure
| Parameter | Type | Description |
|---|---|---|
| devGroupId | String(1-50) | Identifies a device group. |
| deviceIds | List<String> | Identifies the devices to be added to the device group. |
Error Codes
| HTTP Status Code | Error Code | Error Description | Remarks |
|---|---|---|---|
| 200 | 100601 | The number of devices in the group has reached the upper limit. | The number of devices in the device group reaches the upper limit. Recommended handling: Ensure that the number of devices in the device group is within the range specified by maxDevNum. |
| 200 | 100603 | The device group does not exist. | The device group does not exist. Recommended handling: Check whether the device group ID is correct. |
| 400 | 100604 | The device group request parameter is invalid. | The request message contains invalid parameters. Recommended handling:
|
| 400 | 50400 | An input parameter is invalid. | An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid. |
| 403 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 403 | 100217 | The application has not been authorized. | The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null. |
| 403 | 1010009 | The application calls the API at a frequency that exceeds the flow control threshold. | The application calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency. |
| 403 | 1010005 | Invalid access token or application ID. | The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct. |
| 500 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 500 | 50252 | Internal server error. | An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel. |
Last Article: Querying Members in a Device Group
Next Article: Deleting Members from a Device Group
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.