Release Notes
Announcement on a Newly Added Independent IP Value-Added Service
Domain name for API request: ses.intl.tencentcloudapi.com.
This API is used to send a TEXT or HTML email to multiple recipients at a time for marketing or notification purposes. By default, you can send emails using a template only. You need to create a recipient group with email addresses first and then send emails by group ID. SES supports scheduled and recurring email sending tasks. You need to pass in TimedParam for a scheduled task and CycleParam for a recurring one.
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: BatchSendEmail. |
| 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. |
| FromEmailAddress | Yes | String | Sender's email address. Please fill in the sender's email address, for example: noreply@mail.qcloud.com. If you need to fill in the sender description, please enter it via |
| ReceiverId | Yes | Integer | Recipient list ID |
| Subject | Yes | String | Email Subject |
| TaskType | Yes | Integer | Task type 1: Send now 2: Scheduled sending 3: Cycle (frequency) sending |
| ReplyToAddresses | No | String | The "reply" email address of the mail. Can be filled with an email address you can receive mail, can be a personal mailbox. If left empty, the recipient's reply mail will fail to send. |
| Template | No | Template | Template-related parameters to fill in when sending with a template
|
| Simple | No | Simple | Abandoned
|
| Attachments.N | No | Array of Attachment | When you need to send an attachment, fill in the related parameters (not supported). |
| CycleParam | No | CycleEmailParam | Required parameter for sending tasks periodically |
| TimedParam | No | TimedEmailParam | Required parameter of scheduled task assignment |
| Unsubscribe | No | String | Unsubscription link options 0: do not add 1: english 2: simplified chinese 3: traditional chinese 4: spanish 5: french 6: german 7: japanese 8: korean 9: arabic 10: thai. 11: indonesian. |
| ADLocation | No | Integer | Whether to add an ad flag 0: do not add 1: add to the previous subject 2: add to the following subject |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Send task ID |
| 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. |
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchSendEmail
<Common request parameters>
{
"Attachments": [
{
"Content": "Attachment content",
"FileName": "Filename"
}
],
"TimedParam": {
"BeginTime": "2021-09-10 11:10:11"
},
"FromEmailAddress": "abc@bbc.com",
"ReplyToAddresses": "abc@bbc.com",
"Simple": {
"Text": "text",
"Html": "html"
},
"ReceiverId": 123,
"Template": {
"TemplateData": "{\"name\":\"123\"}",
"TemplateID": 1
},
"CycleParam": {
"IntervalTime": 1,
"BeginTime": "2021-09-10 11:10:11"
},
"Subject": "Email subject",
"TaskType": 1,
"ADLocation": 0
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
"TaskId": 123
}
}
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.EmailContentToolarge | The email is too large. Remove some content. |
| InternalError | Internal error. |
| InvalidParameterValue.BeginTimeBeforeNow | The start time cannot be earlier than the current time. |
| InvalidParameterValue.EmailContentIsWrong | Incorrect email content. Make sure TEXT/HTML base64 is correct. |
| InvalidParameterValue.SubjectLengthError | The email subject must contain 1 to 100 characters. |
| InvalidParameterValue.TemplateDataError | Template parameters must be in JSON format. |
| InvalidParameterValue.TemplateNotMatchData | Template variables do not match recipient list parameters. |
| MissingParameter.CycleParamNecessary | For a recurring sending task, you must select the start time and recurrence. |
| MissingParameter.SendParamNecessary | Sender address, recipient group, and email template are required. |
| MissingParameter.TimedParamNecessary | For a scheduled sending task, you must select the start time. |
| OperationDenied.ReceiverNotExist | The recipient group does not exist. |
| OperationDenied.ReceiverStatusError | The recipient group is empty or hasn’t been completely uploaded. |
| OperationDenied.SendAddressStatusError | The sender address does not exist or hasn’t been approved. |
| OperationDenied.TemplateStatusError | The email template does not exist or hasn’t been approved. |
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