Skip to content

获取群成员用户 ID 列表

1. 接口定位

  • 接口名称: 获取群成员用户 ID 列表
  • 所属域: group
  • 业务目标: 按群组 ID 返回该群全部成员的用户 ID 列表

2. 请求定义

  • Method: POST
  • Path: /group/get_group_member_user_id
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 必填,需要通过 Header token 传入有效令牌
  • 幂等性: 幂等(只读操作)

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring登录令牌

Body 参数

字段必填类型说明
groupIDstring群组 ID

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataany业务数据

data 字段结构

字段类型说明
userIDsarray[string]群成员用户 ID 列表

5. 业务规则

  • 调用方需满足“应用管理员”或“在群内成员”之一。
  • 服务端会先读取群成员 userID 列表,再执行权限校验;普通用户仅可查询自己所在群。

6. 错误码与失败场景

错误码场景典型报错
1002非群成员且非管理员NoPermissionError
500服务内部错误ServerInternalError

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10002/group/get_group_member_user_id", {
  method: "POST",
  headers: {
    operationID: "23b11a3c-07f8-4af9-87bd-25fd2df7f4d2",
    token: "<your-token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    groupID: "group_001",
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "groupID": "group_001"
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "userIDs": ["u_1001", "u_1002", "u_admin"]
  }
}

8. 时序流程

  1. 解析请求并读取群成员 userID 列表。
  2. 校验调用者是否为应用管理员,或是否在该群成员列表中。
  3. 返回 userIDs

9. 变更记录

  • 2026-06-20: 首版补充文档发布。