跳转到主要内容
POST
删除成员

限制说明

使用说明

  • 使用任一查找字段定位成员;同时传多个时,按 member_id、member_name、email、phone、ref_id 的顺序取第一个非空字段。
  • 除非 is_force 为 true,成员仍属于某个团队、被分派策略直接指定或在值班表中时,调用返回 400 ReferenceExist,data.refs 列出每条引用。强制删除会跳过检查,且不会清理这些引用。
  • 删除为软删除:成员状态变为 deleted,释放其占用的 License 席位,并移除其单点登录身份关联。之后仍可通过 POST /person/infos 解析该成员。
  • 通过单点登录同步的成员,在单点登录配置将其设为不可编辑,或账户已无生效的单点登录配置时无法删除,调用返回 400。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

删除成员请求(提供其中一个查找字段)

member_id
integer<uint64>
必填

成员 ID。同时提供多个查找字段时,按 member_id > member_name > email > phone > ref_id 的优先级取第一个非空值

member_name
string

成员名称。仅在未提供 member_id 时生效

email
string

邮箱地址。仅在 member_id、member_name 均未提供时生效

phone
string

手机号。仅在 member_id、member_name、email 均未提供时生效

country_code
string

当 phone 不带 "+" 前缀时的解析地区提示 —— ISO 3166-1 alpha-2 地区代码(如 "CN",未传时默认 "CN")。此解析场景仍兼容 "86" 等数字电话区号。

ref_id
string

外部引用 ID。仅在其他查找字段均未提供时生效

is_force
boolean
默认值:false

跳过引用检查。为 false(默认)时,若成员属于某个团队、被分派策略指定或在值班表中,调用返回 ReferenceExist。强制删除不会移除这些引用。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

空响应