模板 API

您可以通过此 API 使用模板发送电子邮件。请参阅模板帮助文档，了解如何创建模板以及适合您的 API。

先决条件：

通过此 API 发送电子邮件时，您需要使用模板的参考 ID。

关于复制模板标识的步骤：

导航至 ZeptoMail 帐户左侧面板上的邮件代理选项卡，然后选择“邮件代理”。
将光标悬停在模板选项卡上。
从预先存在的模板中选择要使用的模板，或创建新模板。
使用复制图标复制模板的模板 ID。

使用模板发送单一电子邮件

用途

此 API 用于使用模板发送事务性电子邮件。它可用于使用模板一次发送一封电子邮件。

请求 URL

https://api.zeptomail.com/v1.1/email/template

授权令牌

您需要添加发送邮件令牌以验证 API 请求。这是 ZeptoMail 帐户中的唯一令牌，您可以在邮件代理中生成该令牌。调用 ZeptoMail REST 电子邮件发送 API 时，使用发送邮件令牌作为标头。

例如

POST /v1.1/email/template

查询字符串：

POST
HOST: https://api.zeptomail.com
Header:
Authorization: zoho-enczapikey <space> <send mail token>

使用模板发送批量电子邮件

用途

此 API 用于使用模板发送事务性电子邮件。它可用于使用模板发送一批电子邮件。

请求 URL

https://api.zeptomail.com/v1.1/email/template/batch

授权令牌

例如

POST /v1.1/email/template/batch

查询字符串：

POST
HOST: https://api.zeptomail.com
Header:
Authorization: zoho-enczapikey <space> <send mail token>

请求正文

* - 必需参数

参数		数据类型	说明
mail_template_key		字符串	模板的唯一密钥标识符。
bounce_address		字符串	退回电子邮件将发送到的电子邮件地址。允许的值 - 在邮件代理中配置的有效退回电子邮件地址。
from		JSON 对象	允许的值 - 具有“address”和“name”键值对的有效发件人电子邮件地址
	address	字符串	包含邮件代理中经过验证的域的有效电子邮件地址。
	name	字符串	发件人名称。
to		JSON 数组	允许的值 - email_address 的 JSON 对象。
	email_address	JSON 对象	具有“address”和“name”键值对的有效收件人电子邮件地址。
	address	字符串	收件人的电子邮件地址字段。
	name	字符串	收件人名称。
reply_to		JSON 数组	允许的值 - reply_to 电子邮件地址的 JSON 对象。
	address	字符串	收件人的电子邮件回复将发送到的电子邮件地址。允许的值 - 包含邮件代理中经过验证的域的有效电子邮件地址。
	name	字符串	reply-to 参数的名称。
merge_info		JSON 对象	要发送的邮件的合并标签。可以在 HTML 正文、文本正文、主题和客户端引用中设置合并标签。合并标签是在字符串中设置的标签。这些标签将被替换为此参数中为该标签提供的值。对于单一电子邮件 API，合并标签对所有收件人通用。对于批量电子邮件，合并标签特定于每个收件人。
track_clicks		布尔值	您可以在此处启用或禁用电子邮件点击跟踪。您还可以在邮件代理的“电子邮件跟踪”部分启用电子邮件点击跟踪。注意：API 设置将覆盖 ZeptoMail 帐户中的邮件代理设置。允许的值 True - 启用电子邮件点击跟踪。 False - 禁用电子邮件点击跟踪。
track_opens		布尔值	您可以启用或禁用电子邮件打开跟踪。您也可以在邮件代理的“电子邮件跟踪”部分启用电子邮件打开跟踪。注意：API 设置将覆盖 ZeptoMail 帐户中的邮件代理设置。允许的值 True - 启用电子邮件打开跟踪。 False - 禁用电子邮件打开跟踪。
client_reference		字符串	用户为跟踪特定事务而设置的标识符。
mime_headers		JSON 对象	在电子邮件中发送的附加标题，供您参考。
attachments		JSON 数组	要添加到事务性电子邮件的附件。单击此处查看不支持的格式列表。允许的值 - 附件的 JSON 对象。可以是 base64 编码的内容和/或 file_cache_key。
	content	字符串	附件的内容。允许的值 - 文件的 Base64 编码值。
	mime_type	字符串	指示附件中的内容类型。允许的值简单文本消息 - 纯文本/文本 image 文件 - 图片/jpg
	name		附件的文件名。
	file_cache_key	字符串	邮件代理中附加文件的唯一密钥。从邮件代理的“文件缓存”部分获取 file_cache_key。
	name	字符串	附件的文件名，与邮件代理的“文件缓存”部分中的文件名一致。从邮件代理的“文件缓存”部分获取文件名。
cid		字符串	html 正文用于内容查找的内容 ID。每个内容都应具有单独的 cid 值。允许的值可以是base64 编码的内容和/或 file_cache_key。

成功响应参数

