本文介紹如何使用OpenAPI調用PhoneNumberStatusForPublic接口查詢號碼狀態。。
步驟一:查看OpenAPI文檔
在調用OpenAPI前,建議您閱讀對應接口文檔PhoneNumberStatusForPublic,了解、學習調用該接口所需要的參數及權限等,更多詳情請參見API概覽。
步驟二:創建RAM用戶并完成授權
阿里云賬號擁有所有API的訪問權限,建議您創建并使用RAM用戶進行API訪問或日常運維。
您可以使用阿里云賬號(主賬號)、RAM用戶、RAM角色調用該接口,有關各種身份的差異請參見身份。
本案例中,我們使用RAM用戶進行接口調用。
登錄RAM 訪問控制。
在左側導航欄,選擇身份管理 > 用戶。
在用戶頁面,單擊創建用戶。
在創建用戶頁面,設置登錄名稱和顯示名稱、訪問方式為控制臺訪問。
單擊確定。
創建RAM用戶成功后,請記錄用戶登錄名稱和密碼,您在調用OpenAPI時,需要使用該RAM用戶登錄阿里云OpenAPI開發者門戶。
為RAM用戶授權。
重要AliyunDytnsReadOnlyAccess:只讀訪問號碼百科的權限。
AliyunDytnsFullAccess:管理號碼百科服務的權限。
如果您需要新建自定義權限,請參見自定義權限策略參考。
訪問RAM用戶列表。
單擊目標RAM用戶操作列的添加權限。
在文本框中輸入關鍵字
Dytns
進行搜索,選擇AliyunDytnsFullAccess策略。單擊確認新增授權,完成授權操作。
單擊目標RAM用戶名稱,進入到對應的RAM用戶詳情頁,在認證管理頁簽,點擊創建 AccessKey。
更多操作詳情,請參見創建AccessKey。
步驟三:調用OpenAPI
本文以Python語言SDK調用OpenAPI,其他語言SDK的用法類似,更多信息請參見號碼百科SDK。您也可根據業務的實際需要選擇其他調用方式,更多調用方法請參見調用方式。
準備Python環境
下載并安裝Python 3。如您已安裝Python,查看Python版本的命令示例:python --version
。
調用接口前,需要配置環境變量,以便通過環境變量讀取訪問憑證。AccessKey ID和AccessKey Secret的環境變量名:VMS_AK_ENV 、VMS_SK_ENV。配置詳情請參見在Linux、macOS和Windows系統配置環境變量。
安裝依賴
在終端設備中,逐條運行如下命令,安裝環境依賴。
pip3 install alibabacloud_credentials
pip install alibabacloud_dytnsapi20200217
pip3 install alibabacloud_tea_console
下載示例代碼
在左側的參數配置頁簽,填寫需要的參數信息,本示例服務地址選擇華東1(杭州)。
AuthCode 參數輸入示例值:hd2C****pe
InputNumber 參數輸入示例值:186******59
Mask 參數輸入示例值:NORMAL
在右側的SDK示例頁簽,選擇Python語言,單擊下載完整工程按鈕,下載示例代碼包。
本地解壓并進入alibabacloud_sample目錄。
運行代碼
執行以下命令:
python sample.py
返回示例如下:
{
"headers":{
"date":"Tue, 18 Jul 2023 07:48:57 GMT",
"content-type":"application/json;charset=utf-8",
"content-length":"123",
"connection":"keep-alive",
"keep-alive":"timeout=25",
"access-control-allow-origin":"*",
"access-control-expose-headers":"*",
"x-acs-request-id":"8F3768C6-2D01-590A-84C8-4A47EF3D****",
"x-acs-trace-id":"2f44951fc5bc041dda028620ee7a***8",
"etag":"1zWofCrnZYfYXfqdvTtM****"
},
"statusCode":200,
"body":{
"Code":"OK",
"Data":{
"Carrier":"CTCC",
"Status":"NORMAL"
},
"Message":"OK",
"RequestId":"8F3768C6-2D01-590A-84C8-4A47EF3D0955"
}
}