调用ListJobGroups接口查询外呼任务列表-智能外呼机器人-阿里云

查询外呼任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
outboundbot:ListJobGroups	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	业务 ID。	174952ab-9825-4cc9-a5e2-de82d7fa4cdd
StartTime	long	否	任务开始时间。	1578965079000
EndTime	long	否	任务结束时间	1579965079000
PageNumber	integer	是	页号	1
PageSize	integer	是	每页记录数。	10
AsyncQuery	boolean	否	是否异步获取查询结果	true
SearchText	string	否	搜索关键字	面试
JobGroupStatusFilter	string	否	过滤条件：按照任务状态过滤，可以同时选择多个状态过滤，各个状态之间用逗号分隔，逻辑或关系。取值范围： Draft：草稿。 Scheduling：调度中。 Executing：执行中。 Completed：已完成。 Paused：挂起。 Failed：失败。 Cancelled：已取消。 Initializing：初始化。	Draft
OnlyMinConcurrencyEnabled	boolean	否	查看并发保障值有效任务	false

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否调用成功。true：调用成功。 false：调用失败。	true
Code	string	响应码。	OK
Message	string	错误信息。	Success
AsyncTaskId	string	异步查询 ID，若为异步查询，可以根据此 ID 获取查询结果。	6243d904-939d-42ce-a8e4-886a139e77a3
JobGroups	object	任务列表。
PageNumber	integer	分页页码。	1
PageSize	integer	分页数据数量。	10
TotalCount	integer	记录总数	100
List	array<object>	数组
JobGroup	object
Status	string	执行状态，取值范围： Draft：草稿。 Scheduling：调度中。 Executing：执行中。 Completed：已完成。 Paused：挂起。 Failed：失败。 Cancelled：已取消。 Initializing：初始化。	Draft
JobGroupId	string	任务 ID。	c62e6789-28a8-41db-941e-171a01d3b3b9
CreationTime	long	创建时间。	1578550074361
JobGroupName	string	任务名字。	催收作业组
TotalCallNum	integer	总呼叫次数。	10
ScriptId	string	话术 ID。	c62e6789-28a8-41db-941e-171a01d3b3b9
JobGroupDescription	string	任务描述。	催收的作业组
JobDataParsingTaskId	string	jobFile 解析任务的 ID。【已废弃】	c62e6789-28a8-41db-941e-171a01d3b3b9
ScriptName	string	话术名称。	话术名称
ScriptVersion	string	话术版本。	d9e828ac-744b-4dd3-848a-17a3da9167b8
ModifyTime	string	修改时间，单位毫秒。	1578550074361
Progress	object	任务统计信息。
TotalNotAnswered	integer	已废弃	1
Status	string	说明该参数已不返回执行状态，取值范围： Draft：草稿。 Scheduling：调度中。 Executing：执行中。 Completed：已完成。 Paused：挂起。 Failed：失败。 Cancelled：已取消。 Initializing：初始化。	Scheduling
StartTime	long	开始时间。【废弃】	1578550074361
FailedNum	integer	失败的作业数量。	5
PausedNum	integer	暂停的作业数量	5
CancelledNum	integer	取消的作业数量	5
TotalJobs	integer	作业总数。	20
TotalCompleted	integer	到当前时间为止作业完成数量。	3
Duration	integer	到目前为止执行总时长。【废弃】	1578550074361
ExecutingNum	integer	执行中的作业数量。	10
Scheduling	integer	调度中的作业数量。	10
ExportProgress	object	导出进度。
Status	string	导出任务状态，取值范围： PENDING：等待中。 IN_PROGRESS：处理中。 FINISHED：完成。 FAILED：失败。	PENDING
FileHttpUrl	string	已废弃	http://www.xxx.com/xxx
Progress	string	进度。	1
Strategy	object	策略。【已废弃】说明需要查看任务策略信息，可调用 DescribeJobGroup 接口获取
EndTime	long	策略结束时间。	2209702074000
StartTime	long	策略开始时间。	1578550074000
MinConcurrency	integer	并发保障值有效任务数	1

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "AsyncTaskId": "6243d904-939d-42ce-a8e4-886a139e77a3\n",
  "JobGroups": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "Status": "Draft",
        "JobGroupId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "CreationTime": 1578550074361,
        "JobGroupName": "催收作业组",
        "TotalCallNum": 10,
        "ScriptId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "JobGroupDescription": "催收的作业组",
        "JobDataParsingTaskId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "ScriptName": "话术名称",
        "ScriptVersion": "d9e828ac-744b-4dd3-848a-17a3da9167b8",
        "ModifyTime": 1578550074361,
        "Progress": {
          "TotalNotAnswered": 1,
          "Status": "Scheduling",
          "StartTime": 1578550074361,
          "FailedNum": 5,
          "PausedNum": 5,
          "CancelledNum": 5,
          "TotalJobs": 20,
          "TotalCompleted": 3,
          "Duration": 1578550074361,
          "ExecutingNum": 10,
          "Scheduling": 10
        },
        "ExportProgress": {
          "Status": "PENDING",
          "FileHttpUrl": "http://www.xxx.com/xxx",
          "Progress": 1
        },
        "Strategy": {
          "EndTime": 2209702074000,
          "StartTime": 1578550074000
        },
        "MinConcurrency": 1
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-02-15	API 内部配置变更，不影响调用	查看变更详情
2024-06-24	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情