新增默认好友
1. 接口定位
- 接口名称: 新增默认好友
- 所属域: admin/default/user
- 业务目标: 配置新注册用户自动导入的默认好友列表
2. 请求定义
- Method:
POST - Path:
/default/user/add - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 非幂等
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| userIDs | 是 | array<string> | 要加入默认好友池的用户 ID 列表 |
字段约束
userIDs不能为空数组。userIDs不能有重复值。- 列表中的每个
userID都必须能在聊天用户资料中查到公开信息。 - 已经存在于默认好友池中的
userID不能重复添加。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 成功时返回空对象。
5. 业务规则
- API 层直接透传到 admin RPC,不做额外加工。
- RPC 层会先校验调用方是管理员。
- 添加前会调用 chat 用户公开信息查询,确认
userIDs都真实存在。 - 默认好友池只存
userID/create_time,不会缓存昵称或头像;展示资料在查询时再补齐。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | userIDs 为空 | userIDs is empty 或 user ids is empty |
| 1001 | userIDs 存在重复值 | userIDs has duplicate 或 user ids is duplicate |
| - | 某些用户不存在 | user id not found |
| - | 某些用户已在默认好友池中 | user id existed |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/default/user/add", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440301",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
userIDs: ["9000000001", "9000000002"],
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"userIDs": ["9000000001", "9000000002"]
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例
json
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "user ids is duplicate"
}8. 时序流程
- 中间件校验管理员 token。
- 校验
userIDs非空且无重复。 - 查询这些用户的公开资料,确认用户存在。
- 检查是否已存在于默认好友池。
- 批量写入默认好友配置。
9. 变更记录
- 2026-03-31: 首版发布,基于默认好友新增 RPC 的真实校验和落库逻辑补全文档。