調(diào)用VerifySmsCode接口完成短信驗證碼校驗，校驗完成后返回認證結(jié)果。
接口說明
準備工作
請先完成阿里云賬號注冊、獲取阿里云訪問密鑰、創(chuàng)建認證方案等操作，更多信息，請參見短信認證使用流程。
QPS 限制
本接口的單用戶 QPS 限制為 500 次/秒。超過限制，API 調(diào)用會被限流，這可能會影響您的業(yè)務(wù)，請合理調(diào)用。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dypns:VerifySmsCode | none |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SmsCode | string | 是 | 驗證碼。 | 12**** |
| PhoneNumber | string | 是 | 手機號。獲取短信驗證碼時返回。 | 1321111**** |
| SmsToken | string | 是 | 短信 Token。 當(dāng)您成功調(diào)用短信驗證碼 SDK 中發(fā)送驗證碼接口，終端用戶會收到短信驗證碼，SDK 側(cè)會返回用于短信驗證碼校驗的 SmsToken。其中 Android 客戶端調(diào)用 sendVerifyCode 接口發(fā)送驗證碼，iOS 客戶端調(diào)用 sendVerifyCodeWithTimeout 接口發(fā)送驗證碼。詳情請參見接入概述。 | sddsbvdbvjd**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "請求成功",
"Data": true,
"RequestId": "8906582E-6722"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Unsupported.Account | Your account has not activated the product. | 你的賬號沒有開通本產(chǎn)品。 |
| 400 | SmsCodeVerifyFail | The specified smsCode is invalid. | 短信驗證碼失敗 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-06-07 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
Java SDK
您可以通過添加 Maven 依賴安裝阿里云 Java SDK。SDK 版本會持續(xù)更新，具體版本請以 OpenAPI 頁面為準。
JAVA SDK MAVEN 坐標
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>dypnsapi20170525</artifactId>
<version>1.0.6</version>
</dependency>