获取任务列表。包含任务总数、任务信息。
接口说明
- 此接口可以不输入请求参数,直接调用。
- 任务信息包含任务状态、任务创建时间、任务启动时间、任务名称、处理通话总数等,具体可参考返回参数。
QPS 限制
- 单用户调用频率:不限流。
- API 频率:500 次/秒。
说明
如果多个用户的总调用超过 API 频率也会触发流控。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
aiccs:ListTask | List |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TaskName | string | 否 | 任务名称。 | 任务测试 |
PageNo | integer | 否 | 当前页。取值大于 0,默认值:1。 | 1 |
PageSize | integer | 否 | 每页大小。取值大于 0,默认值:20。 | 20 |
Status | string | 否 | 任务状态。取值:
| STOP |
TaskId | long | 否 | 机器人呼叫任务的唯一任务 ID。
| 12**** |
RobotName | string | 否 | 机器人名称。 | 机器人 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
"Data": {
"PageNo": 1,
"PageSize": 20,
"Total": 50,
"Record": [
{
"Status": "RELEASE",
"GmtCreate": "1618477232000",
"TotalCount": 1,
"FireTime": "1618477232000",
"TaskName": "测试任务",
"RobotId": 0,
"RobotName": "机器人",
"Id": 0,
"CompleteCount": 1
}
]
},
"Code": "OK",
"Message": "OK",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | PermissionInsufficient | Insufficient permissions. Please contact the Alibaba Cloud account administrator. | 权限不足,请联系主账号管理员 |
400 | ParameterError | The parameter is invalid. | 参数错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-05-19 | 新增 OpenAPI | 看变更集 |