跳转到主要内容
POST
/
template
/
preview
预览模板
curl --request POST \
  --url 'https://api.flashcat.cloud/template/preview?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Incident {{.Title}} is {{.Status}}",
  "type": "feishu_app",
  "incident_id": "664a1b2c3d4e5f6a7b8c9d0e"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "success": true,
    "content": "Incident Database latency spike is Critical",
    "message": ""
  }
}

​
限制说明

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

授权

​
app_key
string
query
必填

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

请求体

application/json
​
content
string
必填

要渲染的模板内容。

​
type
string
必填

决定渲染引擎的模板通道类型。

​
incident_id
string

用于渲染模板的故障 ID，省略时使用模拟数据。MongoDB ObjectID 十六进制字符串。

响应

Success

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。