Skip to main content

预览邮件模板草稿

使用提交的草稿内容渲染邮件模板，返回渲染后的主题和正文。此接口只做预览，不保存草稿也不发送邮件。

  • Scope：admin.v1.mail-settings.read
  • 权限项：企业邮箱读取（mail-settings）
  • 权限类型：读取
  • 接口：POST/api/openapi/v1/mail-templates/{template_id}/preview

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
template_idpathstring必填模板 ID"<string>"
htmlbodystring必填HTML 正文"<string>"
subjectbodystring必填邮件主题"<string>"
textbodystring必填纯文本正文"<string>"

请求示例

curl --request POST \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/mail-templates/<template_id>/preview' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "html": "<string>",
  "subject": "<string>",
  "text": "<string>"
}'

响应

200 OK

名称类型必填说明示例
htmlstring是HTML 正文"<string>"
subjectstring是邮件主题"<string>"
textstring是纯文本正文"<string>"
{
  "html": "<string>",
  "subject": "<string>",
  "text": "<string>"
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否测试结果详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}