1. 接口描述
接口请求域名： ses.tencentcloudapi.com 。
获取邮件发送状态。仅支持查询30天之内的数据
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetSendEmailStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。 |
| RequestDate | 是 | Date | 发送的日期，必填。仅支持查询某个日期，不支持范围查询。 示例值：2020-09-22 |
| Offset | 是 | Integer | 偏移量。默认为0 示例值：0 |
| Limit | 是 | Integer | 拉取最大条数，最多 100。 示例值：10 |
| MessageId | 否 | String | SendMail接口返回的MessageId字段。 示例值：qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1 |
| ToEmailAddress | 否 | String | 收件人邮箱。 示例值：abc@ef.com |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EmailStatusList | Array of SendEmailStatus | 邮件发送状态列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据MessageId查询发送结果
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSendEmailStatus
<公共请求参数>
{
"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"
}
}示例2 根据收件人查询发送结果
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSendEmailStatus
<公共请求参数>
{
"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"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.EmailAddrInBlacklist | 邮件地址在黑名单中。 |
| FailedOperation.EmailContentToolarge | 邮件内容太大，请减少发送邮件内容。 |
| FailedOperation.ExceedSendLimit | 超出当日总量发送限制。 |
| FailedOperation.FrequencyLimit | 触发频率控制，短时间内对同一地址发送过多邮件。 |
| FailedOperation.HighRejectionRate | 拒信率过高，被临时block。 |
| FailedOperation.IncorrectEmail | 邮箱地址错误。 |
| FailedOperation.InsufficientBalance | 余额不足，账号欠费等。 |
| FailedOperation.InsufficientQuota | 套餐包额度不足。 |
| FailedOperation.InvalidLimit | 超过查询限制，Limit最大支持100。 |
| FailedOperation.InvalidTemplateID | 模板ID无效或者不可用。 |
| FailedOperation.NotAuthenticatedSender | 发件sender没有经过认证，无法发送。 |
| FailedOperation.NotSupportDate | 不支持查询该日期邮件记录，仅支持查询90天之内的数据。 |
| FailedOperation.ProtocolCheckErr | 协议检查错误，请检查协议是否正确。 |
| FailedOperation.TemporaryBlocked | 因触发了对应的收件服务商限制，邮件推送平台会对该服务商发信暂停10分钟，10分钟后自动解除。 |
| FailedOperation.TooManyRecipients | 收件人数太多，最多支持同时发送50人。 |
| FailedOperation.UnsupportMailType | 不支持的邮箱类型。 |
| FailedOperation.WithOutPermission | 仅支持使用模板发送邮件。 |
| FailedOperation.WrongContentJson | TemplateData字段格式不正确，请保持为json格式。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.EmailAddressIsNULL | 收件或者发件地址为空，请检查邮件地址。 |
| InvalidParameterValue.EmailContentIsWrong | 邮件内容错误，请检查TEXT/HTML base64是否正确。 |
| InvalidParameterValue.WrongDate | 搜索日期错误，请检查日期及格式是否有效。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInsufficient | 资源不足。 |
| ResourceUnavailable | 资源不可用。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
