tencent cloud

Feedback

CreateReceiverDetail

Last updated: 2022-08-11 11:23:37

1. API Description

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

This API is used to add recipient email addresses (up to 100,000 at a time) to a recipient group. This will be processed asynchronously. You can upload recipient email addresses only once. If the data volume is large, it may take some time to upload. You can check the recipient group to learn the upload status and upload quantity.

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: CreateReceiverDetail.
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 group ID
Emails.N Yes Array of String Email address

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating recipients

Input Example

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

{
    "ReceiverId": 123,
    "Emails": [
        "123",
        "456@bc.com"
    ]
}

Output Example

{
  "Response": {
    "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 Operation failed.
FailedOperation.ServiceNotAvailable The request has not taken effect. Try again.
InternalError Internal error.
InvalidParameterValue.TemplateDataError Variables must be in JSON format.
LimitExceeded.ExceedReceiverDetailLimit The number of recipient email addresses exceeded the limit.
MissingParameter.EmailsNecessary The recipient email address is required.
MissingParameter.ReceiverIdNecessary The recipient group ID is required.
OperationDenied.ReceiverIsOperating The recipient group is being operated. Please try later.
OperationDenied.ReceiverNotExist The recipient group does not exist.
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