跳转到主要内容
POST
更新模板

限制说明

使用说明

  • template_name 每次都必填且总会被写入。其他字段不传则保持原值;某个通道传空字符串表示清空,之后该通道的通知使用内置预设内容。
  • 请求中每个非空的通道模板都会用模拟故障试渲染一次,任一通道有语法错误整个请求返回 InvalidParameter。wecom_markdown_v2_enabled 为 true 时,wecom 渲染结果不得超过 4,096 字节。
  • incident_card_hidden_fields 和 incident_card_closed_action_apps 一旦传入,整体替换已存的值。
  • template_id 不存在时返回 InvalidParameter;新的 template_name 不能与其他模板重名。
  • 仅账户管理员、模板创建者或模板所属团队的成员可以调用,其他人返回 AccessDenied。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

更新已存在的模板。

template_id
string
必填

目标模板 ID,可通过 POST /template/list 获取。

Pattern: ^[0-9a-fA-F]{24}$
示例:

"6605a1b2c3d4e5f6a7b8c9d0"

template_name
string
必填

模板名称,1–39 个字符。每次调用都必填且会被写入;不能与其他模板重名。

Required string length: 1 - 39
team_id
integer<int64> | null

团队归属。0 表示账户全局共享。省略时保持模板当前的团队归属。

description
string | null

自定义描述。最多 500 字符。省略时保持当前内容;传空字符串表示清空。

Maximum string length: 500
email
string | null

邮件正文模板源(Go html/template 语法)。省略时保持当前内容;传空字符串表示清空。

sms
string | null

短信模板源(Go text/template 语法)。省略时保持当前内容;传空字符串表示清空。

voice
string | null

语音呼叫脚本模板源。省略时保持当前内容;传空字符串表示清空。

dingtalk
string | null

钉钉群机器人消息模板源。省略时保持当前内容;传空字符串表示清空。

wecom
string | null

企业微信群机器人消息模板源。省略时保持当前内容;传空字符串表示清空。

wecom_markdown_v2_enabled
boolean | null

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

feishu
string | null

飞书群机器人消息模板源。省略时保持当前内容;传空字符串表示清空。

feishu_app
string | null

飞书应用消息模板源。省略时保持当前内容;传空字符串表示清空。

feishu_app_card_v2_table_enabled
boolean | null

将 feishu_app 内容中的 Markdown 表格渲染为飞书卡片原生表格。不传则保持不变。

feishu_app_card_v2_preserve_blank_lines
boolean | null

设置后决定飞书应用卡片 v2 消息是否保留正文空行;省略时保持当前设置。

feishu_app_war_room_enabled
boolean | null

设置后决定飞书应用卡片是否展示「创建作战室」按钮;省略时保持当前设置。

dingtalk_app_war_room_enabled
boolean | null

设置后决定钉钉应用卡片是否展示「创建作战室」按钮;省略时保持当前设置。

slack_app_war_room_enabled
boolean | null

设置后决定 Slack 应用卡片是否展示「创建作战室」按钮;省略时保持当前设置。

dingtalk_app
string | null

钉钉应用消息模板源。省略时保持当前内容;传空字符串表示清空。

wecom_app
string | null

企业微信应用消息模板源。省略时保持当前内容;传空字符串表示清空。

slack_app
string | null

Slack 应用消息模板源。省略时保持当前内容;传空字符串表示清空。

teams_app
string | null

Microsoft Teams 应用消息模板源。省略时保持当前内容;传空字符串表示清空。

telegram
string | null

Telegram 机器人消息模板源。省略时保持当前内容;传空字符串表示清空。

slack
string | null

Slack 机器人消息模板源。省略时保持当前内容;传空字符串表示清空。

zoom
string | null

Zoom 机器人消息模板源。省略时保持当前内容;传空字符串表示清空。

incident_card_closed_action_apps
enum<string>[]

传入时整体替换保留自定义操作按钮的应用列表。可选值: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

空对象。当操作的成功信号就是不报错时,作为 data 返回。