创建群组

更新时间：2024-06-29 02:31:19下载pdf

本文介绍创建群组的 API。

接口描述

同一空间下的设备集合可以创建群组。

接口地址

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

请求参数

body 说明

参数名	类型	参数位置	是否必填	说明
space_id	String	body	true	空间 ID。
group_name	String	body	true	群组名称。
device_ids	List	body	true	设备 ID 集合，设备数量不可超过 20 个。
product_id	String	body	false	产品 ID。如果传递了产品 ID，将会取产品图片作为群组的 Icon 进行展示。

返回参数

参数名	类型	说明
result	JsonObject	返回群组数据结果。
success	Boolean	API 调用是否成功。 `true`：调用成功。 `false`：调用失败。
t	Long	时间戳。
tid	String	链路 ID。

result 说明

参数名	类型	说明
group_id	Long	群组 ID。
group_name	String	群组名称。
space_id	String	群组所属空间的 ID。
icon_url	String	群组 Icon 信息，入参产品对应图片。
create_time	Long	群组创建时间。
update_time	Long	群组更新时间。
task_id	String	任务 ID。
task_type	Integer	任务类型。 `1`：添加，例如创建群组。 `2`：更新，例如添加设备入群组、从群组中移除设备。 `3`：删除，例如删除群组。
task_expire_second	Long	任务过期秒数。任务完成前，请勿再进行群组设备关系修改操作。

请求示例

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

{
  "space_id": "16702****",
  "group_name": "testGroup****",
  "device_ids": [
    "vdevo17059963113****",
    "vdevo17059963185****"
  ],
  "product_id": "oftxwukuvzoc****"
}

返回示例

{
    "tid": "fafbfba7020e11efbe7a366d87620758",
    "result": {
        "icon_url": "https://images.tuyacn.com/smart/solution/142004/673976648441****.png",
        "create_time": 1713944884506,
        "group_name": "testGroup****",
        "task_id": "1783040196380512256",
        "update_time": 1713944884506,
        "group_id": "1393****",
        "task_expire_second": 14,
        "task_type": 1,
        "space_id": "16702****"
    },
    "t": 1713944885422,
    "success": true
}

错误码

参考错误码。

调用频率限制

参考调用频率限制。