接口请求域名: ses.intl.tencentcloudapi.com 。
获取自定义黑名单列表
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListCustomBlacklist。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-02。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-singapore 。 |
| Offset | 是 | Integer | 偏移量,整型,从0开始 |
| Limit | 是 | Integer | 限制数目,整型,不超过100 |
| Status | 是 | Integer | 筛选黑名单的状态,0:已过期,1:生效中, 2:全部 |
| 否 | String | 黑名单中的邮箱地址 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 列表总数 |
| Data | Array of BlackAddressDetail | 黑名单列表详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListCustomBlacklist
<公共请求参数>
{
"Offset": 1,
"Limit": 1,
"Status": 1,
"Email": "abc@mail.com"
}
{
"Response": {
"Data": [
{
"CreateTime": "2024-06-26 10:04:43",
"Email": "abc@foxmail.com",
"ExpireDate": "2024-06-27",
"Id": 304323,
"Status": 1
},
{
"CreateTime": "2024-06-25 14:27:38",
"Email": "abc@abc.com",
"ExpireDate": "2024-06-26",
"Id": 304320,
"Status": 0
}
],
"RequestId": "3df4264a-a5c9-4a4d-abfe-770c730ca683",
"TotalCount": 293023
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InvalidLimit | 超过查询限制,Limit最大支持100。 |
| InternalError | 内部错误。 |
文档反馈