Cloud Services API ReferenceIoT CoreDevice GroupCreate Group

Create Group

Last Updated on : 2023-11-23 06:24:48download

Create a Wi-Fi group. The group shall be a collection of devices in the same category and the same space.

API address

POST: /v2.0/cloud/thing/group

Request parameter

Description of body

Parameter name	Type	IN	Required	Description
space_id	String	body	true	The ID of the specified space.
name	String	body	true	The name of the specified group.
product_id	String	body	true	The product ID (PID).
device_ids	String	body	true	The list of up to 20 device IDs, separated with commas (,).

Return parameter

Parameter name	Type	Description
result	DeviceGroupCloudDTO	The returned result of the specified group.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
t	Boolean	The timestamp.
tid	Boolean	The link ID.

Description of result

Parameter name	Type	Description
id	Long	The ID of the specified group.
name	String	The name of the specified group.
pv	String	The version number of the specified MQTT protocol.
time	Long	The time when a group is created.
type	Integer	The type of the specified group. Valid values: `0`: Devices that can be directly connected to the cloud. `1`：Devices that cannot be directly connected to the cloud, but can only be connected to the cloud through gateways.
uid	String	The ID of a user in the specified group.
group_type	Integer	The protocol type applicable to the specified group. Valid values: `0`: Wi-Fi `1`: Bluetooth low energy `2`: Zigbee `3`: Bluetooth mesh
icon_url	String	The picture of the specified group. A product picture is used by default. Currently, you cannot change the product picture.
local_key	String	The `localKey` used for the MQTT connection.
owner_id	String	The ID of the space to which the specified group belongs.
product_id	String	The ID of a product in the group.

Request example

POST: /v2.0/cloud/thing/group

{
  "space_id": "25129******",
  "name": "Test Group**",
  "product_id": "dsadhsjkh2***",
  "device_ids": "dshajhdkhaj***,hsdkajhkk***"
}

Return example

{
    "tid": "22b76e4eb71211edabe5e6670becb070",
    "result": {
        "local_key": "93fda9e167da***",
        "pv": "2.2",
        "group_type": 0,
        "type": 0,
        "product_id": "fqi9xqldl****",
        "name": "测***",
        "id": 1286611,
        "time": 1677552405152
    },
    "t": 1677552405220,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocDevice Group

Next DocDelete Group