GetAiOutboundTaskList - 获取外呼任务列表

根据实例ID、任务类型获取外呼任务列表。

接口说明

  • 任务列表为任务信息列表,任务信息包含任务 ID、任务状态、任务名称、任务完成率等信息,具体参见返回参数
  • 若您需要更新任务信息,可调用 UpdateAiOutboundTask 接口。

QPS 限制

  • 单用户调用频率:100 次/秒。
  • API 频率:100 次/秒。
说明 如果多个用户的总调用超过 API 频率也会触发流控。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

AICCS 实例 ID。 您可以在智能联络中心控制台左侧导航栏的实例管理中获取。

agent_****
Typeinteger

任务类型。取值:

  • 2:预测式外呼。
  • 3:自动外呼。
2
CreateTimeStartlong

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

1615083365000
CreateTimeEndlong

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

1617761765000
Statusinteger

任务状态。取值:

  • 0:未开始。
  • 1:进行中。
  • 2:系统暂停。
  • 3:手动暂停。
  • 4:已完成。
  • 5:已终止。
1
PageSizeinteger

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

10
CurrentPageinteger

查询第几页。

1
SearchKeystring

过滤条件。

说明 匹配任务 ID 或模糊匹配任务名称。
1763****

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

EE338D98-9BD3-4413-B165
Messagestring

状态码描述。

OK
Codestring

状态码。

OK
Successboolean

接口调用是否成功。

  • true:成功。
  • false:失败。
true
Dataobject

任务列表。

PageSizeinteger

分页大小。

10
HasNextPageboolean

是否有下一页。取值:

  • true:是。
  • false:否。
false
TotalResultsinteger

数据总量。

10
CurrentPageinteger

当前页数。

1
Listarray<object>

任务信息。

Listobject

任务信息。

TaskIdlong

任务 ID。

1763****
Statusinteger

任务状态。取值:

  • 0:未开始。
  • 1:进行中。
  • 2:系统暂停。
  • 3:手动暂停。
  • 4:已完成。
  • 5:已终止。
0
StatusDescstring

任务状态描述。

未开始
Namestring

任务名称。

xxxx外呼任务
Descriptionstring

任务描述。

房产销售
HandlerIdlong

技能组 ID(预测式)或者 IVR ID(自动外呼)。

2468****
HandlerNamestring

技能组名称或 IVR 名称。

热线技能组
ConcurrentRateinteger

外呼并发。

说明 自动外呼特有参数。
1
TotalCountinteger

任务总量。

100
FinishCountinteger

任务已完成量。

70
FinishRatefloat

任务完成率。

0.7
CreateTimelong

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

1615083365000

示例

正常返回示例

JSON格式

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

错误码

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