添加设备

更新时间:2024-06-29 02:30:30下载pdf

本文介绍添加设备的 API。

接口描述

根据群组 ID,将设备加入群组。

接口地址

PUT: /v2.1/cloud/thing/group/{group_id}/devices

请求参数

参数名类型参数位置是否必填说明
group_idLongpathtrue群组 ID。

body 说明

参数名类型参数位置是否必填说明
device_idsListbodytrue设备 ID 集合,设备数量不可超过 20 个。

返回参数

参数名类型说明
resultJsonObject返回群组数据结果。
successBooleanAPI 调用是否成功。
  • true:调用成功。
  • false:调用失败。
tLong时间戳。
tidString链路 ID。

result 说明

参数名类型说明
group_idLong群组 ID。
group_nameString群组名称。
space_idString群组所属空间的 ID。
icon_urlString群组 Icon 信息,入参产品对应图片。
create_timeLong群组创建时间。
update_timeLong群组更新时间。
task_idString任务 ID。
task_typeInteger任务类型。
  • 1:添加,例如创建群组。
  • 2:更新,例如添加设备入群组、从群组中移除设备。
  • 3:删除,例如删除群组。
task_expire_secondLong任务过期秒数。任务完成前,请勿再进行群组设备关系修改操作。

请求示例

PUT: /v2.1/cloud/thing/group/13930***/devices
{
  "device_ids": [
    "vdevo17059988490****",
    "vdevo17059988536****"
  ]
}

返回示例

{
    "tid": "d888516e021a11efbe7a366d87620758",
    "result": {
        "icon_url": "https://images.tuyacn.com/smart/solution/142004/673976648441****.png",
        "create_time": 1713944884506,
        "group_name": "testUpdateGroup****",
        "task_id": "178306156754218****",
        "update_time": 1713948182799,
        "group_id": "1393****",
        "task_expire_second": 14,
        "task_type": 2,
        "space_id": "16702****"
    },
    "t": 1713949980077,
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制