Skip to content

删除邀请码

1. 接口定位

  • 接口名称: 删除邀请码
  • 所属域: admin/invitation-code
  • 业务目标: 批量删除指定邀请码记录

2. 请求定义

  • Method: POST
  • Path: /invitation_code/del
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 非幂等;若目标邀请码不存在会直接返回失败

3. 请求参数

Header 参数

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

Body 参数

字段必填类型说明
codesarray<string>要删除的邀请码列表

字段约束

  • 协议校验要求 codes 不能为 null
  • RPC 层要求 codes 长度必须大于 0
  • codes 中不允许出现重复值。
  • 删除前会先查询数据库,要求请求中的每一个邀请码都必须存在;只要缺一个就整体失败。

4. 响应结构

通用响应包裹

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

data 字段

  • 本接口成功时返回空对象(无业务字段)。

5. 业务规则

  • 仅管理员可以调用。
  • 服务端先按 codes 全量查询。
  • 如果数据库中命中的数量与请求数量不一致,会计算缺失项并返回 code not found ...
  • 只有当全部邀请码都存在时,才会执行批量删除。

6. 错误码与失败场景

错误码场景典型报错
1001codesnullcodes is empty
1001codes 为空数组codes is empty
1001codes 内存在重复值codes is duplicate
1001部分邀请码不存在code not found xxx, yyy
-数据库删除失败由数据库层返回原始错误

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/invitation_code/del", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440403",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    codes: ["WELCOME2026", "BETA-USER-001"],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "codes": ["WELCOME2026", "BETA-USER-001"]
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "code not found MISSING-CODE"
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 校验 codes 是否为空、是否含重复项。
  3. 按请求列表查询邀请码记录。
  4. 若存在缺失邀请码,则直接返回失败。
  5. 执行批量删除并返回成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于邀请码删除前的全量存在性校验逻辑补全文档。