文档

VerifySmsCode - 完成短信验证码校验

更新时间:

调用VerifySmsCode接口完成短信验证码校验。

接口说明

准备工作

请先完成阿里云账号注册、获取阿里云访问密钥、创建认证方案等操作,更多信息,请参见短信认证使用流程

QPS 限制

本接口的单用户 QPS 限制为 500 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypns:VerifySmsCodeWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SmsCodestring

验证码。

12****
PhoneNumberstring

手机号。获取短信验证码时返回。

1321111****
SmsTokenstring

短信 Token。 当您成功调用短信验证码 SDK 中发送验证码接口,终端用户会收到短信验证码,SDK 侧会返回用于短信验证码校验的 SmsToken。其中 Android 客户端调用 sendVerifyCode 接口发送验证码,iOS 客户端调用 sendVerifyCodeWithTimeout 接口发送验证码。详情请参见接入概述

sddsbvdbvjd****

返回参数

名称类型描述示例值
object
Codestring

状态码。

OK
Messagestring

状态码的描述。

请求成功
Databoolean

验证是否成功。取值:

  • true:验证成功。

  • false:验证失败。

true
RequestIdstring

请求 ID。

8906582E-6722

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "请求成功",
  "Data": true,
  "RequestId": "8906582E-6722"
}

错误码

HTTP status code错误码错误信息描述
400Unsupported.AccountYour account has not activated the product.你的账号没有开通本产品。
400SmsCodeVerifyFailThe specified smsCode is invalid.短信验证码失败

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-07OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400

Java SDK

您可以通过添加 Maven 依赖安装阿里云 Java SDK。SDK 版本会持续更新,具体版本请以 OpenAPI 页面为准。

JAVA SDK MAVEN 坐标

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>dypnsapi20170525</artifactId>
  <version>1.0.6</version>
</dependency>
  • 本页导读 (1)
文档反馈