邮件推送获取黑名单邮箱地址-API 文档-文档中心-腾讯云

1. 接口描述

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

腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListBlackEmailAddress。
Version	是	String	公共参数，本接口取值：2020-10-02。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。
StartDate	是	Date	开始日期，格式为YYYY-MM-DD 示例值：2023-09-01
EndDate	是	Date	结束日期，格式为YYYY-MM-DD 示例值：2023-09-02
Limit	是	Integer	规范，配合Offset使用示例值：10
Offset	是	Integer	规范，配合Limit使用，Limit最大取值为100 示例值：0
EmailAddress	否	String	可以指定邮箱进行查询示例值：xx@gmail.com
TaskID	否	String	已废弃

3. 输出参数

参数名称	类型	描述
BlackList	Array of BlackEmailAddress	黑名单列表示例值： "BlackList": [ { "BounceTime": "2023-09-06 11:21:35", "EmailAddress": "xxx@gmail.com", "IspDesc": "550 5.1.1 The email account that you tried to reach does not exist. Please try\n5.1.1 double-checking the recipient's email addre" } ]
TotalCount	Integer	黑名单总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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": "2023-09-06 11:21:35",
                "EmailAddress": "xxx@gmail.com",
                "IspDesc": "550 5.1.1 The email account that you tried to reach does not exist. Please try\n5.1.1 double-checking the recipient's email addre"
            }
        ],
        "RequestId": "e54b9d01-2bcb-43f6-83dd-55a91a3cd2bb",
        "TotalCount": 2
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.InvalidLimit	超过查询限制，Limit最大支持100。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.WrongDate	搜索日期错误，请检查日期及格式是否有效。
OperationDenied	操作被拒绝。
RequestLimitExceeded	请求的次数超过了频率限制。

获取黑名单邮箱地址

本页目录：