Adding Members to a Device Group

Typical Scenario

An NA 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 for querying information about a specified device group.

API Function

This API is used by an NA to add devices to a specified device group on the IoT platform.

API Prototype

Method	POST
URL	https://server:port/iocm/app/dm/v1.1.0/devices/addDevGroupTagToDevices?accessAppId={accessAppId}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
accessAppId	Optional	String	query	This parameter must be specified when you want to add members to a device group under an authorized application. Set this parameter to the ID of the authorized application.
devGroupId	Mandatory	String(1-50)	body	Identifies a device group. The value of this parameter is returned by the IoT 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

Status Code: 200 OK

Parameter	Type	Description
devGroupId	String(1-50)	Identifies a device group.
deviceIds	List<String>	Identifies the devices to be added to the device group.

Request Example

Method: POST
Request:
https://server:port/iocm/app/dm/v1.1.0/devices/addDevGroupTagToDevices?accessAppId={accessAppId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
Body:
{
  "devGroupId": "******",
  "deviceIds": [
    "********",
    "********",
    "********"
  ]
}

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "devGroupId": "******",
  "deviceIds": [
    "********",
    "********",
    "********"
  ]
}

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
200	100601	The number of device in the group has reach the max.	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 is not existed.	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: Check whether deviceId carried in the API request is correct. Check whether the number of devices in the device group reaches the upper limit.
400	50400	The input is invalid.	An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid.
403	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
403	100217	The application hasn't 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	app throttle exceed.	The NA 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	App_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
500	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
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.