文档

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

预测式外呼活动状态。

枚举值:
  • Draft草稿
  • Completed已完成
  • Executing执行中
  • Pending待执行
  • Aborted已取消
  • Paused已暂停
Completed
CampaignIdstring

预测式外呼活动 ID。

6badb397-a8b5-40b6-21019d382a09
StrategyTypestring

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

枚举值:
  • PACING固定比例外呼,外呼数量 = 空闲坐席 * 比例
  • PID系统基于PID控制策略,自动调整外呼电话数量
PACING
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": false,
    "SimulationParameters": "无",
    "CasesUncompletedAfterAttempted": 1,
    "CasesUncompletedAfterAttempt": "",
    "CompletionRate": 0
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