参数	数据类型	说明
data	JSON 数组	它由 code、additional _info 和 message 参数组成
code	字符串	与成功响应对应的代码
additional_info	JSON 数组	提供有关请求中执行的操作的附加信息
message	字符串	针对此请求执行的操作
message	字符串	请求的状态
request_id	字符串	为每个请求生成的唯一 ID
object	电子邮件	它表示响应针对的是电子邮件 API

失败响应参数

参数	数据类型	说明
error	JSON 对象	它由 code、details、message 和 request_id 参数组成
code	字符串	与请求状态对应的代码
details	JSON 数组	它由 code、message 和 target 参数组成
target_value	字符串	为每个请求生成的唯一 ID
code	字符串	所发现的错误的代码
message	字符串	错误原因
target	字符串	导致错误的字段
message	字符串	请求的状态

HTTP 状态代码

状态代码	说明
2xx	成功
4xx	失败。需要在用户端执行操作来修复错误。
5xx	失败。需要在 ZeptoMail 服务器端执行操作来修复错误。

错误代码

API 错误代码

注意：

在您开始之前，请务必了解 ZeptoMail 用于发送诸如欢迎邮件、密码重置电子邮件、OTP 等事务性电子邮件。我们不支持发送批量电子邮件或促销电子邮件（例如，时事通讯或营销活动电子邮件）。如果您正在寻找批量电子邮件提供商，可以访问 Zoho Campaigns。

单一电子邮件

请求示例


				curl "https://api.zeptomail.com/v1.1/email/template" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-enczapikey ***" \
-d {
    "mail_template_key": "ea36f19a.2bec9ad9c994ee6f.k1.7207ab80-da56-11eb-850c-525400256d50.17a6198be38",
    "bounce_address": "bounce@bounce.zylker.com",
    "from": {
        "address": "rebecca@zylker.com",
        "name": "Rebecca"
    },
    "to": [
        {
            "email_address": {
                "address": "paula@zylker.com",
                "name": "Paula M"
            }
        },
        {
            "email_address": {
                "address": "charles@zylker.com",
                "name": "Charles"
            }
        }
    ],
    "cc": [
        {
            "email_address": {
                "address": "tucker@zylker.com",
                "name": "Tucker"
            }
        },
        {
            "email_address": {
                "address": "vienna@zylker.com",
                "name": "Vienna"
            }
        }
    ],
    "bcc": [
        {
            "email_address": {
                "address": "priya@zylker.com",
                "name": "Priya"
            }
        },
        {
            "email_address": {
                "address": "Selena@zylker.com",
                "name": "Selena"
            }
        }
    ],
             "merge_info": {
                  "meeting_link":"https://meeting.zoho.com/join?key=103666049*************22c92ca4"
    },
    "reply_to": [
        {
            "address": "rebecca@zylker.com",
            "name": "Rebecca"
        }
    ],
    "client_reference": "1234",
    "mime_headers": {
        "X-Test": "test"
    }
}'

响应示例


				{
  "data": [
    {
      "code": "EM_104",
      "additional_info": [],
      "message": "Email request received"
    }
  ],
  "message": "OK",
  "request_id": "ea36f19a.2bec9ad9c994ee6f.m1.cc7d93d0-e966-11eb-95aa-525400ada42a.17ac451bd8d",
  "object": "email"
}

批量电子邮件

请求示例


				curl "https://api.zeptomail.com/v1.1/email/template/batch" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-enczapikey ***" \
-d {
    "mail_template_key": "ea36f19a.2bec9ad9c994ee6f.k1.7207ab80-da56-11eb-850c-525400256d50.17a6198be38",
    "bounce_address": "bounce@bounce.zylker.com",
    "from": {
        "address": "rebecca@zylker.com",
        "name": "Rebecca"
    },
    "to": [
        {
            "email_address": {
                "address": "paula@zylker.com",
                "name": "Paula"
            },
            "merge_info": {
                "contact": "960*******23",
                "company": "Zylker"
            }
        },
        {
            "email_address": {
                "address": "charles@zylker.com",
                "name": "Charles"
            },
            "merge_info": {
                "contact": "860*******13",
                "company": "Zillum"
            }
        }
    ],
    "reply_to": [
        {
            "address": "rebecca@zylker.com",
            "name": "Rebecca"
        }
    ],
    "client_reference": "1234",
    "mime_headers": {
        "X-Test": "test"
    }
}'

响应示例


				{
  "data": [
    {
      "code": "EM_104",
      "additional_info": [],
      "message": "Email request received"
    }
  ],
  "message": "OK",
  "request_id": "ea36f19a.2bec9ad9c994ee6f.b1.1567dc40-e96c-11eb-bfc9-525400256d50.17ac4746004",
  "object": "email"
}

模板 API

目录

先决条件：

使用模板发送单一电子邮件

用途

请求 URL

授权令牌

例如

查询字符串：

使用模板发送批量电子邮件

用途

请求 URL

授权令牌

例如

查询字符串：

请求正文

成功响应参数

失败响应参数

HTTP 状态代码

错误代码

单一电子邮件

批量电子邮件