搜索默认群组

1. 接口定位

• 接口名称: 搜索默认群组
• 所属域: admin/default/group
• 业务目标: 按群组 ID 关键字分页搜索默认群组池，并补充 OpenIM 群资料

2. 请求定义

• Method: POST
• Path: /default/group/search
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 幂等

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

字段	必填	类型	说明
keyword	否	string	按 group_id 做不区分大小写模糊匹配；为空时等价于全量搜索
pagination	是	object	分页参数

pagination 字段

字段	必填	类型	说明
pageNumber	是	int32	页码，从 1 开始
showNumber	是	int32	每页条数，大于 0

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	object	业务数据

data 字段

字段	类型	说明
total	uint32	命中的默认群组总数，来自本地配置表
groups	array<object>	群资料列表，来自 OpenIM GroupInfo 查询结果

groups 元素说明

• 每个元素都是 OpenIM sdkws.GroupInfo 对象，由 API 层按 groupID 再次查询后原样返回。
• 本服务不裁剪该对象；常见字段通常包括 groupID、groupName、notification、faceURL、creatorUserID、memberCount、createTime 等，实际以 OpenIM 返回为准。

5. 业务规则

• 搜索关键字会对默认群组配置表中的 group_id 做 MongoDB $regex 模糊匹配，忽略大小写。
• admin RPC 先返回 total + groupIDs。
• API 层再调用 OpenIM FindGroupInfo 批量补群资料，最终返回 total + groups。
• 如果本地配置表里有某个 groupID，但 OpenIM 已查不到该群，则该群不会出现在 groups 数组里，因此可能出现 total > len(groups) 的情况。

6. 错误码与失败场景

错误码	场景	典型报错
1001	pagination 为空	pagination is empty
1001	pageNumber < 1	pageNumber is invalid
1001	showNumber < 1	showNumber is invalid
-	查询默认群组配置失败	由数据库层返回
-	批量查询 OpenIM 群资料失败	由 OpenIM 群资料链路返回

7. 示例

fetch 请求示例

fetch("http://localhost:10009/default/group/search", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440308",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    keyword: "group",
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "keyword": "group",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "groups": [
      {
        "groupID": "group_001",
        "groupName": "Onboarding Group",
        "notification": "welcome",
        "faceURL": "https://example.com/group.png",
        "creatorUserID": "1000000001",
        "memberCount": 42
      }
    ]
  }
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "pagination is empty"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验分页参数。
3. 按 keyword 在默认群组配置表中分页搜索 group_id。
4. 取当前页 groupID 列表到 OpenIM 批量查询群资料。
5. 按查询结果组装 total + groups 返回。

9. 变更记录

• 2026-03-31: 首版发布，基于默认群组搜索的本地检索与 OpenIM 群资料拼装逻辑补全文档。