账户注销(chatx)
1. 接口定位
- 接口名称: 账户注销(chatx)
- 所属域: chat/account(chatx)
- 业务目标: 注销当前登录用户账号,确保该账号的 Chat Token 与 IM Token 立即失效,且后续无法再登录
2. 请求定义
- Method:
POST - Path:
/chatx/account/cancel - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,需要通过 Header
token传入有效登录令牌 - 幂等性: 非严格幂等(首次调用会执行实际注销;后续重复调用通常因 token 已失效而鉴权失败)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 登录令牌 |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| userID | 否 | string | 目标用户 ID;为空时使用当前 token 对应用户,若传值则必须与当前用户一致 |
字段约束
- 当前版本仅支持“注销自己”。
- 若传
userID,必须等于当前 token 对应用户 ID,否则返回无权限错误。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 本接口成功时返回空对象(无业务字段)。
5. 业务规则
- 接口必须在有效 token 下调用。
- 注销执行顺序固定如下:
- 失效 Chat Token(InvalidateToken)
- 触发 IM 强制下线(ForceOffLine)
- 删除 Chat 账户记录(DelUserAccount)
- 任一步骤失败即整体失败并返回错误。
- 注销成功后,该用户无法再通过原账户完成登录。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | token 缺失或无效 | token is empty / token type error |
| 1002 | 试图注销其他用户 | NoPermission + can only cancel self account |
| 5000+ | Chat Token 失效失败 | InvalidateToken 上游错误 |
| 5000+ | IM 强制下线失败 | ForceOffLine 上游错误 |
| 5000+ | 删除 Chat 账户失败 | DelUserAccount 上游错误 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10008/chatx/account/cancel", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440010",
token: "eyJhbGciOiJIUzI1NiIs...",
"Content-Type": "application/json",
},
body: JSON.stringify({
userID: "2817364510",
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"userID": "2817364510"
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例(跨用户注销)
json
{
"errCode": 1002,
"errMsg": "NoPermissionError",
"errDlt": "can only cancel self account"
}8. 时序流程
- API 层通过 token 中间件完成鉴权。
- RPC 层解析调用者身份,确定注销目标用户。
- 先失效 Chat Token。
- 再触发 IM 强制下线。
- 最后删除 Chat 账户记录。
- 返回统一成功响应。
9. 变更记录
- 2026-07-27: 首版发布,新增 chatx 账户注销接口。