本產(chǎn)品（
號(hào)碼隱私保護(hù)服務(wù)/2017-05-25）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見(jiàn)簽名機(jī)制說(shuō)明。我們已經(jīng)為開(kāi)發(fā)者封裝了常見(jiàn)編程語(yǔ)言的SDK，開(kāi)發(fā)者可通過(guò)下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無(wú)需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿(mǎn)足使用需求，可通過(guò)簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（11370001915），在專(zhuān)家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪(fǎng)問(wèn)密鑰（AccessKey），才能有效通過(guò)客戶(hù)端工具（SDK、CLI等）訪(fǎng)問(wèn)API。細(xì)節(jié)請(qǐng)參見(jiàn)獲取AccessKey。
添加號(hào)碼綁定
| API | 標(biāo)題 | API概述 |
|---|---|---|
| BindAxb | AXB中間號(hào)-號(hào)碼綁定 | AXB中間號(hào)，是將撥打關(guān)系限定在一對(duì)一關(guān)系中，用戶(hù)A可以通過(guò)中間號(hào)碼X聯(lián)系到用戶(hù)B，用戶(hù)B也可以通過(guò)中間號(hào)碼X聯(lián)系到用戶(hù)A。 |
| BindAxn | AXN隱私號(hào)-號(hào)碼綁定 | 添加AXN隱私號(hào)的綁定關(guān)系。AXN隱私號(hào)是為A用戶(hù)分配一個(gè)專(zhuān)屬的隱私號(hào)，任何號(hào)碼N通過(guò)撥打X號(hào)碼都可以轉(zhuǎn)接到A。 |
| BindAxnExtension | AXN分機(jī)號(hào)-號(hào)碼綁定 | 添加AXN分機(jī)號(hào)的綁定關(guān)系。AXN分機(jī)號(hào)與AXN隱私號(hào)功能類(lèi)似，AXN分機(jī)號(hào)在A(yíng)XN基礎(chǔ)上引入了分機(jī)號(hào)，從而降低X號(hào)碼的使用量，在呼叫時(shí)候首先撥打X號(hào)碼，聽(tīng)到提示音后輸入對(duì)應(yīng)分機(jī)號(hào)轉(zhuǎn)接到A。 |
| BindAxg | AXG隱私號(hào)-號(hào)碼綁定 | 添加AXG號(hào)碼的綁定關(guān)系。AXG產(chǎn)品是針對(duì)有用戶(hù)分級(jí)需求、限制呼叫范圍、限制搶單等場(chǎng)景的客戶(hù)需求提供的號(hào)碼隱私保護(hù)解決方案，其中G代表一個(gè)號(hào)碼組，可以根據(jù)需要添加號(hào)碼。 |
| BindBatchAxg | 批量添加AXG號(hào)碼的綁定關(guān)系 | 批量添加AXG號(hào)碼的綁定關(guān)系。AXG產(chǎn)品是針對(duì)有用戶(hù)分級(jí)需求、限制呼叫范圍、限制搶單等場(chǎng)景的客戶(hù)需求提供的號(hào)碼隱私保護(hù)解決方案，其中G代表一個(gè)號(hào)碼組，可以根據(jù)需要添加號(hào)碼。 |
| UpdateSubscription | 修改已綁定的號(hào)碼 | 修改號(hào)碼的綁定關(guān)系。 |
| UnbindSubscription | 解除已綁定的號(hào)碼 | 解除號(hào)碼的綁定關(guān)系。 |
查詢(xún)號(hào)碼綁定
| API | 標(biāo)題 | API概述 |
|---|---|---|
| QuerySubscriptionDetail | 查詢(xún)號(hào)碼綁定詳情 | 查詢(xún)號(hào)碼的綁定詳情。獲取號(hào)碼綁定關(guān)系狀態(tài)、分機(jī)號(hào)碼、是否錄音、ASR狀態(tài)等信息。 |
| QuerySubsId | 查詢(xún)號(hào)碼綁定ID | 查詢(xún)綁定關(guān)系的唯一標(biāo)識(shí)SubsId。 |
| QuerySecretNoDetail | 查詢(xún)隱私號(hào)碼屬性 | 查詢(xún)隱私號(hào)碼的屬性信息。 |
G號(hào)碼組
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAxgGroup | 創(chuàng)建G號(hào)碼組 | 創(chuàng)建G號(hào)碼組。僅AXG隱私號(hào)類(lèi)型的號(hào)碼池支持設(shè)置G號(hào)碼組。 |
| OperateAxgGroup | 修改G號(hào)碼組 | 修改G號(hào)碼組中的號(hào)碼，可以對(duì)號(hào)碼進(jìn)行添加、刪除、全量替換操作。 |
| DeleteAxgGroup | 刪除G號(hào)碼組 | 刪除G號(hào)碼組。僅AXG隱私號(hào)類(lèi)型的號(hào)碼池支持設(shè)置G號(hào)碼組。 |
錄音及ASR獲取
| API | 標(biāo)題 | API概述 |
|---|---|---|
| QueryRecordFileDownloadUrl | 獲取錄音文件的下載鏈接 | 根據(jù)號(hào)碼池Key、呼叫記錄ID、呼叫發(fā)起時(shí)間等獲取錄音文件的下載鏈接。 |
| GetTotalPublicUrl | 獲取響鈴放音的錄音下載鏈接 | 獲取響鈴放音的錄音下載鏈接。 |
| GetSecretAsrDetail | 獲取ASR識(shí)別結(jié)果詳情 | 獲取ASR識(shí)別結(jié)果詳情。 |
號(hào)碼資源管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| AddSecretBlacklist | 添加黑名單 | 向號(hào)碼池添加黑名單。僅AXN隱私號(hào)、AXN分機(jī)號(hào)、95AXN隱私號(hào)類(lèi)型的號(hào)碼池支持設(shè)置黑名單。 |
| DeleteSecretBlacklist | 刪除黑名單 | 刪除號(hào)碼池的黑名單。僅AXN隱私號(hào)、AXN分機(jī)號(hào)、95AXN隱私號(hào)類(lèi)型的號(hào)碼池支持設(shè)置黑名單。 |
| OperateBlackNo | 新增或刪除黑名單 | 新增或刪除號(hào)池黑名單。僅AXN隱私號(hào)、AXN分機(jī)號(hào)、95AXN隱私號(hào)類(lèi)型的號(hào)碼池支持設(shè)置黑名單。 |
| ReleaseSecretNo | 釋放號(hào)碼 | 釋放號(hào)碼。釋放后所選號(hào)碼將不可繼續(xù)使用。 |
| LockSecretNo | 鎖定號(hào)碼 | 鎖定號(hào)碼。適用于需要臨時(shí)屏蔽異常號(hào)碼的場(chǎng)景。 |
| UnlockSecretNo | 解鎖號(hào)碼 | 解鎖號(hào)碼。解除號(hào)碼的臨時(shí)屏蔽。 |
電商物流行業(yè)接口
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreatePickUpWaybillPreQuery | 寄件下單預(yù)查詢(xún) | 寄件下單預(yù)查詢(xún)。 |
| CreatePickUpWaybill | 創(chuàng)建上門(mén)寄件訂單 | 創(chuàng)建上門(mén)寄件訂單。 |
| CancelPickUpWaybill | 取消上門(mén)寄件訂單 | 取消上門(mén)寄件訂單。 |
| AddAxnTrackNo | 為AXN隱私號(hào)添加運(yùn)單號(hào) | 為AXN隱私號(hào)添加運(yùn)單號(hào)。 |
| QueryPhoneNoAByTrackNo | 進(jìn)行運(yùn)單號(hào)廣播推送 | 廣播推送運(yùn)單號(hào)。 |