tencent cloud

APIs

查询发送任务

Download
聚焦模式
字号
最后更新时间: 2026-07-14 18:00:16

1. 接口描述

接口请求域名: ses.intl.tencentcloudapi.com 。

分页查询批量发送邮件任务,包含即时发送任务,定时发送任务,周期重复发送任务,查询发送情况,包括请求数量,已发数量,缓存数量,任务状态等信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListSendTasks。
Version String 公共参数,本接口取值:2020-10-02。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-singapore 。
Offset Integer 偏移量,整型,从0开始,0代表跳过0行
Limit Integer 限制数目,整型,不超过100
Status Integer 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成。查询所有状态,则不传这个字段
ReceiverId Integer 收件人列表ID
TaskType Integer 任务类型 1即时 2定时 3周期,查询所有类型则不传这个字段

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
Data Array of SendTaskData 数据记录
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务

输入示例

POST / HTTP/1.1
Host: ses.intl.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": 1,
                "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": "38049379278d43208c59916a4806b0c4"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.InvalidLimit 超过查询限制,Limit最大支持100。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