GetAiOutboundTaskList-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

Retrieve the outbound call job list by instance ID and Task Type.

Operation description

The job list contains job information, including job ID, Task Status, Task Name, task completion rate, and more. For details, see Response parameters.
If you need to update job information, you can invoke the UpdateAiOutboundTask API.

Queries per second (QPS) limits

Per-user invocation frequency: 100 times/second.
API invocation frequency: 100 times/second.

Note

Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from Instance Management in the left-side navigation pane of the Artificial Intelligence Cloud Call Service console.	agent_****
Type	integer	Yes	Task Type. Valid values: 2: Predictive outbound call. 3: Automated outbound call.	2
CreateTimeStart	integer	No	The start time for job creation. The value is a UNIX timestamp in milliseconds.	1615083365000
CreateTimeEnd	integer	No	The end time for job creation. The value is a UNIX timestamp in milliseconds.	1617761765000
Status	integer	No	Job status. Valid values: 0: Not started. 1: In progress. 2: Paused by the system. 3: Manually paused. 4: Completed. 5: Stopped.	1
PageSize	integer	Yes	Page size. The value must be greater than 0. Default value: 20.	10
CurrentPage	integer	Yes	The page number to query.	1
SearchKey	string	No	Filter condition. Note Matches job ID or performs fuzzy matching on job name.	1763****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	EE338D98-9BD3-4413-B165
Message	string	Description of the status code.	OK
Data	object	Job list.
PageSize	integer	Page size.	10
CurrentPage	integer	Current page number.	1
TotalResults	integer	Total number of data entries.	10
List	array<object>	Job information.
	object	Job information.
Status	integer	Task Status. Valid values: 0: Not started. 1: In progress. 2: System paused. 3: Manually paused. 4: Completed. 5: Stopped.	0
FinishRate	number	Job completion rate.	0.7
StatusDesc	string	Task status description.	未开始
HandlerId	integer	Skill group ID (for predictive dialing) or IVR ID (for auto dialing).	2468****
ConcurrentRate	integer	Concurrent outbound calls. Note Parameter specific to auto dialing.	1
TotalCount	integer	Total number of jobs.	100
TaskId	integer	Job ID.	1763****
Description	string	Job description.	房产销售
CreateTime	integer	The deadline for job creation. UNIX timestamp format, in milliseconds.	1615083365000
FinishCount	integer	The number of completed tasks.	70
HandlerName	string	Skill group name or IVR name.	热线技能组
Name	string	Job name.	xxxx外呼任务
HasNextPage	boolean	Indicates whether there is a next page. Valid values: true: Yes. false: No.	false
Code	string	Status code.	OK
Success	boolean	Indicates whether the API call succeeded. true: Succeeded. false: Failed.	true

Examples

Success response

JSON format

{
  "RequestId": "EE338D98-9BD3-4413-B165",
  "Message": "OK",
  "Data": {
    "PageSize": 10,
    "CurrentPage": 1,
    "TotalResults": 10,
    "List": [
      {
        "Status": 0,
        "FinishRate": 0.7,
        "StatusDesc": "未开始",
        "HandlerId": 0,
        "ConcurrentRate": 1,
        "TotalCount": 100,
        "TaskId": 0,
        "Description": "房产销售",
        "CreateTime": 1615083365000,
        "FinishCount": 70,
        "HandlerName": "热线技能组",
        "Name": "xxxx外呼任务"
      }
    ],
    "HasNextPage": false
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.