跳转到主要内容
POST
/
status-page
/
subscriber
/
import
批量导入订阅者
curl --request POST \
  --url 'https://api.flashcat.cloud/status-page/subscriber/import?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page_id": 5750613685214,
  "method": "email",
  "subscribers": [
    {
      "recipient": "alice@example.com",
      "all": true,
      "locale": "en-US"
    },
    {
      "recipient": "bob@example.com",
      "component_ids": [
        "01KC3GAZ6ZJE40H55GM31RPWZE"
      ],
      "all": false,
      "locale": "zh-CN"
    }
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {}
}

限制说明

项目说明
速率限制每个账户 20 次/分钟2 次/秒
权限要求状态页面管理on-call

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

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

page_id
integer<int64>
必填

目标状态页 ID。

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: null