Skip to content

查询指定用户白名单状态

1. 接口定位

  • 接口名称: 查询指定用户白名单状态
  • 所属域: admin/group
  • 业务目标: 按用户 ID 批量查询建群白名单记录

2. 请求定义

  • Method: POST
  • Path: /adminx/group/create_permission/find
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 幂等(只读操作)

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
userIDsarray<string>待查询的用户 ID 列表

4. 响应结构

通用响应包裹

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

data 字段

字段类型说明
usersarray<GroupCreatePermissionInfo>白名单命中记录

GroupCreatePermissionInfo 字段如下:

字段类型说明
userIDstring用户 ID
reasonstring加入白名单原因
opUserIDstring操作管理员用户 ID
createTimeint64创建时间,毫秒时间戳
userobject用户公开资料

5. 业务规则

  • 只返回已存在于建群白名单中的记录,不会为未命中用户补空项。
  • 返回结果会补齐 user 公开资料字段。
  • 若用户资料映射失败,整个请求返回错误。

6. 错误码与失败场景

错误码场景典型报错
1001Header 缺少 operationIDheader must have operationID
-缺少管理员 token由管理员鉴权链路返回
-白名单查询失败由存储链路返回
-用户资料查询失败由用户资料查询链路返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10011/adminx/group/create_permission/find", {
  method: "POST",
  headers: {
    operationID: "group-create-permission-find-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    userIDs: ["user_001", "user_002"],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "userIDs": ["user_001", "user_002"]
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "users": [
      {
        "userID": "user_001",
        "reason": "运营活动白名单",
        "opUserID": "admin_001",
        "createTime": 1775404800000,
        "user": {
          "userID": "user_001",
          "nickname": "Tom"
        }
      }
    ]
  }
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. userIDs 查询建群白名单记录。
  3. 批量补齐命中用户的公开资料。
  4. 返回命中记录列表。

9. 变更记录

  • 2026-04-06: 补全文档结构,修正真实服务前缀为 /adminx