通過編程的方式在業務系統中集成號碼隱私保護服務的能力,做到根據業務的實際需要自動化發起隱私通話,簡化運營、管理成本。本文為您介紹號碼隱私保護服務開放的OpenAPI及支持的集成方式。
OpenAPI介紹
為了能夠讓開發者快速高效的學習和使用云產品OpenAPI,阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動生成相應的SDK調用示例,幫助您快速使用阿里云產品。更多信息,請參見什么是 OpenAPI。
版本說明
號碼隱私保護服務提供隱私號碼綁定、獲取錄音文件、查詢隱私號碼等多種OpenAPI,滿足您在業務系統中的集成需求。
阿里云OpenAPI通過版本號管控各時期云產品大版本的API列表。
例如:號碼隱私保護服務目前支持2017-05-25
版本的API列表,2017-05-25
代表的是API版本號而非時間概念,所展示的都是最新的API公開數據,并非自2017-05-25
之后就未更新。
API版本號 | 說明 |
推薦使用 |
在線調試
號碼隱私保護服務在OpenAPI門戶提供API調試等功能。在調用前,您需要了解號碼隱私保護服務提供的版本、接入點、接口風格、調用方式等信息。
調試入口
調試API入口為:https://api.aliyun.com/api/Dyplsapi/2017-05-25/
接入點說明
根據相關資源所在地域,選擇對應的服務接入點地址,以獲得最低延遲。
全局接入域名dyplsapi.aliyuncs.com
。更多信息,請參見服務接入點。
支持的調用身份
您阿里云賬號登錄OpenAPI網站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。請根據業務的實際情況按需分配權限后進行接口調用。RAM用戶需具備操作權限,詳情請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
集成方式
號碼隱私保護服務提供SDK等多種集成方式,您可以根據業務的實際需要進行選擇。
阿里云SDK
阿里云為開發者提供了多種編程語言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++等)的SDK。開發者只需集成SDK,通過SDK暴露的方法直接調用OpenAPI。SDK統一封裝了簽名邏輯、超時機制、重試機制,并根據文檔返回結構化Response對象,易于開發。更多關于阿里云SDK的介紹,請參見阿里云SDK。
號碼隱私保護服務SDK支持的語言及依賴安裝方法請參見SDK參考。
阿里云CLI
阿里云命令行工具可以幫助您在使用命令行終端時,通過
aliyun
命令與阿里云服務進行交互,管理云服務資源。有關阿里云CLI的更多詳細信息,請參見什么是阿里云CLI?。暫不支持使用阿里云CLI調用號碼隱私保護服務。
資源編排ROS
資源編排服務ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS實例、RDS數據庫實例)、資源間的依賴關系等。ROS的編排引擎將根據模板自動完成所有資源的創建和配置,實現自動化部署及運維。更多詳情,請參見什么是資源編排服務。
暫不支持使用資源編排ROS調用號碼隱私保護服務。
自定義封裝API調用
如果以上方案均無法滿足您的業務需要,可自行封裝請求調用OpenAPI(不推薦),詳情請參見V3版本請求體&簽名機制。
注意事項
如果調用號碼隱私保護服務API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確,更多信息請參見API錯誤碼。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。