- News and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- API Documentation
- SMTP Documentation
- Webhook Documentation
- Email Sending Restrictions
- FAQs
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- API Documentation
- SMTP Documentation
- Webhook Documentation
- Email Sending Restrictions
- FAQs
- Contact Us
1. API Description
Domain name for API request: ses.tencentcloudapi.com.
This API is used to get email sending status. Only data within 30 days can be queried.
Default API request rate limit: 1 request/sec.
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: 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. |
| 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. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| EmailStatusList | Array of SendEmailStatus | Status of sent emails |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the sending result by MessageId
Input Example
POST / HTTP/1.1
Host: ses.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"
}
Output Example
{
"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"
}
}
Example2 Querying the sending result by recipient
Input Example
POST / HTTP/1.1
Host: ses.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"
}
Output Example
{
"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"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.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 has been blocked temporarily due to violations of rules. |
| 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. |
Yes
No
Was this page helpful?