跳转到主要内容
POST
批量导入订阅者

限制说明

使用说明

  • 需要 On-call 专业版套餐,且账户需开通订阅者导入白名单,否则返回 AccessDenied。
  • method 必须与状态页匹配:公开页且已开启邮件订阅时用 email,内部页且已开启 IM 订阅时用 im。
  • 每个导入的接收人在该状态页上已有的订阅会被导入内容整体替换。
  • component_ids 和 change_ids 中的每个 ID 都必须存在于该状态页,任一无效则整个请求失败。
  • 每次调用都会记录到账户审计日志,请勿在请求字段中写入敏感信息。

授权

app_key
string
query
必填

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

请求体

application/json

批量导入订阅者所需的参数。每个订阅者的 recipient 非空且不超过 255 字符;并且至少订阅一个组件/事件,或将 all 置为 true。

page_id
integer<int64>
必填

目标状态页 ID,可通过 GET /status-page/list 获取。

method
enum<string>
必填

订阅通知方式。email 仅适用于公开状态页,im 仅适用于内部状态页。

可用选项:
email,
im
subscribers
object[]

要导入的订阅者。每个接收人在该状态页上已有的订阅会被替换;省略或传空数组时不做任何操作。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。