# 设备组添加设备

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:addIotGroupDevice

本接口用于为设备组添加设备

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/business/group/adddevice?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
group_idstring设备组的唯一标识
device_listobjarray设备列表
force_addboolean是否强制更新设备列表,等于 true 时将已存在其它设备组中的设备移除并添加到当前设备组,慎用。

# Body.device_list(Array) Object Payload

设备列表

参数名类型必填说明
model_idstring设备型号 id。通过微信公众平台注册设备获得。
snstring设备唯一序列号。由厂商分配。

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
device_listobjarray设备列表

# Res.device_list(Array) Object Payload

设备列表

参数名类型说明
model_idstring设备型号 id。通过微信公众平台注册设备获得。
snstring设备唯一序列号。由厂商分配。

# 4. 注意事项

一个设备组最多添加 50 个设备。 一个设备同一时间只能被添加到一个设备组中。

# 5. 代码示例

请求示例

{
  "group_id": "GROUP_ID",
  "device_list": [
    {
      "model_id": "MODEL_ID1",
      "sn": "SN1"
    },
    {
      "model_id": "MODEL_ID2",
      "sn": "SN2"
    }
  ]
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "device_list": [
    {
      "model_id": "MODEL_ID1",
      "sn": "SN1",
      "errcode": 0
    },
    {
      "model_id": "MODEL_ID2",
      "sn": "SN2",
      "errcode": 0
    }
  ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
43002require POST method方法调用错误,请用 post 方法调用
44002empty post dataPOST 的数据包为空。post请求body参数不能为空。
47001data format error解析 JSON/XML 内容错误;post 数据中参数缺失;参数需以 JSON 字符串格式写在post请求的 body 中,请检查修正后重试
9800013group_id不合法检查group_id
9800014设备类型与设备组不符合检查model id的设备类型
9800015该设备已存在于设备组检查该sn是否已添加
9800016设备组中设备数到达上限检查设备组中的设备个数
9800018该设备已经属于另一个设备组检查设备是否已添加
9800044已扩容至最大设备数量检查组内的设备数量

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。