跳转到主要内容
POST
预览模板

限制说明

使用说明

  • 传 incident_id 时用该故障渲染(须为账户内存在的故障,否则返回 InvalidParameter),否则用模拟故障。content 为空时预览该通道的内置预设内容。
  • 模板错误不会返回 HTTP 错误:响应中 success 为 false,message 说明原因。
  • card 描述渲染结果外层的消息框架(邮件主题、IM 应用卡片的元素和按钮),仅 email、feishu_app、dingtalk_app、wecom_app、slack_app、teams_app 返回,其他类型省略。依赖集成的按钮(AI 分析、作战室)不会出现。
  • incident_card_hidden_fields 作用于 IM 应用卡片;不支持的应用类型或字段名返回 InvalidParameter。
  • 该接口不会发送消息,也不会保存任何内容。

授权

app_key
string
query
必填

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

请求体

application/json

模板预览请求。

type
enum<string>
必填

要预览的通道,其他取值返回 InvalidParameter。

  • email:邮件正文(HTML 模板)。
  • sms、voice:短信文本和语音电话话术。
  • push:移动 App 推送(内容固定,忽略 content)。
  • dingtalk、wecom、feishu、zoom、telegram、slack:机器人(Webhook)消息。
  • feishu_app、dingtalk_app、wecom_app、slack_app、teams_app:IM 应用卡片。
可用选项:
email,
sms,
voice,
push,
dingtalk,
wecom,
feishu,
zoom,
telegram,
slack,
feishu_app,
dingtalk_app,
wecom_app,
slack_app,
teams_app
content
string

按通道 type 渲染的模板内容。为空或不传时预览该通道的内置预设内容;push 类型忽略此字段。

incident_id
string

用于渲染的故障 ID(24 位十六进制,可通过 /incident/list 获取),须为账户内存在的故障,否则返回 InvalidParameter。不传时使用模拟故障。

Pattern: ^[0-9a-fA-F]{24}$
incident_card_hidden_fields
object

预览时按 IM 应用隐藏的故障卡片字段。

feishu_app_card_v2_table_enabled
boolean
默认值:false

将 feishu_app 内容中的 Markdown 表格渲染为飞书卡片原生表格,与模板的同名设置一致。

feishu_app_card_v2_preserve_blank_lines
boolean

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

wecom_markdown_v2_enabled
boolean
默认值:false

按 markdown_v2 消息预览 wecom 内容,与模板的同名设置一致(大小上限 4,096 字节)。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

模板预览结果。