tencent cloud



Last updated: 2023-06-12 16:22:44

1. API Description

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

This API is used to create a recipient group, which is the list of target email addresses for batch sending emails. After creating a group, you need to upload recipient email addresses. Then, you can create a sending task and select the group to batch send emails.

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: CreateReceiver.
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.
ReceiversName Yes String Recipient group name
Desc No String Recipient group description

3. Output Parameters

Parameter Name Type Description
ReceiverId Integer Recipient group ID, by which recipient email addresses are uploaded
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a recipient group

Input Example

Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReceiver
<Common request parameters>

    "ReceiversName": "Recipient group name",
    "Desc": "Recipient group description"

Output Example

    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "ReceiverId": 123

5. Developer Resources


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
InternalError Internal error.
InvalidParameterValue.ReceiverDescIllegal Invalid recipient group description. The description cannot contain special characters and must contain 1 to 300 characters.
InvalidParameterValue.ReceiverNameIllegal Invalid recipient group name. Check the name and its size.
InvalidParameterValue.RepeatReceiverName Duplicate recipient group name.
LimitExceeded.ExceedReceiverLimit The number of recipient groups exceeded the limit.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support