跳转到主要内容
POST
/
template
/
create
创建模板
curl --request POST \
  --url 'https://api.flashcat.cloud/template/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_id": 0,
  "template_name": "生产环境默认模板",
  "description": "生产环境故障的默认模板。",
  "email": "Incident {{ .IncidentName }} on {{ .Severity }}",
  "sms": "[Flashduty] {{ .IncidentName }} — {{ .Severity }}"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "template_id": "6605a1b2c3d4e5f6a7b8c9d0",
    "template_name": "生产环境默认模板"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求模板管理on-call

使用说明

  • template_name 必须在账户内唯一,重名会返回 InvalidParameter
  • 服务端会对所有非空通道按 Mock 故障做一次渲染校验,任何通道的语法错误都会导致整个请求返回 InvalidParameter
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

创建通知模板。

template_name
string
必填

模板名称,同一账户内唯一,长度 1–39 个字符。

Required string length: 1 - 39
示例:

"生产环境默认模板"

team_id
integer<int64>
默认值:0

团队归属。0 表示账户全局共享。

description
string

自定义描述。最多 500 字符。

Maximum string length: 500
email
string

邮件正文模板源(Go html/template 语法)。

sms
string

短信模板源(Go text/template 语法)。

voice
string

语音呼叫脚本模板源。

dingtalk
string

钉钉群机器人消息模板源。

wecom
string

企业微信群机器人消息模板源。

feishu
string

飞书群机器人消息模板源。

feishu_app
string

飞书应用消息模板源。

dingtalk_app
string

钉钉应用消息模板源。

wecom_app
string

企业微信应用消息模板源。

slack_app
string

Slack 应用消息模板源。

teams_app
string

Microsoft Teams 应用消息模板源。

telegram
string

Telegram 机器人消息模板源。

slack
string

Slack 机器人消息模板源。

zoom
string

Zoom 机器人消息模板源。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

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