Release Notes
Announcement on a Newly Added Independent IP Value-Added Service
Domain name for API request: ses.intl.tencentcloudapi.com.
Search the email sending status. Only support querying data within 30 days.
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: GetSendEmailStatus. |
| 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. |
| RequestDate | Yes | Date | Date sent. This parameter is required. You can only query the sending status for a single date at a time. |
| Offset | Yes | Integer | Offset. Default value: 0. |
| Limit | Yes | Integer | Maximum number of pulled entries. Maximum value: 100. |
| MessageId | No | String | The MessageId field returned by the SendMail API. |
| ToEmailAddress | No | String | Recipient email address. |
| Parameter Name | Type | Description |
|---|---|---|
| EmailStatusList | Array of SendEmailStatus | Status of sent emails |
| 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: GetSendEmailStatus
<Common request parameters>
{
"Limit": 10,
"Offset": 0,
"RequestDate": "2020-09-22",
"MessageId": "qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1"
}{
"Response": {
"EmailStatusList": [
{
"UserOpened": true,
"UserUnsubscribed": true,
"RequestTime": 1609831698,
"UserComplainted": true,
"ToEmailAddress": "example@cloud.com",
"FromEmailAddress": "noreply@tencent.com",
"UserClicked": true,
"DeliverTime": 1609831698,
"DeliverMessage": "",
"MessageId": "qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1",
"SendStatus": 0,
"DeliverStatus": 0
}
],
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
}
}POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSendEmailStatus
<Common request parameters>
{
"Limit": 10,
"Offset": 0,
"RequestDate": "2020-09-22",
"ToEmailAddress": "example@cloud.com"
}{
"Response": {
"EmailStatusList": [
{
"UserOpened": true,
"UserUnsubscribed": true,
"RequestTime": 1609831698,
"UserComplainted": true,
"ToEmailAddress": "example@cloud.com",
"FromEmailAddress": "noreply@tencent.com",
"UserClicked": true,
"DeliverTime": 1609831698,
"DeliverMessage": "",
"MessageId": "qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1",
"SendStatus": 0,
"DeliverStatus": 0
}
],
"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.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.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.IncorrectEmail | Incorrect email address. |
| FailedOperation.InsufficientBalance | Insufficient balance or account in arrears. |
| FailedOperation.InsufficientQuota | Insufficient emails in plans. |
| FailedOperation.InvalidLimit | Reached the query limit (100). |
| FailedOperation.InvalidTemplateID | Invalid template ID or unavailable template. |
| FailedOperation.NotAuthenticatedSender | Unable to send because the sender is not verified. |
| FailedOperation.NotSupportDate | You cannot query email records for this date. Only data within 90 days can be queried. |
| FailedOperation.ProtocolCheckErr | Incorrect protocol. Make sure the protocol is correct. |
| 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.TooManyRecipients | Too many recipients. Set a maximum of 50 recipients at a time. |
| 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.EmailAddressIsNULL | The recipient or sender address is empty. Please check. |
| InvalidParameterValue.EmailContentIsWrong | Incorrect email content. Make sure TEXT/HTML base64 is correct. |
| InvalidParameterValue.WrongDate | Incorrect search date. Make sure the date and its format are valid. |
| 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. |
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