1. 接口描述
接口请求域名: ses.tencentcloudapi.com 。
腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce),腾讯云会拉黑该地址,并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判,可以从黑名单中删除。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListBlackEmailAddress。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-02。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
StartDate | 是 | Date | 开始日期,格式为YYYY-MM-DD |
EndDate | 是 | Date | 结束日期,格式为YYYY-MM-DD |
Limit | 是 | Integer | 规范,配合Offset使用 |
Offset | 是 | Integer | 规范,配合Limit使用,Limit最大取值为100 |
EmailAddress | 否 | String | 可以指定邮箱进行查询 |
TaskID | 否 | String | 可以指定任务ID进行查询 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BlackList | Array of BlackEmailAddress | 黑名单列表 |
TotalCount | Integer | 黑名单总数 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取黑名单邮箱地址
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListBlackEmailAddress
<公共请求参数>
{
"StartDate": "2020-09-22",
"EndDate": "2020-09-22",
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"BlackList": [
{
"BounceTime": "2020-09-22 00:00:00",
"EmailAddress": "432843@qq.com"
},
{
"BounceTime": "2020-10-22 12:10:00",
"EmailAddress": "43fdaf2843@gmail.com"
}
],
"TotalCount": 2,
"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。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InvalidLimit | 超过查询限制,Limit最大支持100。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.WrongDate | 搜索日期错误,请检查日期及格式是否有效。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |