查询模板列表

分页返回当前账户下的通知模板列表。

POST /template/list

查询模板列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/template/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "p": 1,
  "limit": 20,
  "orderby": "updated_at",
  "asc": false,
  "is_my_team": false
}
'

import requests

url = "https://api.flashcat.cloud/template/list?app_key="

payload = {
    "p": 1,
    "limit": 20,
    "orderby": "updated_at",
    "asc": False,
    "is_my_team": 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({p: 1, limit: 20, orderby: 'updated_at', asc: false, is_my_team: false})
};

fetch('https://api.flashcat.cloud/template/list?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/template/list?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([
    'p' => 1,
    'limit' => 20,
    'orderby' => 'updated_at',
    'asc' => false,
    'is_my_team' => 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/template/list?app_key="

	payload := strings.NewReader("{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"updated_at\",\n  \"asc\": false,\n  \"is_my_team\": false\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/template/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"updated_at\",\n  \"asc\": false,\n  \"is_my_team\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/template/list?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  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"updated_at\",\n  \"asc\": false,\n  \"is_my_team\": false\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 47,
    "has_next_page": true,
    "items": [
      {
        "account_id": 10023,
        "team_id": 0,
        "template_id": "6605a1b2c3d4e5f6a7b8c9d0",
        "template_name": "生产环境默认模板",
        "description": "Default template for production incidents.",
        "email": "Incident {{ .IncidentName }} on {{ .Severity }}",
        "sms": "[Flashduty] {{ .IncidentName }} — {{ .Severity }}",
        "voice": "",
        "dingtalk": "",
        "wecom": "",
        "feishu": "",
        "feishu_app": "",
        "dingtalk_app": "",
        "wecom_app": "",
        "slack_app": "",
        "teams_app": "",
        "telegram": "",
        "slack": "",
        "zoom": "",
        "status": "enabled",
        "creator_id": 80011,
        "updated_by": 80011,
        "created_at": 1712700000,
        "updated_at": 1712702400
      }
    ]
  }
}

{
  "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）

​

使用说明

• 默认返回第 1 页、每页 20 条。响应中的 has_next_page 可以直接告知是否还有下一页，无需额外计数请求。
• 当 is_my_team=true 时 team_ids 字段会被忽略。

授权

app_key · string · query · 必填

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

请求体

application/json

分页过滤条件。默认 p=1、limit=20，limit 上限为 100。

p · integer · 默认值: 1

页码，从 1 开始。

必填范围: x >= 1

示例:

1

limit · integer · 默认值: 20

分页大小，最大 100。

必填范围: 1 <= x <= 100

示例:

20

orderby · enum<string>

排序字段。

可用选项: created_at, updated_at

asc · boolean · 默认值: false

升序排序。

is_my_team · boolean · 默认值: false

为 true 时只返回当前成员所属团队范围内的模板。

team_ids · integer<int64>[]

按团队 ID 列表过滤。

creator_id · integer<int64> | null

按创建人成员 ID 过滤。

query · string

按模板名称做正则或子串匹配。

响应

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