批量导入订阅者

批量导入状态页的订阅者。

POST /status-page/subscriber/import

批量导入订阅者

cURL

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": "[e-mail]",
      "all": true,
      "locale": "en-US"
    },
    {
      "recipient": "[e-mail]",
      "component_ids": [
        "01KC3GAZ6ZJE40H55GM31RPWZE"
      ],
      "all": false,
      "locale": "zh-CN"
    }
  ]
}
'

import requests

url = "https://api.flashcat.cloud/status-page/subscriber/import?app_key="

payload = {
    "page_id": 5750613685214,
    "method": "email",
    "subscribers": [
        {
            "recipient": "[e-mail]",
            "all": True,
            "locale": "en-US"
        },
        {
            "recipient": "[e-mail]",
            "component_ids": ["01KC3GAZ6ZJE40H55GM31RPWZE"],
            "all": False,
            "locale": "zh-CN"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    page_id: 5750613685214,
    method: 'email',
    subscribers: [
      {recipient: '[e-mail]', all: true, locale: 'en-US'},
      {
        recipient: '[e-mail]',
        component_ids: ['01KC3GAZ6ZJE40H55GM31RPWZE'],
        all: false,
        locale: 'zh-CN'
      }
    ]
  })
};

fetch('https://api.flashcat.cloud/status-page/subscriber/import?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/status-page/subscriber/import?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'page_id' => 5750613685214,
    'method' => 'email',
    'subscribers' => [
        [
                'recipient' => '[e-mail]',
                'all' => true,
                'locale' => 'en-US'
        ],
        [
                'recipient' => '[e-mail]',
                'component_ids' => [
                                '01KC3GAZ6ZJE40H55GM31RPWZE'
                ],
                'all' => false,
                'locale' => 'zh-CN'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/status-page/subscriber/import?app_key="

	payload := strings.NewReader("{\n  \"page_id\": 5750613685214,\n  \"method\": \"email\",\n  \"subscribers\": [\n    {\n      \"recipient\": \"[e-mail]\",\n      \"all\": true,\n      \"locale\": \"en-US\"\n    },\n    {\n      \"recipient\": \"[e-mail]\",\n      \"component_ids\": [\n        \"01KC3GAZ6ZJE40H55GM31RPWZE\"\n      ],\n      \"all\": false,\n      \"locale\": \"zh-CN\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/status-page/subscriber/import?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"page_id\": 5750613685214,\n  \"method\": \"email\",\n  \"subscribers\": [\n    {\n      \"recipient\": \"[e-mail]\",\n      \"all\": true,\n      \"locale\": \"en-US\"\n    },\n    {\n      \"recipient\": \"[e-mail]\",\n      \"component_ids\": [\n        \"01KC3GAZ6ZJE40H55GM31RPWZE\"\n      ],\n      \"all\": false,\n      \"locale\": \"zh-CN\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/status-page/subscriber/import?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"page_id\": 5750613685214,\n  \"method\": \"email\",\n  \"subscribers\": [\n    {\n      \"recipient\": \"[e-mail]\",\n      \"all\": true,\n      \"locale\": \"en-US\"\n    },\n    {\n      \"recipient\": \"[e-mail]\",\n      \"component_ids\": [\n        \"01KC3GAZ6ZJE40H55GM31RPWZE\"\n      ],\n      \"all\": false,\n      \"locale\": \"zh-CN\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {}
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 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[]

要导入的订阅者列表。

Show child attributes

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

空响应体。成功时服务端返回 data: null。