创建服务日历

创建个人服务日历。每个账户默认最多 5 个日历，可通过 Flashcat-Break-Cal-Limit 请求头突破限制。

POST /calendar/create

创建服务日历

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/calendar/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cal_name": "Production On-Call Calendar",
  "description": "Calendar for production on-call team",
  "timezone": "Asia/Shanghai",
  "workdays": [
    1,
    2,
    3,
    4,
    5
  ]
}
'

import requests

url = "https://api.flashcat.cloud/calendar/create?app_key="

payload = {
    "cal_name": "Production On-Call Calendar",
    "description": "Calendar for production on-call team",
    "timezone": "Asia/Shanghai",
    "workdays": [1, 2, 3, 4, 5]
}
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({
    cal_name: 'Production On-Call Calendar',
    description: 'Calendar for production on-call team',
    timezone: 'Asia/Shanghai',
    workdays: [1, 2, 3, 4, 5]
  })
};

fetch('https://api.flashcat.cloud/calendar/create?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/calendar/create?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([
    'cal_name' => 'Production On-Call Calendar',
    'description' => 'Calendar for production on-call team',
    'timezone' => 'Asia/Shanghai',
    'workdays' => [
        1,
        2,
        3,
        4,
        5
    ]
  ]),
  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/calendar/create?app_key="

	payload := strings.NewReader("{\n  \"cal_name\": \"Production On-Call Calendar\",\n  \"description\": \"Calendar for production on-call team\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"workdays\": [\n    1,\n    2,\n    3,\n    4,\n    5\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/calendar/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"cal_name\": \"Production On-Call Calendar\",\n  \"description\": \"Calendar for production on-call team\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"workdays\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/calendar/create?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  \"cal_name\": \"Production On-Call Calendar\",\n  \"description\": \"Calendar for production on-call team\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"workdays\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ]\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
    "cal_name": "API Test Calendar"
  }
}

{
  "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."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	服务日历管理（on-call）

授权

app_key · string · query · 必填

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

请求体

application/json

创建日历请求，cal_name 必填。

cal_name · string · 必填

日历显示名称。

Required string length: 1 - 39

description · string

日历描述。

Maximum string length: 499

timezone · string · 默认值: Asia/Shanghai

IANA 时区，为空时默认 Asia/Shanghai。

team_id · integer<int64>

所属团队 ID，0 表示不关联团队。

workdays · integer[]

工作日（0 = 周日，6 = 周六）。

必填范围: 0 <= x <= 6

extra_cal_ids · string[]

需要继承事件的公共节假日日历 ID 列表（例如 zh-cn.china.official）。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

创建日历响应。

Show child attributes