向指定號碼發起交互式語音通話。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CalledShowNumber | string | 是 | 主叫號碼。 必須是已購買的號碼，單次請求僅支持一個主叫號碼。一般號碼都有并發數，超過并發數會請求失敗。您可以登錄語音服務控制臺，在語音號碼>真實號管理頁面查看已購買的號碼。 | 0571****5678 |
| CalledNumber | string | 是 | 被叫號碼。 僅支持中國內地號碼，單次請求僅支持一個號碼。 | 1590****000 |
| StartCode | string | 是 | TTS_1234**** | |
| StartTtsParams | string | 否 | 文本轉語音模板內的變量參數，格式為 JSON。 說明
當 StartCode 為文本轉語音模板（TTS）且模板中帶變量的情況下，此參數必填。
| {"name":"xxx","code":"123"} |
| PlayTimes | long | 否 | 重復播放次數。取值范圍為1~3。 | 3 |
| ByeCode | string | 否 | TTS_1234**** | |
| ByeTtsParams | string | 否 | 文本轉語音模板中的變量參數。格式為 JSON。 說明
當 ByeCode 為文本轉語音（TTS）模板且模板中帶變量的情況下，此參數必填。
| {"name":"xxx","code":"123"} |
| Timeout | integer | 否 | 等待用戶按鍵超時時間。單位：毫秒。 | 3000 |
| OutId | string | 否 | 預留給調用方使用的 ID。最終會通過在回執消息中將此 ID 帶回給調用方。 字符串類型，長度為 1~15 個字節。 | PR0210428**** |
| MenuKeyMap | array<object> | 是 | 按鍵信息。 | |
| object | 是 | 按鍵信息。 | ||
| Key | string | 否 | 被叫方可按的電話按鍵。 | 1 |
| TtsParams | string | 否 | 文本轉語音模板內的變量參數，格式為 JSON。 說明
| {"name":"xxx","code":"123"} |
| Code | string | 否 | TTS_1235**** |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
"CallId": "116012354148^10281378****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-06-26 | API 內部配置變更，不影響調用 | 查看變更詳情 |