调用ListCampaigns获取指定实例下的预测式外呼活动列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
ccc-test |
| State |
string |
否 |
按预测式外呼活动状态过滤，非必填，默认为空。 枚举值：
|
Draft |
| Name |
string |
否 |
按预测式外呼活动名称过滤，不支持模糊匹配，非必填，默认为空，表示不过滤。 |
test-campaign |
| PlanedStartTimeFrom |
string |
否 |
外呼活动计划开始时间，非必填，默认查询所有时间范围。 |
2021-10-14 00:00:00 |
| PlanedStartTimeTo |
string |
否 |
外呼活动计划结束时间，非必填，默认查询所有时间范围。 |
2021-10-14 20:59:59 |
| ActualStartTimeFrom |
string |
否 |
外呼活动实际开始时间，非必填，默认查询所有时间范围。 |
2021-10-14 20:59:59 |
| ActualStartTimeTo |
string |
否 |
外呼活动实际结束时间，非必填，默认查询所有时间范围。 |
2021-10-14 20:59:59 |
| PageNumber |
integer |
是 |
分页序号，范围 1-100。 |
1 |
| PageSize |
integer |
是 |
分页大小，范围 1-100。 |
10 |
| QueueId |
string |
否 |
按技能组 ID 过滤，非必填，默认为空，表示不过滤。 |
skillgroup@ccc-test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0 |
| Message |
string |
响应信息。 |
无 |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Data |
object |
数据。 |
|
| List |
array<object> |
预测式外呼活动列表。 |
|
|
object |
预测式外呼活动信息。 |
||
| ActualEndTime |
integer |
预测式外呼活动实际结束时间，格式为 Unix 时间戳，单位毫秒。 |
1634008800000 |
| ActualStartTime |
integer |
预测式外呼活动实际开始时间，格式为 Unix 时间戳，单位毫秒。 |
1634000460000 |
| CasesAborted |
integer |
预测式外呼活动的止呼数量，止呼指取消呼叫联系人。 |
0 |
| CasesUncompleted |
integer |
预测式外呼活动的未完成数量，未完成指未接通且未达到最大重试次数。 |
0 |
| CasesConnected |
integer |
预测式外呼活动的接通数量。 |
40 |
| MaxAttemptCount |
integer |
预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。 |
1 |
| MinAttemptInterval |
integer |
预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位秒。 |
1 |
| Name |
string |
预测式外呼活动名称。 |
test-campaign |
| PlanedEndTime |
integer |
预测式外呼活动计划结束时间，格式为 Unix 时间戳，单位毫秒。 |
1634054400000 |
| PlanedStartTime |
integer |
预测式外呼活动计划开始时间，格式为 Unix 时间戳，单位毫秒。 |
1633968000000 |
| QueueName |
string |
技能组名称。 |
测试技能组 |
| TotalCases |
integer |
号码总数。 |
100 |
| State |
string |
预测式外呼活动状态。 枚举值：
|
Completed |
| CampaignId |
string |
预测式外呼活动 ID。 |
6badb397-a8b5-40b6-21019d382a09 |
| StrategyType |
string |
预测式外呼活动的策略模式。 枚举值：
|
PACING |
| StrategyParameters |
string |
预测式外呼活动的策略参数，PID 策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING 策略下的格式参数示例：{"ratio":1}。abandonRate 表示期望呼损率，historicalConnectedRate 表示历史参考接通率，ratio 表示固定外呼比例。 |
{"ratio":1} |
| QueueId |
string |
关联的技能组 ID。 |
skillgroup@ccc-test |
| Simulation |
boolean |
是否为模拟活动。 |
false |
| CompletionRate |
number |
完成率，参数已废弃，可以使用(TotalCases-CasesUnCompleted) / TotalCases 计算得出 |
无 |
| ContactFlowId |
string |
||
| PageNumber |
integer |
分页序号，范围 1-100。 |
1 |
| PageSize |
integer |
分页大小，范围 1-100。 |
10 |
| TotalCount |
integer |
总数。 |
1 |
| Code |
string |
响应码。 |
OK |
| Success |
boolean |
是否成功。 |
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": false,
"CompletionRate": 0,
"ContactFlowId": ""
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1
},
"Code": "OK",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。