本產(chǎn)品（
云通信語音服務(wù)/2017-05-25）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機(jī)制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機(jī)制進(jìn)行自簽名對接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（11370001915），在專家指導(dǎo)下進(jìn)行簽名對接。在使用API前，您需要準(zhǔn)備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請參見獲取AccessKey。
發(fā)送語音通知
| API | 標(biāo)題 | API概述 |
|---|---|---|
| SingleCallByVoice | 發(fā)送語音通知文件類型的語音通知 | 調(diào)用接口給單個被叫號碼發(fā)送語音通知文件類型的語音通知。 |
發(fā)送語音驗(yàn)證碼
| API | 標(biāo)題 | API概述 |
|---|---|---|
| SingleCallByTts | 發(fā)送語音驗(yàn)證碼或文本轉(zhuǎn)語音類型的語音通知 | 調(diào)用接口給單個被叫號碼發(fā)送語音驗(yàn)證碼、文本轉(zhuǎn)語音類型的語音通知、語音通知文件中帶變量參數(shù)的語音通知。 |
語音通話任務(wù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateCallTask | 創(chuàng)建語音通話任務(wù) | 使用虛擬號碼給多個被叫號碼創(chuàng)建文本轉(zhuǎn)語音任務(wù)、語音通知任務(wù)和語音驗(yàn)證碼任務(wù)。 |
| ListCallTask | 獲取通話任務(wù)狀態(tài)列表 | 創(chuàng)建語音通話任務(wù)后，可以查看通話任務(wù)狀態(tài)，包括：任務(wù)ID、任務(wù)當(dāng)前狀態(tài)、任務(wù)所選的模板信息等。 |
| ExecuteCallTask | 執(zhí)行語音通話任務(wù) | 執(zhí)行通話任務(wù)。 |
| ListCallTaskDetail | 獲取通話任務(wù)詳情列表 | 執(zhí)行完通話任務(wù)后根據(jù)任務(wù)ID，查看指定任務(wù)詳情。 |
虛擬號碼
| API | 標(biāo)題 | API概述 |
|---|---|---|
| AddVirtualNumberRelation | 批量添加虛擬號碼與真實(shí)號碼綁定關(guān)系 | 批量添加虛擬號碼與真實(shí)號碼綁定關(guān)系。 |
| QueryVirtualNumber | 查詢虛擬號碼列表 | 查詢虛擬號碼列表。 |
| QueryVirtualNumberRelation | 查詢虛擬號碼與真實(shí)號碼綁定關(guān)系列表 | 查詢虛擬號碼與真實(shí)號碼綁定后的數(shù)據(jù)列表，包括綁定真實(shí)號的時間，號碼創(chuàng)建時間，一個虛擬號下綁定真實(shí)號的數(shù)量等。 |
查詢語音文件審核狀態(tài)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| QueryVoiceFileAuditInfo | 查詢語音文件審核狀態(tài) | 查詢語音文件審核狀態(tài)。 |
查詢呼叫詳情
| API | 標(biāo)題 | API概述 |
|---|---|---|
| QueryCallDetailByCallId | 查詢指定通話的呼叫詳情 | 查詢指定CallID的呼叫詳情，包括通話開始時間、通話時長、通話狀態(tài)、通話結(jié)束時間、被叫號碼等詳情。 |
交互式語音通話
| API | 標(biāo)題 | API概述 |
|---|---|---|
| IvrCall | 向指定號碼發(fā)起交互式語音通話 | 向指定號碼發(fā)起交互式語音通話。 |
智能語音交互通話
| API | 標(biāo)題 | API概述 |
|---|---|---|
| SmartCall | 發(fā)起智能語音交互通話 | 智能語音交互服務(wù)，是一種人機(jī)交互技術(shù)，它允許用戶通過語音與機(jī)器進(jìn)行自然的對話和溝通。 |
| SmartCallOperate | 發(fā)起智能語音指定動作 | 在智能外呼通話中發(fā)起指定動作，僅用于并行轉(zhuǎn)人工、人工坐席可旁聽人機(jī)對話等場景。 |
智能語音機(jī)器人
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateRobotTask | 發(fā)起智能語音機(jī)器人外呼任務(wù) | 發(fā)起智能語音機(jī)器人外呼任務(wù)。 |
| BatchRobotSmartCall | 批量發(fā)起智能語音機(jī)器人外呼任務(wù) | 批量發(fā)起智能語音機(jī)器人外呼任務(wù)，一次任務(wù)支持設(shè)置1~100個號碼。 |
| StartRobotTask | 啟動任務(wù)或定時啟動任務(wù) | 啟動智能語音任務(wù)或者定時啟動智能語音任務(wù)。 |
| StopRobotTask | 暫停智能語音任務(wù) | 暫停開始執(zhí)行后的智能語音任務(wù)。 |
| CancelOrderRobotTask | 取消智能語音任務(wù) | 取消還未啟動的定時智能語音任務(wù)。 |
| CancelRobotTask | 終止智能語音任務(wù) | 終止智能語音任務(wù)。 |
| DeleteRobotTask | 刪除智能語音任務(wù) | 刪除智能語音任務(wù)。 |
| QueryRobotv2AllList | 獲取全部機(jī)器人話術(shù)模板列表 | 獲取全部機(jī)器人話術(shù)模板列表。 |
| QueryRobotTaskList | 獲取所有任務(wù)ID | 獲取所有語音任務(wù)信息。 |
| QueryCallDetailByTaskId | 查看指定機(jī)器人外呼任務(wù)的話單詳情 | 查看指定機(jī)器人外呼任務(wù)的話單詳情。 |
| QueryRobotTaskDetail | 獲取智能語音任務(wù)詳情 | 獲取指定智能語音任務(wù)詳情。 |
| QueryRobotTaskCallList | 查詢?nèi)蝿?wù)內(nèi)執(zhí)行條目列表 | 查詢指定任務(wù)內(nèi)執(zhí)行條目列表。 |
| QueryRobotInfoList | 查詢智能語音機(jī)器人列表 | 查看智能語音機(jī)器人列表，獲取機(jī)器人詳細(xì)信息。 |
| QueryRobotTaskCallDetail | 查詢智能機(jī)器人任務(wù)執(zhí)行詳情 | 獲取單個執(zhí)行條目即單個被叫號碼的任務(wù)明細(xì)。 |
| UploadRobotTaskCalledFile | 上傳智能語音的被叫號碼 | 上傳智能語音任務(wù)的被叫號碼。 |
400號碼
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GetHotlineQualificationByOrder | 獲取400號碼資質(zhì)ID | 通過資質(zhì)申請工單號獲取400號碼的資質(zhì)ID。 |
| ListHotlineTransferRegisterFile | 獲取號碼備案信息 | 通過SubmitHotlineTransferRegister接口提交備案信息后，通過此接口獲取號碼備案信息。 |
| SubmitHotlineTransferRegister | 提交號碼備案 | 您在設(shè)置400號碼轉(zhuǎn)呼號碼前，需要對轉(zhuǎn)呼的號碼提交號碼備案。 |
| SetTransferCalleePoolConfig | 設(shè)置400號碼呼轉(zhuǎn) | 為400號碼設(shè)置轉(zhuǎn)呼號碼。 |
| QueryCallInPoolTransferConfig | 查詢400號碼呼轉(zhuǎn)配置詳情 | 設(shè)置400號碼轉(zhuǎn)呼后，通過此接口查詢400號碼呼轉(zhuǎn)配置詳情。 |
| QueryCallInTransferRecord | 查詢400號碼呼轉(zhuǎn)記錄 | 查詢呼轉(zhuǎn)記錄。 |
| ListHotlineTransferNumber | 獲取400號碼呼轉(zhuǎn)列表 | 獲取備案的呼轉(zhuǎn)號碼列表。 |
| SendVerification | 發(fā)送短信驗(yàn)證碼 | 發(fā)送短信驗(yàn)證碼。 |
5G視頻通話（邀約制）
| API | 標(biāo)題 | API概述 |
|---|---|---|
| SingleCallByVideo | 發(fā)送視頻通知 | 調(diào)用接口給單個被叫號碼發(fā)送語音文件通知或視頻文件通知。 |
| PlayVideoFile | 插播視頻 | 在語音通話中插播視頻文件。 |
| PauseVideoFile | 暫停視頻 | 在語音通話中插播視頻文件時，暫停視頻播放。 |
| ResumeVideoFile | 恢復(fù)視頻 | 在語音通話中暫停視頻播放后，恢復(fù)視頻播放。 |
| QueryVideoPlayProgress | 查詢視頻進(jìn)度 | 在語音通話中插播視頻文件后，查詢視頻播放進(jìn)度。 |
| UpgradeVideoFile | 視頻升級 | 從語音通話升級到視頻通話。 |
| DegradeVideoFile | 視頻降級 | 從視頻通話降級到語音通話。 |
| SkipVideoFile | 快進(jìn)或后退視頻 | 在播放視頻時，可以調(diào)用此接口快進(jìn)視頻或后退視頻。 |
| GetCallMediaType | 獲取通話類型 | 在通話時獲取通話類型。 |
| GetTemporaryFileUrl | 獲取文件臨時URL | 獲取視頻或語音文件臨時URL，方便您立即查看視頻或語音文件。 |
獲取認(rèn)證Token
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GetToken | 獲取認(rèn)證的Token | 獲取認(rèn)證的Token。 |