Skip to main content

查询邮件模板

分页查询企业邮箱的邮件模板，查看模板标识、是否已自定义及当前生效内容。模板标识可用于调用保存、预览和测试发送接口。

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

认证与请求头

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

请求参数

名称位置类型必填说明示例
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/mail-templates?page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是记录列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

字段对应关系：id 对应编辑接口路径中的 template_id；source.subject、source.html、source.text 对应编辑请求的 subject、html、text，表示当前模板内容。default 为默认模板，不代表已保存的自定义内容；编辑时传入本条记录的 version。 以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
customizedboolean是是否已自定义模板
defaultobject是默认模板
idstring是邮件模板 ID
sourceobject是当前模板
updated_atstring · date-time否更新时间
using_legacy_defaultboolean是是否使用旧版默认模板
variable_definitionsarray<object> ｜ null是模板变量定义
versioninteger · int64是版本号，用于并发更新校验

items[].default 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
htmlstring是HTML 正文
subjectstring是邮件主题
textstring是纯文本正文

items[].source 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
htmlstring是HTML 正文
subjectstring是邮件主题
textstring是纯文本正文

items[].variable_definitions[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
codestring是变量编码
display_namestring是显示名称
exampleany是变量示例值；类型取决于变量定义
maxinteger · int64否最大值
max_lengthinteger · int64否最大长度
mininteger · int64否最小值
patternstring否格式校验正则表达式
purposestring是变量用途
renderedboolean是是否参与模板渲染
requiredboolean是变量是否必填
typestring是变量值类型
{
  "items": [
    {
      "customized": false,
      "default": {
        "html": "<string>",
        "subject": "<string>",
        "text": "<string>"
      },
      "id": "<string>",
      "source": {
        "html": "<string>",
        "subject": "<string>",
        "text": "<string>"
      },
      "updated_at": "2026-08-27T10:00:00Z",
      "using_legacy_default": false,
      "variable_definitions": [
        {
          "code": "<string>",
          "display_name": "<string>",
          "example": "<string>",
          "max": 0,
          "max_length": 0,
          "min": 0,
          "pattern": "<string>",
          "purpose": "<string>",
          "rendered": false,
          "required": false,
          "type": "<string>"
        }
      ],
      "version": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

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>"
}