Release Notes
Announcement on a Newly Added Independent IP Value-Added Service
Domain name for API request: ses.intl.tencentcloudapi.com.
This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page. You can query task data including the number of emails requested to be sent, the number of sent emails, the number of cached emails, and task status.
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: ListSendTasks. |
| 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. |
| Offset | Yes | Integer | Offset, starting from 0. The value is an integer. 0 means to skip 0 entries. |
| Limit | Yes | Integer | Number of records to query. The value is an integer not exceeding 100. |
| Status | No | Integer | Task status. 1: to start; 5: sending; 6: sending suspended today; 7: sending error; 10: sent. To query tasks in all states, do not pass in this parameter. |
| ReceiverId | No | Integer | Recipient group ID |
| TaskType | No | Integer | Task type. 1: immediate; 2: scheduled; 3: recurring. To query tasks of all types, do not pass in this parameter. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| Data | Array of SendTaskData | Data record |
| 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: ListSendTasks
<Common request parameters>
{
"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": "Email Subject"
"ErrMsg": "",
"ReceiversName": "Name"
}
],
"RequestId": "38049379278d43208c59916a4806b0c4"
}
}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.InvalidLimit | Reached the query limit (100). |
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