Release Notes
Announcement on a Newly Added Independent IP Value-Added Service
Domain name for API request: ses.intl.tencentcloudapi.com.
The API is used to get blocklisted addresses. In the case of a hard bounce, Tencent Cloud will blocklist the recipient address and do not allow any user to send emails to this address. If you confirm that this is a misjudgment, you can remove it from the blocklist.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ListBlackEmailAddress. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-02. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| StartDate | Yes | Date | Start date in the format of YYYY-MM-DD |
| EndDate | Yes | Date | End date in the format of YYYY-MM-DD |
| Limit | Yes | Integer | Common parameter. It must be used with Offset. |
| Offset | Yes | Integer | Common parameter. It must be used with Limit. Maximum value of Limit: 100. |
| EmailAddress | No | String | You can specify an email address to query. |
| TaskID | No | String | This parameter has been deprecated. |
| Parameter Name | Type | Description |
|---|---|---|
| BlackList | Array of BlackEmailAddress | List of blocklisted addresses. |
| TotalCount | Integer | Total number of blocklisted addresses. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListBlackEmailAddress
<Common request parameters>
{
"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
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidLimit | Reached the query limit (100). |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.WrongDate | Incorrect search date. Make sure the date and its format are valid. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback