预览值班表

预览值班表配置生成的排班结果，不会持久化。请求体与创建/更新相同，并需要指定 start 和 end 时间窗口（最多 45 天）。

POST /schedule/preview

预览值班表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/schedule/preview?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule_name": "Preview Schedule",
  "start": 1712000000,
  "end": 1712086400,
  "layers": [
    {
      "layer_name": "Layer 1",
      "name": "Layer 1",
      "mode": 0,
      "weight": 0,
      "hidden": 0,
      "groups": [
        {
          "group_name": "A",
          "name": "A",
          "members": [
            {
              "role_id": 0,
              "person_ids": [
                2451002751131
              ]
            }
          ],
          "start": 0,
          "end": 0
        }
      ],
      "rotation_unit": "day",
      "rotation_value": 1,
      "rotation_duration": 86400,
      "handoff_time": 0,
      "enable_time": 1712000000,
      "expire_time": 0,
      "restrict_mode": 0,
      "restrict_start": 0,
      "restrict_end": 0,
      "restrict_periods": [],
      "day_mask": {
        "repeat": [
          1,
          2,
          3,
          4,
          5
        ]
      },
      "fair_rotation": false,
      "mask_continuous_enabled": false
    }
  ]
}
'

import requests

url = "https://api.flashcat.cloud/schedule/preview?app_key="

payload = {
    "schedule_name": "Preview Schedule",
    "start": 1712000000,
    "end": 1712086400,
    "layers": [
        {
            "layer_name": "Layer 1",
            "name": "Layer 1",
            "mode": 0,
            "weight": 0,
            "hidden": 0,
            "groups": [
                {
                    "group_name": "A",
                    "name": "A",
                    "members": [
                        {
                            "role_id": 0,
                            "person_ids": [2451002751131]
                        }
                    ],
                    "start": 0,
                    "end": 0
                }
            ],
            "rotation_unit": "day",
            "rotation_value": 1,
            "rotation_duration": 86400,
            "handoff_time": 0,
            "enable_time": 1712000000,
            "expire_time": 0,
            "restrict_mode": 0,
            "restrict_start": 0,
            "restrict_end": 0,
            "restrict_periods": [],
            "day_mask": { "repeat": [1, 2, 3, 4, 5] },
            "fair_rotation": False,
            "mask_continuous_enabled": False
        }
    ]
}
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({
    schedule_name: 'Preview Schedule',
    start: 1712000000,
    end: 1712086400,
    layers: [
      {
        layer_name: 'Layer 1',
        name: 'Layer 1',
        mode: 0,
        weight: 0,
        hidden: 0,
        groups: [
          {
            group_name: 'A',
            name: 'A',
            members: [{role_id: 0, person_ids: [2451002751131]}],
            start: 0,
            end: 0
          }
        ],
        rotation_unit: 'day',
        rotation_value: 1,
        rotation_duration: 86400,
        handoff_time: 0,
        enable_time: 1712000000,
        expire_time: 0,
        restrict_mode: 0,
        restrict_start: 0,
        restrict_end: 0,
        restrict_periods: [],
        day_mask: {repeat: [1, 2, 3, 4, 5]},
        fair_rotation: false,
        mask_continuous_enabled: false
      }
    ]
  })
};

