接口请求域名: ses.intl.tencentcloudapi.com 。
创建收件人列表,收件人列表是发送批量邮件的目标邮件地址列表。创建列表后,需要上传收件人邮箱地址。之后创建发送任务,关联列表,便可以实现批量发送邮件的功能
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateReceiver。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-02。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-singapore 。 |
| ReceiversName | 是 | String | 收件人列表名称 |
| Desc | 否 | String | 收件人列表描述 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReceiverId | Integer | 收件人列表id,后续根据收件人列表id上传收件人地址 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReceiver
<公共请求参数>
{
"ReceiversName": "收件人列表名称",
"Desc": "列表描述"
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
"ReceiverId": 123
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue.ReceiverDescIllegal | 收件人列表描述不合法,描述不可包含特殊字符,字符长度范围:1~300。 |
| InvalidParameterValue.ReceiverNameIllegal | 收件人列表名字不合法,请检查字符内容及大小。 |
| InvalidParameterValue.RepeatReceiverName | 收件人列表名称重复。 |
| LimitExceeded.ExceedReceiverLimit | 收件人列表数量超过限制。 |
文档反馈