調(diào)用CreateCampaign在指定實(shí)例下創(chuàng)建預(yù)測式外呼活動。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實(shí)例 ID。 | ccc-test |
| CaseList | array<object> | 否 | 預(yù)測式外呼名單列表，不能與 CaseFileKey（從文件導(dǎo)入）同時(shí)使用，文件導(dǎo)入和列表導(dǎo)入只能選擇一種。 | |
| object | 否 | 預(yù)測式外呼名單。 | ||
| ReferenceId | string | 否 | 業(yè)務(wù) ID，客戶業(yè)務(wù)系統(tǒng)標(biāo)識，用于集成場景。 | 01 |
| PhoneNumber | string | 否 | 聯(lián)系人電話號碼。 | 1888888888 |
| CustomVariables | string | 否 | 客戶自定義變量，格式為 JSON 對象，對象最多包含 10 個(gè)屬性，每個(gè)屬性的名稱和值均由客戶自定義。 | {"name":"customer","客戶標(biāo)簽":"tag"} |
| QueueId | string | 是 | 預(yù)測式外呼活動關(guān)聯(lián)的技能組 ID。 | skillgroup@ccc-test |
| Name | string | 是 | 預(yù)測式外呼活動名稱。 | test-campaign |
| CaseFileKey | string | 否 | 預(yù)測式外呼名單文件，是一個(gè) OSS 對象的 Key，通過 GetCaseFileUploadUrl 接口獲取。 | ccc-test/namelist.csv |
| ContactFlowId | string | 是 | 預(yù)測式外呼活動關(guān)聯(lián)的聯(lián)系流 ID。 | c1f2bc75-422e-43c7-9c9d9d95633a |
| StartTime | string | 是 | 預(yù)測式外呼活動開始時(shí)間，格式為 Unix 時(shí)間戳，單位毫秒。 | 1634140800000 |
| EndTime | string | 是 | 預(yù)測式外呼活動結(jié)束時(shí)間，格式為 Unix 時(shí)間戳，單位毫秒。 | 1634313600000 |
| CallableTime | string | 是 | 預(yù)測式外呼活動的可外呼時(shí)段，格式為 JSON 對象，對象包含兩個(gè)屬性，beginTime 和 EndTime，例如：[{"beginTime":"00:00:00","endTime":"23:00:00" }]。 | [{"beginTime":"00:00:00","endTime":"23:00:00" }] |
| StrategyType | string | 是 | 預(yù)測式外呼活動的策略模式。 枚舉值：
| PACING |
| StrategyParameters | string | 是 | 預(yù)測式外呼活動的策略參數(shù)，PID 策略下的格式參數(shù)示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING 策略下的格式參數(shù)示例：{"ratio":1}。abandonRate 表示期望呼損率，historicalConnectedRate 表示歷史參考接通率，ratio 表示固定外呼比例。 | {"ratio":1} |
| MaxAttemptCount | long | 是 | 預(yù)測式外呼活動的最大嘗試次數(shù)，表示當(dāng)活動的號碼呼叫失敗時(shí)，最多重呼幾次。 | 1 |
| MinAttemptInterval | long | 是 | 預(yù)測式外呼活動的最小重呼間隔，表示失敗重呼時(shí)的最小間隔，單位分鐘。 | 1 |
| Simulation | boolean | 否 | 是否是模擬活動，用于測試，普通客戶無需關(guān)心。 | 無 |
| SimulationParameters | string | 否 | 模擬參數(shù)，用于測試，普通客戶無需關(guān)心。 | 無 |
| ExecutingUntilTimeout | boolean | 否 | 是否在活動到期前保持執(zhí)行狀態(tài)。默認(rèn)值 fasle，當(dāng)活動的所有聯(lián)系人都呼叫完成后，活動會自動變?yōu)橐淹瓿蔂顟B(tài)；如果為 True，當(dāng)活動的所有聯(lián)系人都呼叫完成后，活動不會自動變成已完成狀態(tài)，仍是執(zhí)行中狀態(tài)，可以繼續(xù)像活動中追加聯(lián)系人，進(jìn)而繼續(xù)進(jìn)行撥打，直到任務(wù)到期或手動終止。 | false |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "7CC6523B-0E51-1B62-8DA5-6A9831CAE315",
"Data": "c58b9719-3bc3-441d-a4d3-fc0309ef7066",
"Code": "OK",
"Message": "無",
"HttpStatusCode": 200
}錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|