首页 云呼叫中心 API参考 API目录 预测式外呼 ListCampaigns - 获取预测式外呼活动列表

ListCampaigns - 获取预测式外呼活动列表

调用ListCampaigns获取指定实例下的预测式外呼活动列表。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
Statestring

按预测式外呼活动状态过滤,非必填,默认为空。

Draft
枚举值:
- Draft: 草稿
- Completed: 已完成
- Executing: 执行中
- Pending: 待执行
- Aborted: 已终止
- Paused: Paused
Namestring

按预测式外呼活动名称过滤,不支持模糊匹配,非必填,默认为空,表示不过滤。

test-campaign
PlanedStartTimeFromstring

外呼活动计划开始时间,非必填,默认查询所有时间范围。

2021-10-14 00:00:00
PlanedStartTimeTostring

外呼活动计划结束时间,非必填,默认查询所有时间范围。

2021-10-14 20:59:59
ActualStartTimeFromstring

外呼活动实际开始时间,非必填,默认查询所有时间范围。

2021-10-14 20:59:59
ActualStartTimeTostring

外呼活动实际结束时间,非必填,默认查询所有时间范围。

2021-10-14 20:59:59
PageNumberLong

分页序号,范围1-100。

1
PageSizeLong

分页大小,范围1-100。

10
QueueIdstring

按技能组ID过滤,非必填,默认为空,表示不过滤。

skillgroup@ccc-test

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0
Messagestring

响应信息。

HttpStatusCodeLong

HTTP状态码。

200
Dataobject

数据。

Listarray

预测式外呼活动列表。

object

预测式外呼活动信息。

ActualEndTimeLong

预测式外呼活动实际结束时间,格式为Unix时间戳,单位毫秒。

1634008800000
ActualStartTimeLong

预测式外呼活动实际开始时间,格式为Unix时间戳,单位毫秒。

1634000460000
CasesAbortedLong

预测式外呼活动的止呼数量,止呼指取消呼叫联系人。

0
CasesUncompletedLong

预测式外呼活动的未完成数量,未完成指未接通且未达到最大重试次数。

0
CasesConnectedLong

预测式外呼活动的接通数量。

40
MaxAttemptCountLong

预测式外呼活动的最大尝试次数,表示当活动的号码呼叫失败时,最多重呼几次。

1
MinAttemptIntervalLong

预测式外呼活动的最小重呼间隔,表示失败重呼时的最小间隔,单位秒。

1
Namestring

预测式外呼活动名称。

test-campaign
PlanedEndTimeLong

预测式外呼活动计划结束时间,格式为Unix时间戳,单位毫秒。

1634054400000
PlanedStartTimeLong

预测式外呼活动计划开始时间,格式为Unix时间戳,单位毫秒。

1633968000000
QueueNamestring

技能组名称。

测试技能组
TotalCasesLong

号码总数。

100
Statestring

预测式外呼活动状态。

Completed
枚举值:
- Draft: 草稿
- Completed: 已完成
- Executing: 执行中
- Pending: 待执行
- Aborted: 已终止
- Paused: 已暂停
CampaignIdstring

预测式外呼活动ID。

6badb397-a8b5-40b6-21019d382a09
StrategyTypestring

预测式外呼活动的策略模式。

PACING
枚举值:
- PACING: 固定比例外呼,外呼数量=空闲坐席*比例。
- PID: 系统基于PID控制策略,自动调整外呼电话数量。
StrategyParametersstring

预测式外呼活动的策略参数,PID策略下的格式参数示例:{"abandonRate":"5","historicalConnectedRate":"35"},PACING策略下的格式参数示例:{"ratio":1}。abandonRate表示期望呼损率,historicalConnectedRate表示历史参考接通率,ratio表示固定外呼比例。

{"ratio":1}
QueueIdstring

关联的技能组ID。

skillgroup@ccc-test
Simulationboolean

是否为模拟活动。

false
PageNumberLong

分页序号,范围1-100。

1
PageSizeLong

分页大小,范围1-100。

10
TotalCountLong

总数。

1
Codestring

响应码。

OK
Successboolean

是否成功。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0",
  "Message": "无",
  "HttpStatusCode": 200,
  "Data": {
    "List": [
      {
        "ActualEndTime": 1634008800000,
        "ActualStartTime": 1634000460000,
        "CasesAborted": 0,
        "CasesUncompleted": 0,
        "CasesConnected": 40,
        "MaxAttemptCount": 1,
        "MinAttemptInterval": 1,
        "Name": "test-campaign",
        "PlanedEndTime": 1634054400000,
        "PlanedStartTime": 1633968000000,
        "QueueName": "测试技能组",
        "TotalCases": 100,
        "State": "Completed",
        "CampaignId": "6badb397-a8b5-40b6-21019d382a09",
        "StrategyType": "PACING",
        "StrategyParameters": "{\"ratio\":1}",
        "QueueId": "skillgroup@ccc-test",
        "Simulation": true
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  },
  "Code": "OK",
  "Success": true
}

错误码

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

阿里云首页 云呼叫中心 相关技术圈