跳转到主要内容
POST
/
calendar
/
create
创建服务日历
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
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
    "cal_name": "API Test Calendar"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

授权

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)。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

创建日历响应。