查询群组

更新时间：2023-11-23 06:19:59下载pdf

本文介绍查询群组的 API。

接口描述

根据群组 ID，获取群组数据。

接口地址

GET: /v2.0/cloud/thing/group/{group_id}

请求参数

参数名	类型	参数位置	是否必填	说明
group_id	Long	path	true	群组 ID。

返回参数

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

result 说明

参数名	类型	说明
id	Long	群组 ID。
name	String	群组的名称数据。
pv	String	MQTT 协议版本。
time	Long	群组创建时间。
type	Integer	群组的分组类型。 `0`：直连云设备。 `1`：非直连云设备，需要通过网关设备连云的设备。
uid	String	群组所属的用户 ID。
group_type	Integer	群组所属的协议类型。 `0`：Wi-Fi `1`：蓝牙低功耗 `2`：Zigbee `3`：蓝牙 mesh
icon_url	String	群组的图片信息，默认是产品的图片。目前不支持更改。
local_key	String	`mqtt` 对应的 `localKey`。
owner_id	String	群组所属空间的 ID 数据。
product_id	String	群组的产品 ID。

请求示例

GET: /v2.0/cloud/thing/group/1285***7

返回示例

{
  "result": {
    "category": "",
    "dev_id": "",
    "device_num": 1,
    "dp_name": {
      "1": "",
      "9": ""
    },
    "dps": {
      "1": false,
      "9": 0
    },
    "group_key": "",
    "group_type": 0,
    "iconUrl": "https://images.tuyacn.com/smart/solution/15001/66ba22c327bfbf3d_co***.png",
    "id": "1285****"
    "local_key": "360f7d71088c***",
    "name": "测试****",
    "owner_id": "251*****",
    "product_id": "fqi9xqld***",
    "pv": "2.2",
    "standard": false,
    "time": 1677117998,
    "type": 0,
    "uid": "ay159910362*****"
  },
  "success": true,
  "t": 1677118783681,
  "tid": "88f0c69eb32011edaa2fba12a1143bd9"
}

错误码

参考错误码。

调用频率限制

参考调用频率限制。

上一篇删除群组

下一篇修改群组名称