ListBlackEmailAddress

Last updated: 2021-02-02 11:44:44

1. API Description

Domain name for API request: ses.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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: ListBlackEmailAddress.
Version Yes String Common parameter. The value used for this API: 2020-10-02.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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 You can specify a task ID to query.

3. Output Parameters

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting blocklisted email addresses

Input Example

POST / HTTP/1.1
Host: ses.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
}

Output Example

{
  "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help