ListReceivers

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

ListReceivers

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

1. API Description

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

This API is used to query recipient groups. It supports pagination, fuzzy query, and query by status.

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: ListReceivers.
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.
Offset	Yes	Integer	Offset, starting from 0. The value is an integer.
Limit	Yes	Integer	Number of records to query. The value is an integer not exceeding 100.
Status	No	Integer	Group status (`1`: to be uploaded; `2` uploading; `3` uploaded). To query groups in all states, do not pass in this parameter.
KeyWord	No	String	Group name keyword for fuzzy query

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number
Data	Array of ReceiverData	Data record
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 Querying the Recipient List

Input Example

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

{
    "Status": 1,
    "Offset": 1,
    "Limit": 1,
    "KeyWord": "keyword"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Data": [
            {
                "Count": 1,
                "ReceiversStatus": 1,
                "ReceiverId": 123,
                "ReceiversName": "name",
                "CreateTime": "2021-09-28 16:40:35",
                "Desc": "some description"
            }
        ],
        "RequestId": "38049379278d43208c59916a4806b0c4"
    }
}

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.

Was this page helpful?

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

Yes

Feedback

tencent cloud