Create Device Group

Last Updated on : 2023-06-15 05:50:20

Create a device group based on the device ID set and group name. Then, call the API operation of querying the group task information to check whether the task is successful based on the task ID.

API address

POST: /v1.0/iot-03/device-groups

Request parameter

Description of body

Parameter name	Type	Required	Description
group_name	String	false	The name of a specified group.
asset_id	String	false	The ID of a specified asset.
device_ids	List	false	The device ID.

Return parameter

Parameter name	Type	Description
result	GroupPackageTaskVO	The task information about creating a group.

Description of result

Parameter name	Type	Description
group_id	String	The ID of a specified group.
task_id	String	The ID of a specified task.
expire_time	Long	The expiration time in seconds.

Request example

POST:  /v1.0/iot-03/device-groups

{
  "group_name": "bulu-13n-test",
  "asset_id": "145248249804602****",
  "device_ids": [
    "6c9680b7****"
  ]
}

Return example

{
    "result": {
        "expired_seconds": 10,
        "task_id": "14057567104****",
        "group_id": "140511714560****"
    },
    "t": 1623846099825,
    "success": true
}

Error code

For more information, see error code.

Prev DocAdd Scene Linkage

Next DocGet Details of Device Group