Query outbound task list (QueryOutboundTaskList)
Queries the outbound task list in pages and returns task ID, name, status, total number of customers, and time information. You can filter tasks by task name, status, associated scenario, and creation time range.
Prerequisites
-
The SDK is installed.
-
You have obtained and configured an AccessKey. For more information, see Obtain an AccessKey and configure it to environment variables.
Request parameters
|
Name |
Type |
Required |
Description |
Example value |
|
Action |
String |
Yes |
The operation to be performed. Set the value to QueryOutboundTaskList. |
QueryOutboundTaskList |
|
Version |
String |
Yes |
The API version number. The format is YYYY-MM-DD. Set the value to 2025-11-27. |
Fixed to 2025-11-27 |
|
TaskName |
String |
No |
The task name (fuzzy match). |
Spring Festival |
|
TaskStatus |
String |
No |
The task status. |
RUNNING |
|
SceneId |
Number |
No |
The scenario ID. |
1 |
|
StartDate |
String |
No |
The task start date. |
2024-01-01 |
|
EndDate |
String |
No |
The task end date. |
2024-01-31 |
|
Current |
Number |
No |
The current page number. |
1 |
|
Size |
Number |
No |
The number of entries per page. |
10 |
Response parameters
|
Name |
Type |
Description |
Example value |
|
RequestId |
String |
The request ID. |
xxxx-xxxx-xxxx |
|
Success |
Boolean |
Indicates whether the request is successful. |
True |
|
Code |
String |
The error code. Empty when the request is successful. |
None |
|
Message |
String |
The error message or success message. |
Operation succeeded |
|
Total |
Long |
The total number of records. |
20 |
|
Current |
Long |
The current page number. |
1 |
|
Size |
Long |
The number of entries per page. |
10 |
|
Records |
Array |
The response data, which contains fields such as TaskId, TaskName, SceneId, SceneName, TaskStatus, TotalCustomers, CalledCount, SuccessCount, GmtCreate, and GmtModified. For more information, see the response parameter description below. |
Examples
Python
import json
import os
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_openapi.client import Client as OpenApiClient
from alibabacloud_tea_util import models as util_models
from alibabacloud_openapi_util.client import Client as OpenApiUtilClient
def main():
config = open_api_models.Config(
access_key_id=os.getenv("ACCESS_KEY_ID"),
access_key_secret=os.getenv("ACCESS_KEY_SECRET"),
)
config.endpoint = "thirdswaicall.aliyuncs.com"
config.protocol = "HTTPS"
client = OpenApiClient(config)
params = open_api_models.Params(
style="RPC",
version="2025-11-27",
action="QueryOutboundTaskList",
method="POST",
pathname="/",
protocol="HTTPS",
auth_type="AK",
req_body_type="json",
body_type="json",
)
body = {'Current': 1, 'Size': 10}
request = open_api_models.OpenApiRequest(query=OpenApiUtilClient.query(body))
runtime = util_models.RuntimeOptions(autoretry=True, max_attempts=3)
try:
resp = client.call_api(params, request, runtime)
print(json.dumps(resp.get("body", {}), ensure_ascii=False, indent=2))
except Exception as e:
print(f"Call failed: {e}")
if __name__ == "__main__":
main()
Java
import com.aliyun.teaopenapi.Client;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teaopenapi.models.OpenApiRequest;
import com.aliyun.teaopenapi.models.Params;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;
import java.util.HashMap;
import java.util.Map;
public class Demo {
public static void main(String[] args) throws Exception {
// Initialize configuration
Config config = new Config()
.setAccessKeyId(System.getenv("ACCESS_KEY_ID"))
.setAccessKeySecret(System.getenv("ACCESS_KEY_SECRET"))
.setEndpoint("thirdswaicall.aliyuncs.com")
.setProtocol("HTTPS");
Client client = new Client(config);
// Set API parameters
Params params = new Params()
.setStyle("RPC")
.setVersion("2025-11-27")
.setAction("QueryOutboundTaskList")
.setMethod("POST")
.setPathname("/")
.setProtocol("HTTPS")
.setAuthType("AK")
.setReqBodyType("json")
.setBodyType("json");
// Build request parameters
Map<String, Object> body = new HashMap<>();
// Add request parameters as needed
OpenApiRequest request = new OpenApiRequest()
.setQuery(com.aliyun.openapiutil.Client.query(body));
// Set runtime options (auto retry)
RuntimeOptions runtime = new RuntimeOptions()
.setAutoretry(true)
.setMaxAttempts(3);
try {
// Call the API
Map<String, ?> response = client.callApi(params, request, runtime);
Gson gson = new Gson();
System.out.println(gson.toJson(response.get("body")));
} catch (Exception e) {
System.err.println("Call failed: " + e.getMessage());
}
}
}
Response example
{
"Success": true,
"Code": null,
"Message": "Operation succeeded",
"RequestId": "xxxx-xxxx-xxxx",
"Total": 20,
"Current": 1,
"Size": 10,
"Records": [
{
"TaskId": 1,
"TaskName": "Spring Festival promotion outbound task",
"SceneId": 1,
"SceneName": "Customer follow-up scenario",
"TaskStatus": "RUNNING",
"TotalCustomers": 1000,
"CalledCount": 500,
"SuccessCount": 300,
"GmtCreate": "2024-01-01 09:00:00",
"GmtModified": "2025-01-15 14:30:00"
}
]
}
The detailed processing results are in the Records node. The following table describes the parameters in the Records node.
|
Name |
Type |
Description |
Example value |
|
TaskId |
Number |
The task ID. |
1 |
|
TaskName |
String |
The task name. |
Spring Festival promotion outbound task |
|
SceneId |
Number |
The scenario ID. |
1 |
|
SceneName |
String |
The scenario name. |
Customer follow-up scenario |
|
TaskStatus |
String |
The task status. |
RUNNING |
|
TotalCustomers |
Number |
The total number of customers. |
1000 |
|
CalledCount |
Number |
The number of calls made. |
500 |
|
SuccessCount |
Number |
The number of successful calls. |
300 |
|
GmtCreate |
String |
The creation time. |
2024-01-01 09:00:00 |
|
GmtModified |
String |
The modification time. |
2025-01-15 14:30:00 |
Error information
If an error occurs, see Error codes for troubleshooting.