獲取手機號碼實時在網狀態,例如正常、停機、空號等狀態。支持明文、MD5/SHA256加密方式的號碼查詢。
接口說明
- 請確保在使用本接口前,您已充分了解號碼百科產品定價。
- 默認僅阿里云賬號使用本接口,RAM 用戶只有在被授予相關 API 操作權限后才可使用。相關操作,請參見為 RAM 用戶授權。
- 使用本接口前,請登錄號碼百科控制臺,在標簽廣場頁面,找到對應的標簽,單擊申請開通,填寫申請資料,審批通過后即可使用。
QPS 限制
本接口的單用戶 QPS 限制為 300 次/秒。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dytns:PhoneNumberStatusForSms | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AuthCode | string | 是 | 授權碼。 說明
在號碼百科控制臺我的申請頁面,獲取授權 ID 即授權碼。
| zf08***pi6 |
InputNumber | string | 是 | 待查詢的號碼。
注意 加密字符串中字母不區分大小寫。 | 181****1234 |
Mask | string | 是 | 號碼的加密方式。取值:
| NORMAL |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "68A40250-50CD-034C-B728-0BD135850177",
"Data": {
"Status": "NORMAL",
"Carrier": "CMCC"
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
200 | OperatorLimit | The number is limited by the operator. | 該號碼受運營商限制 |
400 | MobileNumberIllegal | Wrong format of phone number | 手機號碼格式錯誤 |
400 | CarrierIllegal | Illegal carrier type | 運營商類型非法 |
400 | AuthCodeNotExist | The label application form does not exist, please replace the authorization code. | 該標簽申請單不存在,請重新更換授權碼 |
400 | MobileNumberTypeIllegal | Invalid number type. | 號碼類型錯誤 |
400 | MobileNumberTypeNotMatch | The number and number type do not match. | 號碼與號碼類型不匹配 |
400 | isp.UNKNOWN | An error occurred due to unknown reasons. | 系統返回了未知異常。 |
400 | InvalidParameter | Invalid parameter. | 無效參數 |
400 | AuthCodeIllegal | Illegal authCode. | 鑒權時使用的authcode不可用于該接口 |
500 | SystemError | System error | 系統異常 |
500 | Unknown | Unknown error | 未知異常 |
500 | EncyrptTypeIllegal | The encryption type of the mobile phone number is illegal | 手機號加密類型非法 |
500 | RequestTimeout | Request supplier timed out. | 請求供應商超時 |
500 | RequestSupplierError | Request supplier error. | 請求第三方服務異常。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-05-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-05-17 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-28 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-01 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-07-13 | 新增 OpenAPI | 查看變更詳情 |