获取群摘要信息
1. 接口定位
- 接口名称: 获取群摘要信息
- 所属域: group
- 业务目标: 批量返回群成员规模与成员列表哈希,用于快速校验群成员集合变化
2. 请求定义
- Method:
POST - Path:
/group/get_group_abstract_info - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,需要通过 Header
token传入有效令牌 - 幂等性: 幂等(只读操作)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 登录令牌 |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| groupIDs | 是 | array[string] | 待查询的群组 ID 列表 |
字段约束
groupIDs不能为空。groupIDs不能重复。- 调用方需对每个
groupID均具备访问权限(管理员或群内成员)。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | any | 业务数据 |
data 字段结构
| 字段 | 类型 | 说明 |
|---|---|---|
| groupAbstractInfos | array | 群摘要信息列表 |
groupAbstractInfos 元素(GroupAbstractInfo)
| 字段 | 类型 | 说明 |
|---|---|---|
| groupID | string | 群组 ID |
| groupMemberNumber | uint32 | 群成员数量 |
| groupMemberListHash | uint64 | 群成员列表哈希 |
5. 业务规则
- 调用方需满足“应用管理员”或“在群内成员”之一,且对请求中的每个群都要通过校验。
- 当请求中包含不存在的群组,接口会返回群不存在错误,不会返回部分成功结果。
- 当群存在但成员映射异常缺失时,接口返回群成员数据缺失错误。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | groupIDs 为空或重复 | ArgsError |
| 1002 | 非群成员且非管理员 | NoPermissionError |
| 1201 | 群组不存在 | GroupIDNotFoundError |
| 500 | 服务内部错误 | ServerInternalError |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10002/group/get_group_abstract_info", {
method: "POST",
headers: {
operationID: "8f738b8d-f153-4bb8-9877-4693af10b9e8",
token: "<your-token>",
"Content-Type": "application/json",
},
body: JSON.stringify({
groupIDs: ["group_001", "group_002"],
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"groupIDs": ["group_001", "group_002"]
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"groupAbstractInfos": [
{
"groupID": "group_001",
"groupMemberNumber": 86,
"groupMemberListHash": 1287364512
},
{
"groupID": "group_002",
"groupMemberNumber": 12,
"groupMemberListHash": 98231123
}
]
}
}8. 时序流程
- 校验请求参数(非空、去重约束)。
- 逐群校验调用者权限(管理员或群成员)。
- 查询群与群成员映射,组装摘要信息返回。
9. 变更记录
- 2026-06-20: 首版补充文档发布。