# 查询设备组信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getIotGroupInfo
本接口用于查询设备组的信息。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/group/getinfo?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| group_id | string | 是 | 设备组的唯一标识 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| group_name | string | 设备名称 |
| device_list | objarray | 设备列表 |
| model_id | string | 设备型号的唯一标识 |
| model_type | string | 设备类型 |
# Res.device_list(Array) Object Payload
设备列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| model_id | string | 设备型号 id。通过微信公众平台注册设备获得。 |
| sn | string | 设备唯一序列号。由厂商分配。 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"group_id": "GROUP_ID"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"group_name": "GROUP_NAME",
"model_id": "MODEL_ID",
"model_type": "门禁机",
"device_list": [
{
"model_id": "MODEL_ID1",
"sn": "SN1"
},
{
"model_id": "MODEL_ID2",
"sn": "SN2"
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 43002 | require POST method | 方法调用错误,请用 post 方法调用 |
| 44002 | empty post data | POST 的数据包为空。post请求body参数不能为空。 |
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;参数需以 JSON 字符串格式写在post请求的 body 中,请检查修正后重试 |
| 9800013 | group_id不合法 | 检查group_id |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。