添加邮件模板

更新时间：2023-06-15 05:31:43

本文介绍添加邮件模板的 API。

接口描述

根据模板名称、标题、模板内容等信息添加邮件模板。

接口地址

POST: /v1.0/iot-03/msg-templates/mails

请求参数

body 说明

参数名	类型	是否必填	说明
name	String	true	模板名称，长度为 1~30 个字符
title	String	true	模板标题，长度为 1~50 个字符
sender_name	String	true	发件人名称，长度为1~30个字符。例如：设置为”小明”，发信地址为 test@example.com，收信人看到的发信地址为“小明”test@example.com
content	String	true	模板内容，支持 HTML 和 TEXT 格式文本，最大容量为 28 KB
type	Integer	true	邮件类型，0：验证码，1：邮件通知，2：推广邮件
remark	String	true	邮件模板申请说明。请在申请说明中描述您的业务使用场景，长度为1~100 个字符

返回参数

参数名	类型	说明
result	MsgTemplatesRes

result 说明

参数名	类型	说明
template_id	String	模板 ID。返回的模板 ID 审核通过后才会生效，请耐心等待审核结果。

请求示例

POST: /v1.0/iot-03/msg-templates/mails

{
  "name": "邮件验证码模板",
  "sender_name": "小明",
  "title": "验证码",
  "content": "您正在申请邮箱注册，验证码为：${code}，5分钟内有效！",
  "type": 0,
  "remark": "当前的邮件模板应用于注册场景"
}

返回示例

{
    "result": {
        "template_id": "MAIL_1616396456"
    },
    "t": 1586153261345,
    "success": true
}

错误码

参考错误码。

邮件公共模版（中文）

同时为了帮助开发者更快调通，提供了以下公共模版，通过模版 ID 即可立刻调用，无需创建新模版。

模版 ID	消息类型	名称	内容
MAIL_1624531364	验证码	验证码	以下是您的验证码${code}为了您的账号安全，请不要将验证码分享给其他人。
MAIL_1624531381	验证码	找回密码	您好，您正在进行密码找回操作，验证码为${code}为了您的账号安全，请不要将验证码分享给其他人。
MAIL_1624531577	邮件通知	登录验证	您的账号在${platform}登录如非本人操作，请立即联系我们的客服。

邮件公共模版（英文）

Below are the public templates we provide, and they are the quickstart tools for all developers. By default, all developers who subscribe to the email service have access to the public templates, and simply use the public templates by inputing “tempalte id” from the table below when send emails.

Template ID	Message Type	Title	Message Content
MAIL_1624531323	Verification	Verification Code	Below is your verification code ${code}. For your account security, please do not share this code with others.
MAIL_1624531338	Verification	Password Retrieval	You have submitted a request for password retrival, the confirmation code is ${code}. For your account security, please do not share this confirmation code with others.

上一篇获取邮件模板清单

下一篇短信服务