删除默认好友
1. 接口定位
- 接口名称: 删除默认好友
- 所属域: admin/default/user
- 业务目标: 从新用户自动导入的默认好友池中移除用户
2. 请求定义
- Method:
POST - Path:
/default/user/del - 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都必须已经存在于默认好友池中。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 成功时返回空对象。
5. 业务规则
- API 层直接透传到 admin RPC。
- 删除前会先校验
userIDs在默认好友池中是否存在。 - 只删除默认好友配置,不会影响真实好友关系数据。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | userIDs 为空 | userIDs is empty 或 user ids is empty |
| 1001 | userIDs 存在重复值 | user ids is duplicate |
| - | 某些用户不在默认好友池中 | user id not found |
| - | 删除配置失败 | 由数据库层返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/default/user/del", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440302",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
userIDs: ["9000000001"],
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"userIDs": ["9000000001"]
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例
json
{
"errCode": 1004,
"errMsg": "RecordNotFound",
"errDlt": "user id not found"
}8. 时序流程
- 中间件校验管理员 token。
- 校验
userIDs非空且无重复。 - 检查这些
userID是否已存在于默认好友池。 - 批量删除默认好友配置。
9. 变更记录
- 2026-03-31: 首版发布,基于默认好友删除 RPC 的真实校验和删除逻辑补全文档。