ListTask - 获取任务列表

更新时间:
复制 MD 格式

分页查询智能联络机器人呼叫任务列表。包含任务总数、任务信息。

接口说明

  • 您可以通过此接口获取智能联络机器人呼叫任务列表,也可以在任务管理界面获取任务列表。

  • 若您没有已创建的智能联络机器人呼叫任务,可以在任务管理界面单击创建任务或通过 CreateTask 接口创建任务。

  • 此接口的非必填参数为智能联络机器人呼叫任务列表的筛选条件,若不填写,则查询全部任务列表。

QPS 限制

  • 单用户调用频率:不限流。

  • API 频率:500 次/秒。

说明

如果多个用户的总调用超过 API 频率也会触发流控。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

aiccs:ListTask

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TaskName

string

任务名称。在任务管理界面查看已创建的任务名称。

任务测试

PageNo

integer

当前页。取值大于 0,默认值:1

1

PageSize

integer

每页数量。取值大于 0,默认值:20

20

Status

string

任务状态。取值:

  • INIT:未开始。

  • RELEASE:解析中。

  • RUNNING:执行中。

  • STOP:手动暂停。

  • SYSTEM_STOP:系统暂停。

  • READY:待执行。

  • CANCEL:手动终止。

  • SYSTEM_CANCEL:系统终止。

  • DONE:已完成。

STOP

TaskId

integer

机器人呼叫任务的唯一任务 ID。在任务管理界面查看或通过 CreateTask 接口获取。

12****

RobotName

string

机器人名称。即为话术名称,在话术管理界面查看已经通过审核的话术名称。

机器人

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

D9CB3933-9FE3-4870-BA8E-2BEE91B69D23

Message

string

状态码描述。

OK

Data

object

任务数据列表。

PageSize

integer

每页个数。

20

Total

integer

任务总数。

50

PageNo

integer

当前页码。

1

Record

array<object>

任务信息列表。

object

任务信息。

Status

string

任务状态。

RELEASE

GmtCreate

string

任务创建时间。时间戳格式,单位:毫秒。

1618477232000

TotalCount

integer

处理通话总数。

1

FireTime

string

任务启动时间。时间戳格式,单位:毫秒。

1618477232000

TaskName

string

任务名称。

测试任务

RobotId

integer

指定机器人 ID。即为话术 ID。

12****

RobotName

string

机器人名称。

机器人

Id

integer

机器人呼叫任务的唯一任务 ID。

12****

CompleteCount

integer

完成通话个数。

1

Code

string

请求状态码。返回 OK 代表请求成功。

OK

Success

boolean

调用接口是否成功。取值:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Message": "OK",
  "Data": {
    "PageSize": 20,
    "Total": 50,
    "PageNo": 1,
    "Record": [
      {
        "Status": "RELEASE",
        "GmtCreate": "1618477232000",
        "TotalCount": 1,
        "FireTime": "1618477232000",
        "TaskName": "测试任务",
        "RobotId": 0,
        "RobotName": "机器人",
        "Id": 0,
        "CompleteCount": 1
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 PermissionInsufficient Insufficient permissions. Please contact the Alibaba Cloud account administrator. 权限不足,请联系主账号管理员
400 ParameterError The parameter is invalid. 参数错误

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

变更历史

更多信息,参考变更详情