跳转到主要内容
POST
创建模板

限制说明

使用说明

  • 需要专业版或更高版本的订阅,否则返回 NoLicense。
  • template_name 在账户未删除的模板中必须唯一,且不能与内置预设模板在任一支持语言下的名称相同,否则返回 InvalidParameter。
  • 每个非空的通道模板都会用模拟故障试渲染一次,任一通道有语法错误整个请求返回 InvalidParameter。wecom_markdown_v2_enabled 为 true 时,wecom 渲染结果不得超过 4,096 字节。
  • 留空的通道在发送通知时使用内置预设内容。
  • team_id 非 0 时必须是已存在的团队,否则返回 InvalidParameter。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

创建通知模板。

template_name
string
必填

模板名称,1–39 个字符,在账户未删除的模板中唯一,且不能与内置预设模板在任一支持语言下的名称相同。

Required string length: 1 - 39
示例:

"Prod incident default"

team_id
integer<int64>
默认值:0

所属团队 ID,可通过 POST /team/list 获取;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

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

wecom_markdown_v2_enabled
boolean

企业微信机器人通知使用 markdown_v2 消息格式而非普通 markdown。开启时 wecom 渲染结果不得超过 4,096 字节。

feishu
string

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

feishu_app
string

飞书应用消息模板源。

feishu_app_card_v2_table_enabled
boolean
默认值:false

将 feishu_app 内容中的 Markdown 表格渲染为飞书卡片原生表格。

feishu_app_card_v2_preserve_blank_lines
boolean

飞书应用卡片 v2 消息保留正文中的空行。

feishu_app_war_room_enabled
boolean

飞书应用卡片展示「创建作战室」按钮。

dingtalk_app_war_room_enabled
boolean

钉钉应用卡片展示「创建作战室」按钮。

slack_app_war_room_enabled
boolean

Slack 应用卡片展示「创建作战室」按钮。

dingtalk_app
string

钉钉应用消息模板源。

wecom_app
string

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

slack_app
string

Slack 应用消息模板源。

teams_app
string

Microsoft Teams 应用消息模板源。

telegram
string

Telegram 机器人消息模板源。

slack
string

Slack 机器人消息模板源。

zoom
string

Zoom 机器人消息模板源。

incident_card_closed_action_apps
enum<string>[]

已关闭故障的卡片仍保留自定义操作按钮的 IM 应用。可选值:feishu_app、dingtalk_app、wecom_app、slack_app、teams_app;空列表表示所有应用都隐藏这些按钮。

可用选项:
feishu_app,
dingtalk_app,
wecom_app,
slack_app,
teams_app
incident_card_hidden_fields
object

按 IM 应用类型配置要隐藏的故障卡片字段。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

创建模板响应。