發起機器人外呼。支持根據配置好的機器人ID,即話術ID,通過外呼主叫號碼呼叫被叫號碼,可選擇通話過程是否錄音等功能。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CalledShowNumber | string | 是 | 外呼主叫號碼。 | 0571****5678 |
CalledNumber | string | 是 | 被叫號碼。 | 131****2204 |
RobotId | long | 是 | 機器人 ID,即話術 ID。 您可以在智能聯絡中心控制臺左側導航欄的智能外呼機器人>話術管理中獲取。 | 350000**** |
OutId | string | 否 | 預留給調用方使用的 ID。 最終會通過在回執消息中將此 ID 帶回給調用方。字符串類型,長度為 1~15 個字節。 | abcdefgh |
RecordFlag | boolean | 否 | 通話過程是否錄音。取值:
| true |
EarlyMediaAsr | boolean | 否 | 是否啟用號碼狀態(早媒體)識別標識。取值:
說明
設為 true 會記錄通話未接聽的原因。
| false |
Params | string | 否 | 機器人的參數列表。JSON 格式。總長度不要超過 512 個字節。 | {"name":"張三","age":"25"} |
返回參數
示例
正常返回示例
JSON
格式
{
"Message": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Data": "116012854210^10281427*****",
"Code": "OK"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Permission.NotAuthorized | Insufficient permissions. Please contact the primary account administrator. | 權限不足,請聯系主賬號管理員 |
400 | Parameter.Error | Parameter error. | 參數錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2021-05-19 | 新增 OpenAPI | 查看變更詳情 |