ListJobGroupsAsync - 异步查询任务组列表

更新时间:
复制为 MD 格式

异步获取外呼任务列表。当在调用ListJobGroup接口时指定了Async时,使用此接口获取异步ListJobGroup的结果。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:ListJobGroupsAsync

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AsyncTaskId

string

当调用 ListJobGroup 时采用 Async 模式时,ListJobGroup 返回的 AsyncTaskId 的值。根据该 ID 可以获取异步查询的结果。

6243d904-939d-42ce-a8e4-886a139e77a3

返回参数

名称

类型

描述

示例值

object

Timeout

boolean

是否超时。

true

HttpStatusCode

integer

HTTP 状态码。

200

RequestId

string

请求 ID。

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Success

boolean

是否成功。

true

Vaild

boolean

是否有效。

true

Code

string

状态码。

OK

Message

string

接口响应信息。

Success

PageSize

integer

每页显示的条数。

10

PageNumber

integer

页号。

1

TotalCount

integer

总计个数。

100

JobGroups

array<object>

任务列表。

array<object>

Status

string

任务状态。

Scheduling

CreationTime

integer

创建时间。

1640316786259

JobGroupId

string

任务 ID。

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

JobGroupName

string

任务名字。

xxx

TotalCallNum

integer

总呼叫次数。

100

ScriptId

string

话术 ID。

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

JobGroupDescription

string

任务描述。

xxx

JobDataParsingTaskId

string

jobFile 解析任务的 ID。【已废弃】

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

ScriptName

string

话术名称。

xxxx

ScriptVersion

string

话术版本。

111

ModifyTime

string

修改时间,单位毫秒。

1640316786259

Strategy

object

策略。【已废弃】

说明

需要查看任务策略信息,可调用 DescribeJobGroup 接口获取

{}

EndTime

integer

策略结束时间。

1640316786259

StartTime

integer

策略开始时间。

1640316786259

Progress

object

任务统计信息。

{}

TotalNotAnswered

integer

作业未接通数量。【已废弃】

1

Status

string

执行状态,取值范围:

  • Draft:草稿。

  • Scheduling:调度中。

  • Executing:执行中。

  • Completed:已完成。

  • Paused:挂起。

  • Failed:失败。

  • Cancelled:已取消。

  • Initializing:初始化。

Scheduling

StartTime

integer

开始时间。【已废弃】

1640316786259

FailedNum

integer

失败的作业数量。

10

PausedNum

integer

暂停的作业数量。

10

CancelledNum

integer

取消的作业数量。

10

TotalCompleted

integer

已完成的作业数量。

10

TotalJobs

integer

作业总数。

100

Duration

integer

到目前为止执行总时长。【废弃】

1000

Scheduling

integer

调度中的作业数量。

20

ExecutingNum

integer

执行中的作业数量。

20

ExportProgress

object

导出进度。

{}

Status

string

状态。

PENDING

FileHttpUrl

string

下载地址。【废弃】

http://www.xxx.com/xxx

Progress

string

进度。

50

MinConcurrency

integer

最小并发数。

1

示例

正常返回示例

JSON格式

{
  "Timeout": true,
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Vaild": true,
  "Code": "OK",
  "Message": "Success",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 100,
  "JobGroups": [
    {
      "Status": "Scheduling",
      "CreationTime": 1640316786259,
      "JobGroupId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "JobGroupName": "xxx",
      "TotalCallNum": 100,
      "ScriptId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "JobGroupDescription": "xxx",
      "JobDataParsingTaskId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "ScriptName": "xxxx",
      "ScriptVersion": "111",
      "ModifyTime": "1640316786259",
      "Strategy": {
        "EndTime": 1640316786259,
        "StartTime": 1640316786259
      },
      "Progress": {
        "TotalNotAnswered": 1,
        "Status": "Scheduling",
        "StartTime": 1640316786259,
        "FailedNum": 10,
        "PausedNum": 10,
        "CancelledNum": 10,
        "TotalCompleted": 10,
        "TotalJobs": 100,
        "Duration": 1000,
        "Scheduling": 20,
        "ExecutingNum": 20
      },
      "ExportProgress": {
        "Status": "PENDING",
        "FileHttpUrl": "http://www.xxx.com/xxx\n",
        "Progress": "50"
      },
      "MinConcurrency": 1
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情