調用StartPredictiveCall發起預測式外呼。
接口說明
云呼叫中心除了支持客服從坐席工作臺發起外呼外，還支持從自有業務系統后臺發起外呼，待接通后轉給坐席。以支持把云呼叫中心功能無縫嵌入您的業務流程。 比如，您的客戶可以在您的微信公眾號上，輸入自己的號碼，并點擊咨詢產品的按鈕，由您的后臺系統調用本接口，實現呼叫客戶手機，接通后播放“我們收到您在公眾號上對我們產品的咨詢，現在給您轉接顧問，請稍等”，并轉給合適的客服接聽通話。 相較于 1.0 的 DialEX 接口，用戶使用該接口可以更加靈活的進行配置。除了可以自定義外呼轉入的 IVR 外，還可以傳入自定義的參數，在 IVR 中對參數進行語音播報，實現通知的場景。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實例 ID。 | ccc-test |
| Caller | string | 是 | 主叫號碼，需要是實例下可用的外呼號碼。 | 0109810**** |
| Callee | string | 是 | 被叫號碼。 | 1312353**** |
| TimeoutSeconds | integer | 否 | 超時時間，呼叫在經過該參數指定的時間仍然未接通的情況下，則主動掛斷，單位秒。 | 10 |
| ContactFlowId | string | 是 | IVR 聯系流 ID，被叫接通后，通話將自動轉入此 IVR 流程。 | 9774c36c-12fe-4e37-adce-89bc77ce**** |
| Tags | string | 否 | 隨路數據，主要用于擴展需求，普通用戶無需關心。 | 無 |
| ContactFlowVariables | string | 否 | 傳入的聯系流變量，格式為 JSON 數組的字符串，數組元素是一個鍵值對，Key 為變量名，Value 為變量值。在聯系流 ID 對應的 IVR 的開始節點中新建同名的自定義參數，即可在 IVR 流程中使用該參數。 | {"name":"王先生","time":"19點20分","address":"某某中心"} |
| MaskedCallee | string | 否 | 脫敏后的被叫號碼，如果該字段不為空，表示需要對被叫號碼脫敏，脫敏規則由客戶自行定義，只需將脫敏后的被叫號碼填入即可，使用脫敏被叫會導致某些場景下看到的是脫敏后的被叫號碼，無法查看真實被叫號碼。 | 1312353**** |
| SkillGroupId | string | 否 | 技能組 ID，非必填，如果該參數有值，則外呼號碼僅從該參數指定的技能組的關聯號碼中選取。 | skillgroup@ccc-test |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "無",
"RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
"Params": [
"無"
],
"Data": {
"CallContext": {
"CallType": "OUTBOUND",
"InstanceId": "ccc-test",
"JobId": "job-6570007401392****",
"ChannelContexts": [
{
"ReleaseInitiator": "無",
"ChannelState": "NONE",
"Destination": "8001****",
"UserId": "agent@ccc-test",
"ChannelFlags": "[]",
"Timestamp": 1609225718295,
"ReleaseReason": "無",
"CallType": "OUTBOUND",
"JobId": "job-6570007401392****",
"ChannelId": "ch:user:131888****->8001****:1609225718294:job-6570007401392****",
"Originator": "1318888****",
"UserExtension": "8001****"
}
]
},
"UserContext": {
"Extension": "8001****",
"Heartbeat": 1609136956378,
"WorkMode": "ON_SITE",
"DeviceId": "ACC-YUNBS-1.0.10-****",
"UserId": "agent@ccc-test",
"Reserved": 1609136956378,
"BreakCode": "Warm-up",
"InstanceId": "ccc-test",
"OutboundScenario": false,
"DeviceState": "ONLINE",
"Mobile": "1324730****",
"JobId": "job-6570007401392****",
"UserState": "READY",
"SignedSkillGroupIdList": [
"skillgroup1@ccc-test"
]
}
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Parameter.Blank | The parameter %s may not be null or blank. | 該參數不能為null或含有空白符的字符串。 |
| 404 | NotExists.Number | The specified number %s does not exist in instance %s. | 呼叫中心實例中不存在指定的號碼。 |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心實例不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2021-11-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |