調用本接口進行H5頁面本機號碼校驗認證，認證完成后返回認證結果。
接口說明
準備工作
- 請確保在使用該接口前，已充分了解號碼認證服務產品的收費方式和價格。
- 請先完成阿里云賬號注冊、獲取阿里云訪問密鑰、創建認證方案，更多信息，請參見 H5 本機號碼校驗使用流程。
QPS 限制
本接口的單用戶 QPS 限制為 1000 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dypns:VerifyPhoneWithToken | none |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PhoneNumber | string | 是 | 待核驗的手機號。 | 1380000**** |
| SpToken | string | 是 | JSSDK 獲取的號碼認證 Token。 | Dfafdafad542**** |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "請求成功",
"RequestId": "8906582E-6722",
"GateVerify": {
"VerifyResult": "PASS",
"VerifyId": "12134****"
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | RamPermissionDeny | The user is not authorized to operate on the specified resource. | 沒有訪問權限 |
| 400 | UnknowError | The requested service is not available now, please try again later. | 未知異常，請重新再試 |
| 400 | Unsupported.Account | Your account has not activated the product. | 你的賬號沒有開通本產品。 |
| 400 | MobileNumberIllgeal | The specified mobile phone number is invalid. | 手機號碼不合法 |
| 400 | InvalidToken | The token is invalid. | 令牌無效 |
| 400 | VerifySchemeNotExist | The specified verify scheme already exists. | 認證方案不存在 |
| 500 | SystemError | A system error occurred. | 系統異常 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-06-07 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
補充說明
Java SDK
您可以通過添加 Maven 依賴安裝阿里云 Java SDK。SDK 版本會持續更新，具體版本請以 OpenAPI 頁面為準。
JAVA SDK MAVEN 坐標
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>dypnsapi20170525</artifactId>
<version>1.0.6</version>
</dependency>
校驗失敗返回示例
JSON 格式
{
"Code": "OK",
"Message": "請求成功",
"RequestId": "6CAB3AC6-B7C3",
"GateVerify": {
"VerifyResult": "REJECT",
"VerifyId": "12134****"
}
}
請求結果異常返回示例
JSON 格式
{
"Code": "isv.CARRIER_NOT_MATCH",
"Message": "驗證號碼與實際流量號碼運營商不一致",
"RequestId": "6EA6E9F5-37CC"
}