查询我的值班表

返回当前用户被分配的值班表列表。

POST /schedule/self

查询我的值班表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/schedule/self?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": 1712000000,
  "end": 1712086400
}
'

import requests

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

payload = {
    "start": 1712000000,
    "end": 1712086400
}
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({start: 1712000000, end: 1712086400})
};

fetch('https://api.flashcat.cloud/schedule/self?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/self?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([
    'start' => 1712000000,
    'end' => 1712086400
  ]),
  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/self?app_key="

	payload := strings.NewReader("{\n  \"start\": 1712000000,\n  \"end\": 1712086400\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/self?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"start\": 1712000000,\n  \"end\": 1712086400\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/schedule/self?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  \"start\": 1712000000,\n  \"end\": 1712086400\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "id": 2539108069860,
        "name": "Open Source Q&A",
        "account_id": 2451002751131,
        "group_id": 2477033058131,
        "disabled": 0,
        "create_at": 1702623874,
        "create_by": 2451002751131,
        "update_at": 1710468081,
        "update_by": 2476444212131,
        "layers": [
          {
            "account_id": 2451002751131,
            "name": "Rule 1",
            "schedule_id": 2539108069860,
            "hidden": 0,
            "mode": 0,
            "weight": 0,
            "groups": [
              {
                "group_name": "A",
                "name": "A",
                "members": [
                  {
                    "role_id": 0,
                    "person_ids": [
                      2476444212131
                    ]
                  }
                ],
                "start": 0,
                "end": 0
              },
              {
                "group_name": "B",
                "name": "B",
                "members": [
                  {
                    "role_id": 0,
                    "person_ids": [
                      2469167612131
                    ]
                  }
                ],
                "start": 0,
                "end": 0
              }
            ],
            "rotation_duration": 86400,
            "handoff_time": 0,
            "enable_time": 1702623874,
            "expire_time": 0,
            "restrict_mode": 0,
            "restrict_start": 0,
            "restrict_end": 0,
            "restrict_periods": [],
            "day_mask": {
              "repeat": [
                1,
                2,
                3,
                4,
                5
              ]
            },
            "create_at": 1702623874,
            "create_by": 2451002751131,
            "update_at": 1710468081,
            "update_by": 2476444212131,
            "layer_name": "Rule 1",
            "fair_rotation": false,
            "layer_start": 1702623874,
            "layer_end": null,
            "rotation_unit": "day",
            "rotation_value": 1,
            "mask_continuous_enabled": false
          }
        ],
        "schedule_layers": null,
        "final_schedule": {
          "layer_name": "",
          "name": "",
          "mode": 0,
          "schedules": null
        },
        "notify": {
          "fixed_time": null,
          "by": null,
          "webhooks": null
        },
        "schedule_id": 2539108069860,
        "schedule_name": "Open Source Q&A",
        "team_id": 2477033058131,
        "description": "",
        "layer_schedules": null,
        "status": 0,
        "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."
  }
}

​

限制说明

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

授权

app_key · string · query · 必填

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

请求体

application/json

查询当前用户值班表的参数。start 和 end 为 Unix 时间戳（秒），缺省时默认为 0。时间窗口不得超过 30 天。

start · integer<int64>

时间窗口开始时间（Unix 秒，10 位）。

end · integer<int64>

时间窗口结束时间（Unix 秒，10 位），与 start 的差值不得超过 30 天。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

/schedule/self 与 /schedule/infos 的响应，仅返回 items。

Show child attributes