1. 接口描述
接口请求域名： ses.tencentcloudapi.com 。
分页查询批量发送邮件任务，包含即时发送任务，定时发送任务，周期重复发送任务，查询发送情况，包括请求数量，已发数量，缓存数量，任务状态等信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListSendTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。 |
| Offset | 是 | Integer | 偏移量，整型，从0开始，0代表跳过0行 示例值：1 |
| Limit | 是 | Integer | 限制数目，整型,不超过100 示例值：10 |
| Status | 否 | Integer | 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成。查询所有状态，则不传这个字段 示例值：1 |
| ReceiverId | 否 | Integer | 收件人列表ID 示例值：123 |
| TaskType | 否 | Integer | 任务类型 1即时 2定时 3周期，查询所有类型则不传这个字段 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 示例值：123 |
| Data | Array of SendTaskData | 数据记录 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询任务
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListSendTasks
<公共请求参数>
{
"Status": 1,
"Offset": 1,
"Limit": 1,
"ReceiverId": 123,
"TaskType": 1
}输出示例
{
"Response": {
"TotalCount": 1,
"Data": [
{
"CacheCount": 1,
"UpdateTime": "2021-09-09 10:10:10",
"SendCount": 1,
"TimedParam": {
"BeginTime": "2021-09-09 10:10:10"
},
"FromEmailAddress": "abc@cd.com",
"TaskStatus": 1,
"ReceiverId": 1,
"RequestCount": 1,
"TaskId": "123",
"TaskType": 1,
"Template": {
"TemplateData": "{\"name\":\"name\"}",
"TemplateID": 1
},
"CycleParam": {
"IntervalTime": 1,
"BeginTime": "2021-09-09 10:10:10",
"TermCycle": 1
},
"CreateTime": "2021-09-09 10:10:10",
"Subject": "邮件主题",
"ErrMsg": "",
"ReceiversName": "名称"
}
],
"RequestId": "xx"
}
}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.InvalidLimit | 超过查询限制，Limit最大支持100。 |