Release Notes
Announcement on a Newly Added Independent IP Value-Added Service
Domain name for API request: ses.intl.tencentcloudapi.com.
Add recipient addresses with Template parameters. Use this API to import Template parameters while adding recipient addresses, ensuring each recipient address uses Template variables with different values when sending emails. Users first call the CreateReceiver API to create a recipient list, then call this API to import recipient addresses and Template parameters for email sending, and finally use the BatchSendEmail API to complete batch email sending. Notably, after using this API, the Template parameter in the BatchSendEmail API does not need to be passed again. Users can also import recipient addresses, Template variables, and parameter values via the import file option in the console under Email Sending - Recipient List menu. This API limits the number of recipient addresses in a single request to 20,000 entries. It can also append recipient addresses to an already uploaded recipient list, but the total number of recipient addresses in the list must not exceed a certain limit, currently set at 50,000 entries. This API does not support removing duplicate recipient addresses. Users need to ensure uploaded and appended addresses are non-repeating and do not duplicate previously uploaded addresses.
A maximum of 20 requests can be initiated per second for this API.
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: CreateReceiverDetailWithData. |
| 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. |
| ReceiverId | Yes | Integer | Recipient list ID. |
| Datas.N | Yes | Array of ReceiverInputData | Recipient mailbox and template parameters in array format. limit on the number of recipients not exceeding 20000. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Recipient total number. |
| ValidCount | Integer | Uploaded quantity. |
| TooLongCount | Integer | Data too long quantity. |
| EmptyEmailCount | Integer | Number of empty email addresses. |
| RepeatCount | Integer | Repetition count. |
| 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. |
Add recipient address with template parameter
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReceiverDetailWithData
<Common request parameters>
{
"ReceiverId": 123,
"Datas": [
{
"Email": "example@gmail.com",
"TemplateData": "{\"name\":\"john\",\"age\":\"12\"}"
}
]
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.ServiceNotAvailable | The request has not taken effect. Try again. |
| InvalidParameterValue.InValidTemplateData | The template parameter attached to the recipient address cannot contain html tags. |
| InvalidParameterValue.ReceiverEmailInvalid | The recipient address is incorrect. |
| InvalidParameterValue.TemplateDataError | Template parameters must be in JSON format. |
| InvalidParameterValue.TemplateDataInconsistent | The name of a template parameter variable is not the same as the original name. |
| InvalidParameterValue.TemplateDataLenLimit | The template parameter (entire JSON structure) attached to a single recipient address exceeds the length limit of 800 bytes. |
| LimitExceeded.ReceiverDetailCountLimit | The number of recipient addresses in the recipient group exceeds the limit. |
| LimitExceeded.ReceiverDetailRequestLimit | The number of recipient addresses requested exceeds the limit. |
| MissingParameter.EmailsNecessary | The recipient email address is required. |
| OperationDenied.ReceiverIsOperating | The recipient group is being uploaded. Try again later. |
| OperationDenied.ReceiverNotExist | The recipient group does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback