调用CreateCampaign在指定实例下创建预测式外呼活动。
接口说明
调用 CreateCampaign 在指定实例下创建预测式外呼活动。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
ccc-test |
| CaseList |
array<object> |
否 |
预测式外呼名单列表，不能与 CaseFileKey（从文件导入）同时使用，文件导入和列表导入只能选择一种。 |
|
|
object |
否 |
预测式外呼名单。 |
||
| ReferenceId |
string |
否 |
业务 ID，客户业务系统标识，用于集成场景。 |
01 |
| PhoneNumber |
string |
否 |
联系人电话号码。 |
1888888888 |
| CustomVariables |
string |
否 |
客户自定义变量，格式为 JSON 对象，对象最多包含 10 个属性，每个属性的名称和值均由客户自定义。 |
{"name":"customer","客户标签":"tag"} |
| QueueId |
string |
是 |
预测式外呼活动关联的技能组 ID。 |
skillgroup@ccc-test |
| Name |
string |
是 |
预测式外呼活动名称。 |
test-campaign |
| CaseFileKey |
string |
否 |
预测式外呼名单文件，是一个 OSS 对象的 Key，通过 GetCaseFileUploadUrl 接口获取。 |
ccc-test/namelist.csv |
| ContactFlowId |
string |
是 |
预测式外呼活动关联的联系流 ID。 |
c1f2bc75-422e-43c7-9c9d9d95633a |
| StartTime |
string |
是 |
预测式外呼活动开始时间，格式为 Unix 时间戳，单位毫秒。 |
1634140800000 |
| EndTime |
string |
是 |
预测式外呼活动结束时间，格式为 Unix 时间戳，单位毫秒。 |
1634313600000 |
| CallableTime |
string |
是 |
预测式外呼活动的可外呼时段，格式为 JSON 对象，对象包含两个属性，beginTime 和 EndTime，例如：[{"beginTime":"00:00:00","endTime":"23:00:00" }]。 |
[{"beginTime":"00:00:00","endTime":"23:00:00" }] |
| StrategyType |
string |
是 |
预测式外呼活动的策略模式。 枚举值：
|
PACING |
| StrategyParameters |
string |
是 |
预测式外呼活动的策略参数，PID 策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING 策略下的格式参数示例：{"ratio":1}。abandonRate 表示期望呼损率，historicalConnectedRate 表示历史参考接通率，ratio 表示固定外呼比例。 |
{"ratio":1} |
| MaxAttemptCount |
integer |
是 |
预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。 |
1 |
| MinAttemptInterval |
integer |
是 |
预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位分钟。 |
1 |
| Simulation |
boolean |
否 |
是否是模拟活动，用于测试，普通客户无需关心。 |
无 |
| SimulationParameters |
string |
否 |
模拟参数，用于测试，普通客户无需关心。 |
无 |
| ExecutingUntilTimeout |
boolean |
否 |
是否在活动到期前保持执行状态。默认值 fasle，当活动的所有联系人都呼叫完成后，活动会自动变为已完成状态；如果为 True，当活动的所有联系人都呼叫完成后，活动不会自动变成已完成状态，仍是执行中状态，可以继续像活动中追加联系人，进而继续进行拨打，直到任务到期或手动终止。 |
false |
| FlashSmsParameters |
string |
否 |
闪信参数 |
{"applicationId":"08e6b63a-****-****-****-689a288cdbb5","templateId":"325"} |
| NumberList |
array |
否 |
主叫号码列表 |
|
|
string |
否 |
号码 |
01012345678 |
|
| InstGroupId |
string |
否 |
号码集合 ID |
0d368091-2c70-4d26-979a-6997ddc9c34f |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
7CC6523B-0E51-1B62-8DA5-6A9831CAE315 |
| Data |
string |
预测式外呼活动 ID。 |
c58b9719-3bc3-441d-a4d3-fc0309ef7066 |
| Code |
string |
响应码。 |
OK |
| Message |
string |
响应信息。 |
无 |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
示例
正常返回示例
JSON格式
{
"RequestId": "7CC6523B-0E51-1B62-8DA5-6A9831CAE315",
"Data": "c58b9719-3bc3-441d-a4d3-fc0309ef7066",
"Code": "OK",
"Message": "无",
"HttpStatusCode": 200
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。