创建群组

更新时间:2023-11-23 06:24:22下载pdf

本文介绍创建群组的 API。

接口描述

创建 Wi-Fi 群组。需要是相同品类,同一空间下的设备集合。

接口地址

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

请求参数

body 说明

参数名类型参数位置是否必填说明
space_idStringbodytrue空间 ID。
nameStringbodytrue群组名称。
product_idStringbodytrue产品 ID。
device_idsStringbodytrue设备 ID 集合,多个设备 ID 使用逗号分隔。设备数量不可超过 20。

返回参数

参数名类型说明
resultDeviceGroupCloudDTO返回群组数据结果。
successBoolean操作是否成功。
  • true:操作成功。
  • false:操作失败。
tBoolean时间戳。
tidBoolean链路 ID。

result 说明

参数名类型说明
idLong群组 ID。
nameString群组的名称数据。
pvStringMQTT 协议版本。
timeLong群组创建时间。
typeInteger群组的分组类型。
  • 0:直连云设备。
  • 1:非直连云设备,需要通过网关设备连云的设备。
uidString群组所属的用户 ID。
group_typeInteger群组所属的协议类型。
  • 0:Wi-Fi
  • 1:蓝牙低功耗
  • 2:Zigbee
  • 3:蓝牙 mesh
icon_urlString群组的图片信息,默认是产品的图片。目前不支持更改。
local_keyStringmqtt 对应的 localKey
owner_idString群组所属的空间的 ID 数据。
product_idString群组的产品 ID。

请求示例

POST: /v2.0/cloud/thing/group
{
  "space_id": "25129******",
  "name": "测试群组**",
  "product_id": "dsadhsjkh2312",
  "device_ids": "dshajhdkhaj***,hsdkajhkk***"
}

返回示例

{
    "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
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制