1. 接口描述
接口请求域名： ses.tencentcloudapi.com 。
添加自定义黑名单
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCustomBlacklist。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。 |
| Emails.N | 是 | Array of String | 添加到黑名单的邮件地址 示例值：[ "a@gmail.com" , "b@gmail.com"] |
| ExpireDate | 否 | Date | 过期日期 示例值："2024-06-19" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 收件人总数 示例值：1 |
| ValidCount | Integer | 实际上传数量 示例值：1 |
| TooLongCount | Integer | 数据过长数量 示例值：1 |
| RepeatCount | Integer | 重复数量 示例值：1 |
| InvalidCount | Integer | 格式不正确数量 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加邮箱地址到黑名单
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomBlacklist
<公共请求参数>
{
"ExpireDate": "2024-06-19",
"Emails": [
"b@gmail.com",
"a@gmail.com"
]
}输出示例
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
}
}示例2 成功示例
成功示例
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomBlacklist
<公共请求参数>
{
"Emails": [
"resrse@sdasd.com",
"resrse@sdasd.com",
"asdasdasdasd"
]
}输出示例
{
"Response": {
"InvalidCount": 1,
"RepeatCount": 1,
"RequestId": "1e6f3195-f832-42a4-87ca-265a80435bc0",
"TooLongCount": 0,
"TotalCount": 3,
"ValidCount": 1
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.WrongDate | 搜索日期错误，请检查日期及格式是否有效。 |
| LimitExceeded.ReceiverDetailRequestLimit | 请求的收件人地址数量超过限制。 |
| MissingParameter.EmailsNecessary | 收件人地址必须传。 |
