# 创建设备组
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:createIotGroupId
本接口用于创建设备组,便于用户一次性订阅多个设备
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/group/createid?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model_id | string | 是 | 设备型号的唯一标识。 |
| group_name | string | 是 | 设备组的名称(创建时时决定,无法修改) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| group_id | string | 设备组的唯一标识 |
# 4. 注意事项
创建的设备组只能添加与传入 model_id 同一类型的设备。
# 5. 代码示例
请求示例
{
"group_name": "GROUP_NAME",
"model_id": "MODEL_ID"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"group_id": "GROUP_ID"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 43002 | require POST method | 方法调用错误,请用 post 方法调用 |
| 44002 | empty post data | POST 的数据包为空。post请求body参数不能为空。 |
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;参数需以 JSON 字符串格式写在post请求的 body 中,请检查修正后重试 |
| 9800003 | model_id检查不通过 | 检查model_id |
| 9800012 | group_name 不合法,长度应为 1-32 字节 | 检查 group_name 字段 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。