GetAiOutboundTaskList - 获取外呼任务列表

更新时间:
复制 MD 格式

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

接口说明

  • 任务列表为任务信息列表,任务信息包含任务 ID、任务状态、任务名称、任务完成率等信息,具体参见返回参数

  • 若您需要更新任务信息,可调用 UpdateAiOutboundTask 接口。

QPS 限制

  • 单用户调用频率:100 次/秒。

  • API 频率:100 次/秒。

说明

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

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

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

agent_****

Type

integer

任务类型。取值:

  • 2:预测式外呼。

  • 3:自动外呼。

2

CreateTimeStart

integer

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

1615083365000

CreateTimeEnd

integer

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

1617761765000

Status

integer

任务状态。取值:

  • 0:未开始。

  • 1:进行中。

  • 2:系统暂停。

  • 3:手动暂停。

  • 4:已完成。

  • 5:已终止。

1

PageSize

integer

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

10

CurrentPage

integer

查询第几页。

1

SearchKey

string

过滤条件。

说明

匹配任务 ID 或模糊匹配任务名称。

1763****

返回参数

名称

类型

描述

示例值

object

返回数据。

RequestId

string

请求 ID。

EE338D98-9BD3-4413-B165

Message

string

状态码描述。

OK

Data

object

任务列表。

PageSize

integer

分页大小。

10

CurrentPage

integer

当前页数。

1

TotalResults

integer

数据总量。

10

List

array<object>

任务信息。

object

任务信息。

Status

integer

任务状态。取值:

  • 0:未开始。

  • 1:进行中。

  • 2:系统暂停。

  • 3:手动暂停。

  • 4:已完成。

  • 5:已终止。

0

FinishRate

number

任务完成率。

0.7

StatusDesc

string

任务状态描述。

未开始

HandlerId

integer

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

2468****

ConcurrentRate

integer

外呼并发。

说明

自动外呼特有参数。

1

TotalCount

integer

任务总量。

100

TaskId

integer

任务 ID。

1763****

Description

string

任务描述。

房产销售

CreateTime

integer

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

1615083365000

FinishCount

integer

任务已完成量。

70

HandlerName

string

技能组名称或 IVR 名称。

热线技能组

Name

string

任务名称。

xxxx外呼任务

HasNextPage

boolean

是否有下一页。取值:

  • true:是。

  • false:否。

false

Code

string

状态码。

OK

Success

boolean

接口调用是否成功。

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情