ListReceiverDetails

Download PDF

Last updated:2026-01-27 16:34:35

ListReceiverDetails

Last updated: 2026-01-27 16:34:35

Download PDF

1. API Description

Domain name for API request: ses.intl.tencentcloudapi.com.

Query ALL recipient email addresses in the recipient list based on the recipient list id with paging query. Filter queries can be based on the recipient email address.

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 Params. The value used for this API: ListReceiverDetails.
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.
ReceiverId	Yes	Integer	Recipient list ID. specifies the value returned during API creation of a recipient list via the CreateReceiver api.
Offset	Yes	Integer	Offset, int, starts from 0.
Limit	Yes	Integer	Number limit, int, no more than 100.
Email	No	String	Recipient address. length: 0-50. example: xxx@te.com. fuzzy query is supported.
CreateTimeBegin	No	String	Find start time.
CreateTimeEnd	No	String	Search end time.
Status	No	Integer	1: valid; 2: invalid.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number.
Data	Array of ReceiverDetail	Data record.
ValidCount	Integer	Number of valid email addresses.
InvalidCount	Integer	Number of invalid email 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.

4. Example

Example1 Query a Certain Recipient List Detail

Input Example

POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListReceiverDetails
<Common request parameters>

{
    "ReceiverId": 123,
    "Email": "abc@ec.cm",
    "Offset": 1,
    "Limit": 10
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Data": [
            {
                "Email": "abc@cd.com",
                "CreateTime": "2021-09-28 16:40:35",
                "TemplateData": "{\"name\":\"1\"}"
            }
        ],
        "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

Tencent Cloud CLI 3.0

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).
InternalError	Internal error.
OperationDenied.ReceiverNotExist	The recipient group does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud