Skip to content

查询默认好友列表

1. 接口定位

  • 接口名称: 查询默认好友列表
  • 所属域: admin/default/user
  • 业务目标: 返回当前默认好友池中的全部用户 ID

2. 请求定义

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

3. 请求参数

Header 参数

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

Body 参数

  • 无业务参数,请传空对象 {}

4. 响应结构

通用响应包裹

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

data 字段

字段类型说明
userIDsarray<string>默认好友池中的全部用户 ID

5. 业务规则

  • 路由层要求管理员 token。
  • RPC 实现本身接受“已登录用户或管理员”,但在 admin API 路由中实际只开放给管理员使用。
  • 返回结果只包含 userIDs,不包含用户公开资料。

6. 错误码与失败场景

错误码场景典型报错
1001未传 tokentoken is empty
1001token 类型不是管理员token type error
-查询默认好友失败由数据库层返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/default/user/find", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440303",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "userIDs": ["9000000001", "9000000002"]
  }
}

失败响应示例

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

8. 时序流程

  1. 中间件校验管理员 token。
  2. 查询默认好友配置表中的全部 userID
  3. 返回 ID 列表。

9. 变更记录

  • 2026-03-31: 首版发布,基于默认好友查询 RPC 的真实返回结构补全文档。