产品动态
关于新增独立 IP 增值服务的公告
Domain name for API request: ses.intl.tencentcloudapi.com.
This API is used to send an HTML or TEXT email triggered for authentication or transaction. By default, you can send emails using a template only.
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: SendEmail. |
| 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. If no alias is used, enter the sender's email address directly, for example: noreply@mail.qcloud.com. To use a sender alias, follow this format (note that a space must be used between the alias and the email address): alias+space+<email address>. The alias cannot contain a colon (:). |
| Subject | Yes | String | Email Subject |
| Destination.N | No | Array of String | Recipient email address, supports up to 50 recipients in mass sending. Note: The email content displays all recipient addresses. For non-mass sending, call the API multiple times to send. |
| ReplyToAddresses | No | String | The "reply" email address of the mail. Can be filled with a mailbox address where you can receive emails, which can be a personal mailbox. If left empty, the recipient's reply mail will fail to send. |
| Cc.N | No | Array of String | Email address of CC recipients, supports up to 20 carbon copies. |
| Bcc.N | No | Array of String | Bcc email address, supports up to 20 carbon copies. Bcc and Destination must be unique. |
| Template | No | Template | Fill in the template parameters when sending with a template.
|
| Simple | No | Simple | Abandoned
|
| Attachments.N | No | Array of Attachment | To send an attachment, fill in the relevant parameters. The Tencent Cloud API request supports a maximum of 8M request packet. The attachment content is expected to expand by 1.5 times after Base64 encoding. The total size of all attachments should not exceed 4M. The API will return an error if the overall request exceeds 8M. |
| Unsubscribe | No | String | Unsubscription link options 0: do not add unsubscription link 1: english 2: simplified chinese 3: traditional chinese 4: spanish 5: french 6: german 7: japanese 8: korean 9: arabic 10: thai 11: indonesian. |
| TriggerType | No | Integer | Mail trigger type 0: Non-trigger class, default type, select this type for marketing email, non-instant mail. 1: Trigger class, instant delivery mail such as verification code. If the mail exceeds a certain size, the system will automatically select a non-trigger type channel. |
| SmtpMessageId | No | String | Message-Id field in the smtp header |
| SmtpHeaders | No | String | Other fields that can be set in the smtp header |
| HeaderFrom | No | String | The from field in the smtp header. The domain name should be consistent with the FromEmailAddress. |
| Parameter Name | Type | Description |
|---|---|---|
| MessageId | String | Uniquely generated message identifier for receiving messages. |
| 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: SendEmail
<Common request parameters>
{
"FromEmailAddress": "QCLOUDTEAM <noreply@mail.qcloud.com>",
"ReplyToAddresses": "qcloud@tencent.com",
"Destination": [
"user@example.com"
],
"Simple": {
"Html": "PGh0bWw+PGRpdj5IZWxsb1dvcmxkPC9kaXY+PC9odG1sPg==",
"Text": "aGVsbG8gd29ybGQ="
},
"Subject": "YourTestSubject"
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
"MessageId": "qcloud-ses-messageid"
}
}
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<Common request parameters>
{
"FromEmailAddress": "QCLOUDTEAM <noreply@mail.qcloud.com>",
"ReplyToAddresses": "qcloud@tencent.com",
"Destination": [
"user@example.com"
],
"Template": {
"TemplateID": 100091,
"TemplateData": "{\"code\":\"1234\"}"
},
"Subject": "YourTestSubject"
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
"MessageId": "qcloud-ses-messageid"
}
}
POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<Common request parameters>
{
"FromEmailAddress": "QCLOUDTEAM <noreply@mail.qcloud.com>",
"ReplyToAddresses": "qcloud@tencent.com",
"Destination": [
"user@example.com"
],
"Simple": {
"Text": "aGVsbG8gd29ybGQ="
},
"Subject": "YourTestSubject"
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
"MessageId": "qcloud-ses-messageid"
}
}
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.AttachContentToolarge | The attachments are too large. Make sure they do not exceed the size limit for a single attachment and the overall limit for all attachments. |
| FailedOperation.EmailAddrInBlacklist | The email address is in the blocklist. |
| FailedOperation.EmailContentToolarge | The email is too large. Remove some content. |
| FailedOperation.ExceedSendLimit | The number of emails exceeds the daily sending limit. |
| FailedOperation.FileURLNotExist | URL is unavailable or not found. |
| FailedOperation.FrequencyLimit | You have sent too many emails to the same address in a short period. |
| FailedOperation.HighRejectionRate | The email has been blocked temporarily due to high rejection rate. |
| FailedOperation.IllegalURL | Mail contains non-compliant link. |
| FailedOperation.IncorrectEmail | Incorrect email address. |
| FailedOperation.IncorrectSender | Incorrect sender format. Follow the sample in this document. |
| FailedOperation.InsufficientBalance | Insufficient balance or account in arrears. |
| FailedOperation.InsufficientQuota | Insufficient emails in plans. |
| FailedOperation.InvalidAttachName | Unsupported attachment name. please check whether the attachment name contains special characters. for details, see the appendix attachment description (https://www.tencentcloud.comom/document/product/1288/51951?from_cn_redirect=1). |
| FailedOperation.InvalidTemplateID | Invalid template ID or unavailable template. |
| FailedOperation.MissingEmailContent | Missing email content (TemplateData and Simple cannot be both empty). |
| FailedOperation.NoAttachPermission | No permission to send an email with attachments. |
| FailedOperation.NotAuthenticatedSender | Unable to send because the sender is not verified. |
| FailedOperation.ProtocolCheckErr | Incorrect protocol. Make sure the protocol is correct. |
| FailedOperation.ReceiverHasUnsubscribed | The recipient has unsubscribed. |
| FailedOperation.RejectedByRecipients | The message was rejected by the recipient. |
| FailedOperation.SendEmailErr | Email sending error. Please submit a ticket to us for troubleshooting. |
| FailedOperation.TemporaryBlocked | The email push platform will suspend sending emails to the service provider for 10 minutes due to the corresponding recipient service provider's limit. it will be automatically released after 10 minutes. |
| FailedOperation.TooManyAttachments | Too many attachments. A single email supports up to 10 attachments. |
| FailedOperation.TooManyRecipients | Too many recipients. Set a maximum of 50 recipients at a time. |
| FailedOperation.URLForbidden | Forbid users with low delivery rate to include URL webpage links in email content. |
| FailedOperation.UnsupportMailType | Unsupported email type. |
| FailedOperation.WithOutPermission | You can only send emails by using a template. |
| FailedOperation.WrongContentJson | The format of the TemplateData field is incorrect. Make sure it is in JSON format. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.AttachContentIsWrong | Incorrect attachment content. Make sure the base64 content is correct. |
| InvalidParameterValue.EmailAddressIsNULL | The recipient or sender address is empty. Please check. |
| InvalidParameterValue.EmailContentIsWrong | Incorrect email content. Make sure TEXT/HTML base64 is correct. |
| InvalidParameterValue.InvalidEmailIdentity | Invalid domain value. |
| InvalidParameterValue.ReceiverEmailInvalid | The recipient address is incorrect. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceInsufficient | Insufficient resources. |
| ResourceUnavailable | The resource is unavailable. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
文档反馈