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

GetCampaign - 获取预测式外呼活动

调用GetCampaign获取指定实例下指定ID对应的预测式外呼活动。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
CampaignIdstring

预测式外呼活动ID。

6badb397-a8b5-40b6-21019d382a09

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

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

HTTP状态码。

200
Codestring

响应码。

OK
Dataobject

数据

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
SimulationParametersstring

模拟活动参数,用于测试,普通客户无需关心。

CasesUncompletedAfterAttemptedLong

尝试呼叫过但未接通,且未达到最大尝试次数的联系人数量。即经过重试后呼叫成功的联系人。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Data": {
    "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,
    "SimulationParameters": "无",
    "CasesUncompletedAfterAttempted": 1
  }
}

错误码

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

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