fetch('https://api.flashcat.cloud/schedule/preview?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/schedule/preview?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([
    'schedule_name' => 'Preview Schedule',
    'start' => 1712000000,
    'end' => 1712086400,
    'layers' => [
        [
                'layer_name' => 'Layer 1',
                'name' => 'Layer 1',
                'mode' => 0,
                'weight' => 0,
                'hidden' => 0,
                'groups' => [
                                [
                                                                'group_name' => 'A',
                                                                'name' => 'A',
                                                                'members' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'role_id' => 0,
                                                                                                                                                                                                                                                                'person_ids' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                2451002751131
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ],
                                                                'start' => 0,
                                                                'end' => 0
                                ]
                ],
                'rotation_unit' => 'day',
                'rotation_value' => 1,
                'rotation_duration' => 86400,
                'handoff_time' => 0,
                'enable_time' => 1712000000,
                'expire_time' => 0,
                'restrict_mode' => 0,
                'restrict_start' => 0,
                'restrict_end' => 0,
                'restrict_periods' => [
                                
                ],
                'day_mask' => [
                                'repeat' => [
                                                                1,
                                                                2,
                                                                3,
                                                                4,
                                                                5
                                ]
                ],
                'fair_rotation' => false,
                'mask_continuous_enabled' => false
        ]
    ]
  ]),
  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/schedule/preview?app_key="

	payload := strings.NewReader("{\n  \"schedule_name\": \"Preview Schedule\",\n  \"start\": 1712000000,\n  \"end\": 1712086400,\n  \"layers\": [\n    {\n      \"layer_name\": \"Layer 1\",\n      \"name\": \"Layer 1\",\n      \"mode\": 0,\n      \"weight\": 0,\n      \"hidden\": 0,\n      \"groups\": [\n        {\n          \"group_name\": \"A\",\n          \"name\": \"A\",\n          \"members\": [\n            {\n              \"role_id\": 0,\n              \"person_ids\": [\n                2451002751131\n              ]\n            }\n          ],\n          \"start\": 0,\n          \"end\": 0\n        }\n      ],\n      \"rotation_unit\": \"day\",\n      \"rotation_value\": 1,\n      \"rotation_duration\": 86400,\n      \"handoff_time\": 0,\n      \"enable_time\": 1712000000,\n      \"expire_time\": 0,\n      \"restrict_mode\": 0,\n      \"restrict_start\": 0,\n      \"restrict_end\": 0,\n      \"restrict_periods\": [],\n      \"day_mask\": {\n        \"repeat\": [\n          1,\n          2,\n          3,\n          4,\n          5\n        ]\n      },\n      \"fair_rotation\": false,\n      \"mask_continuous_enabled\": false\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/schedule/preview?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"schedule_name\": \"Preview Schedule\",\n  \"start\": 1712000000,\n  \"end\": 1712086400,\n  \"layers\": [\n    {\n      \"layer_name\": \"Layer 1\",\n      \"name\": \"Layer 1\",\n      \"mode\": 0,\n      \"weight\": 0,\n      \"hidden\": 0,\n      \"groups\": [\n        {\n          \"group_name\": \"A\",\n          \"name\": \"A\",\n          \"members\": [\n            {\n              \"role_id\": 0,\n              \"person_ids\": [\n                2451002751131\n              ]\n            }\n          ],\n          \"start\": 0,\n          \"end\": 0\n        }\n      ],\n      \"rotation_unit\": \"day\",\n      \"rotation_value\": 1,\n      \"rotation_duration\": 86400,\n      \"handoff_time\": 0,\n      \"enable_time\": 1712000000,\n      \"expire_time\": 0,\n      \"restrict_mode\": 0,\n      \"restrict_start\": 0,\n      \"restrict_end\": 0,\n      \"restrict_periods\": [],\n      \"day_mask\": {\n        \"repeat\": [\n          1,\n          2,\n          3,\n          4,\n          5\n        ]\n      },\n      \"fair_rotation\": false,\n      \"mask_continuous_enabled\": false\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/schedule/preview?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  \"schedule_name\": \"Preview Schedule\",\n  \"start\": 1712000000,\n  \"end\": 1712086400,\n  \"layers\": [\n    {\n      \"layer_name\": \"Layer 1\",\n      \"name\": \"Layer 1\",\n      \"mode\": 0,\n      \"weight\": 0,\n      \"hidden\": 0,\n      \"groups\": [\n        {\n          \"group_name\": \"A\",\n          \"name\": \"A\",\n          \"members\": [\n            {\n              \"role_id\": 0,\n              \"person_ids\": [\n                2451002751131\n              ]\n            }\n          ],\n          \"start\": 0,\n          \"end\": 0\n        }\n      ],\n      \"rotation_unit\": \"day\",\n      \"rotation_value\": 1,\n      \"rotation_duration\": 86400,\n      \"handoff_time\": 0,\n      \"enable_time\": 1712000000,\n      \"expire_time\": 0,\n      \"restrict_mode\": 0,\n      \"restrict_start\": 0,\n      \"restrict_end\": 0,\n      \"restrict_periods\": [],\n      \"day_mask\": {\n        \"repeat\": [\n          1,\n          2,\n          3,\n          4,\n          5\n        ]\n      },\n      \"fair_rotation\": false,\n      \"mask_continuous_enabled\": false\n    }\n  ]\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "id": null,
    "name": null,
    "account_id": 0,
    "group_id": null,
    "disabled": null,
    "create_at": 0,
    "create_by": 0,
    "update_at": 0,
    "update_by": 0,
    "layers": [
      {
        "account_id": 0,
        "name": "Layer 1",
        "schedule_id": 0,
        "hidden": 0,
        "mode": 0,
        "weight": 0,
        "groups": [
          {
            "group_name": "A",
            "name": "A",
            "members": [
              {
                "role_id": 0,
                "person_ids": [
                  2451002751131
                ]
              }
            ],
            "start": 0,
            "end": 0
          },
          {
            "group_name": "B",
            "name": "B",
            "members": [
              {
                "role_id": 0,
                "person_ids": [
                  2476123212131
                ]
              }
            ],
            "start": 0,
            "end": 0
          }
        ],
        "rotation_duration": 86400,
        "handoff_time": 0,
        "enable_time": 1775980800,
        "expire_time": 0,
        "restrict_mode": 0,
        "restrict_start": 0,
        "restrict_end": 0,
        "restrict_periods": [],
        "day_mask": {
          "repeat": [
            1,
            2,
            3,
            4,
            5
          ]
        },
        "create_at": 0,
        "create_by": 0,
        "update_at": 0,
        "update_by": 0,
        "layer_name": "Layer 1",
        "fair_rotation": false,
        "layer_start": 1775980800,
        "layer_end": null,
        "rotation_unit": "day",
        "rotation_value": 1,
        "mask_continuous_enabled": false
      }
    ],
    "schedule_layers": [
      {
        "layer_name": "Layer 1",
        "name": "Layer 1",
        "mode": 0,
        "schedules": [
          {
            "start": 1776009600,
            "end": 1776096000,
            "group": {
              "group_name": "A",
              "name": "A",
              "members": [
                {
                  "role_id": 0,
                  "person_ids": [
                    2451002751131
                  ]
                }
              ],
              "start": 1776009600,
              "end": 1776096000
            },
            "index": 0
          },
          {
            "start": 1776096000,
            "end": 1776182400,
            "group": {
              "group_name": "B",
              "name": "B",
              "members": [
                {
                  "role_id": 0,
                  "person_ids": [
                    2476123212131
                  ]
                }
              ],
              "start": 1776096000,
              "end": 1776182400
            },
            "index": 0
          }
        ]
      }
    ],
    "final_schedule": {
      "layer_name": "",
      "name": "",
      "mode": 0,
      "schedules": [
        {
          "start": 1776009600,
          "end": 1776096000,
          "group": {
            "group_name": "A",
            "name": "A",
            "members": [
              {
                "role_id": 0,
                "person_ids": [
                  2451002751131
                ]
              }
            ],
            "start": 1776009600,
            "end": 1776096000
          },
          "index": 0
        }
      ]
    },
    "start": 1775980800,
    "end": 1776240000,
    "notify": null,
    "schedule_id": 0,
    "schedule_name": null,
    "team_id": null,
    "description": null,
    "layer_schedules": null,
    "status": null,
    "cur_oncall": null,
    "next_oncall": null
  }
}

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

​

限制说明

项目	说明
速率限制	每个账户 60 次/分钟；10 次/秒
权限要求	值班查看（on-call） 或 值班管理（on-call）

授权

app_key · string · query · 必填

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

请求体

application/json

值班表创建/更新/预览共用的请求体，结构与值班表详情一致，此处仅列出常用字段。更新时需要 schedule_id；预览时 start、end 必填。

schedule_id · integer<int64> | null

值班表 ID，更新时必填。

schedule_name · string | null

值班表显示名称，最长 40 字符。

Maximum string length: 40

name · string | null

旧版名称字段，当 schedule_name 为空时使用。

Maximum string length: 40

description · string | null

值班表描述，最长 500 字符。

Maximum string length: 500

team_id · integer<int64> | null

所属团队 ID。

layers · object[]

轮转分层。

Show child attributes

notify · object

值班表的通知配置。

Show child attributes

start · integer<int64>

预览窗口开始时间（Unix 秒，10 位），/schedule/preview 必填。

end · integer<int64>

预览窗口结束时间（Unix 秒，10 位），/schedule/preview 必填，且距 start 不超过 45 天。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

/schedule/info、/schedule/preview、/schedule/list 返回的完整值班表详情。

Show child attributes