创建收件人列表

最近更新时间:2024-03-12 01:46:33

我的收藏

1. 接口描述

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

创建收件人列表,收件人列表是发送批量邮件的目标邮件地址列表。创建列表后,需要上传收件人邮箱地址。之后创建发送任务,关联列表,便可以实现批量发送邮件的功能

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateReceiver。
Version String 公共参数,本接口取值:2020-10-02。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-hongkong 。
ReceiversName String 收件人列表名称
示例值:收件人列表
Desc String 收件人列表描述
示例值:收件人列表描述

3. 输出参数

参数名称 类型 描述
ReceiverId Integer 收件人列表id,后续根据收件人列表id上传收件人地址
示例值:123
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建收件人列表

输入示例

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

{
    "ReceiversName": "收件人列表名称",
    "Desc": "列表描述"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue.ReceiverDescIllegal 收件人列表描述不合法,描述不可包含特殊字符,字符长度范围:1~300。
InvalidParameterValue.ReceiverNameIllegal 收件人列表名字不合法,请检查字符内容及大小。
InvalidParameterValue.RepeatReceiverName 收件人列表名称重复。
LimitExceeded.ExceedReceiverLimit 收件人列表数量超过限制。