邮件推送批量发送邮件-批量任务相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： ses.tencentcloudapi.com 。

您可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前，需先创建收件人列表，和收件人地址，并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送，定时发送需传TimedParam，周期重复发送需传CycleParam

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：BatchSendEmail。
Version	是	String	公共参数，本接口取值：2020-10-02。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。
FromEmailAddress	是	String	发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com。如需填写发件人说明，请按照发信人 <邮件地址> 的方式填写，例如：腾讯云团队 <noreply@mail.qcloud.com> 示例值：abc@ef.com
ReceiverId	是	Integer	收件人列表ID 示例值：123
Subject	是	String	邮件主题示例值：邮件主题
TaskType	是	Integer	任务类型 1: 立即发送 2: 定时发送 3: 周期（频率）发送示例值：1
ReplyToAddresses	否	String	邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。示例值：abc@ef.com
Template	否	Template	使用模板发送时，填写的模板相关参数注意如您未申请过特殊配置，则该字段为必填

| Simple | 否 | Simple | 已废弃

说明

仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置，则不存在该字段。

3. 输出参数

参数名称	类型	描述
TaskId	Integer	发送任务ID 示例值：123
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增批量发送任务

输入示例

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchSendEmail
<公共请求参数>

{
    "Attachments": [
        {
            "Content": "附件内容",
            "FileName": "文件名"
        }
    ],
    "TimedParam": {
        "BeginTime": "2021-09-10 11:10:11"
    },
    "FromEmailAddress": "abc@bbc.com",
    "ReplyToAddresses": "abc@bbc.com",
    "Simple": {
        "Text": "text",
        "Html": "html"
    },
    "ReceiverId": 123,
    "Template": {
        "TemplateData": "{\"name\":\"123\"}",
        "TemplateID": 1
    },
    "CycleParam": {
        "IntervalTime": 1,
        "BeginTime": "2021-09-10 11:10:11"
    },
    "Subject": "邮件主题",
    "TaskType": 1,
    "ADLocation": 0
}

输出示例

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "TaskId": 123
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.EmailContentToolarge	邮件内容太大，请减少发送邮件内容。
InternalError	内部错误。
InvalidParameterValue.BeginTimeBeforeNow	开始时间不能早于当前时间。
InvalidParameterValue.EmailContentIsWrong	邮件内容错误，请检查TEXT/HTML base64是否正确。
InvalidParameterValue.SubjectLengthError	邮件主题长度必须为1-100。
InvalidParameterValue.TemplateDataError	模板参数必须为json格式。
InvalidParameterValue.TemplateNotMatchData	模板变量与收件人列表参数不一一对应。
MissingParameter.CycleParamNecessary	周期发送任务需选择开始时间和间隔时间。
MissingParameter.SendParamNecessary	发件地址、收件人列表,发件模板必须传。
MissingParameter.TimedParamNecessary	定时发送任务需选择开始时间。
OperationDenied.ReceiverNotExist	收件人列表不存在。
OperationDenied.ReceiverStatusError	收件人列表空或状态不是上传完成。
OperationDenied.SendAddressStatusError	发信地址不存在或者状态不是通过状态。
OperationDenied.TemplateStatusError	发信模板不存在或者状态不是审核通过状态。

批量发送邮件

本页目录：