文档中心>邮件推送>API 文档>批量任务相关接口>添加收件人地址附带模板参数

添加收件人地址附带模板参数

最近更新时间:2024-08-29 02:08:51

我的收藏

1. 接口描述

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

添加收件人地址附带模板参数,使用本接口在添加收件人地址的同时传入模板参数,使每一个收件人地址在发信的时候使用的模板变量取值不同。用户首先调用创建收件人列表接口-CreateReceiver后,然后调用本接口传入收件人地址和发信时的模板参数,最后使用批量发送邮件接口-BatchSendEmail,即可完成批量发信。需要注意的是在使用本接口后BatchSendEmail接口中的Template参数不需再传。用户也可以在控制台上邮件发送-收件人列表菜单中,通过导入文件的方式,导入收件人地址和模板变量和参数值。本接口一次请求的收件人地址数量限制为2W条,本接口同时也可以用来向已经上传完成的收件人列表追加收件人地址,但收件人列表中收件人地址的总量不能超过一定的数量,目前是限制5万条。本接口不支持去除重复的收件人地址,用户需要自己保证上传和追加地址不重复,不与之前上传的地址重复。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateReceiverDetailWithData。
Version String 公共参数,本接口取值:2020-10-02。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-hongkong 。
ReceiverId Integer 收件人列表ID
示例值:1
Datas.N Array of ReceiverInputData 收信人邮箱以及模板参数,数组形式。收件人个数限制20000个以内。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 收件人总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValidCount Integer 实际上传数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TooLongCount Integer 数据过长数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EmptyEmailCount Integer 邮件地址为空数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RepeatCount Integer 重复数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加收件人地址附带模板参数

添加收件人地址附带模板参数

输入示例

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

{
    "ReceiverId": 123,
    "Datas": [
        {
            "Email": "456@bc.com",
            "TemplateData": "{\"name\":\"aa\",\"age\":\"12\"}"
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ServiceNotAvailable 临时性错误,请求未生效,请重试。
InvalidParameterValue.InValidTemplateData 收件人地址附带的模板参数不能包含html标签。
InvalidParameterValue.ReceiverEmailInvalid 收件人地址错误。
InvalidParameterValue.TemplateDataError 模板参数必须为json格式。
InvalidParameterValue.TemplateDataInconsistent 模板参数变量名与之前不一致。
InvalidParameterValue.TemplateDataLenLimit 单条收件人地址附带的模板参数(整个 JSON 结构), 长度超过限制 800 bytes
LimitExceeded.ReceiverDetailCountLimit 该收件人列表包含的收件人地址总量超过限制。
LimitExceeded.ReceiverDetailRequestLimit 请求的收件人地址数量超过限制。
MissingParameter.EmailsNecessary 收件人地址必须传。
OperationDenied.ReceiverIsOperating 收件人列表正在上传中,请稍后操作。
OperationDenied.ReceiverNotExist 收件人列表不存在。