跳转到主要内容
POST
邀请成员

限制说明

使用说明

  • 每个条目需要提供 email,或同时提供 member_name 和 phone。
  • 邮箱或手机号已属于本账户成员的条目会被静默跳过;items 只列出本次新建的成员,一个都没有创建时为 null。
  • 新成员以 pending 状态创建,并通过邮件或短信收到邀请。
  • 邮箱以小写存储。账户限制了成员邮箱域名时,不在白名单内的地址返回 400;同一请求内邮箱或手机号重复也返回 400。
  • country_code 必须是 ISO 3166-1 alpha-2 地区代码(如 “CN”);写入前校验并统一转为大写,非法值返回 400。
  • 当成员的 phone 不带 ”+” 前缀时,按该成员的 country_code 作为地区提示解析(未传时默认 “CN”)。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

邀请成员请求

members
object[]
必填

单次邀请的成员列表,至少 1 个。每个成员要么提供 email,要么同时提供 member_name 和 phone。单次请求最多 20 项,更多请分多次调用。

Required array length: 1 - 20 elements
from
string

邀请来源。仅当账户已关闭成员邀请且值为 api 时生效:直接创建已激活成员并将邮箱/手机标记为已验证,不发送邀请;其他取值按正常邀请流程处理

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

邀请成员响应