VerifySmsCode_云通信号码认证服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

准备工作

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

QPS 限制

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dypns:VerifySmsCode
None
全部资源
*

请求参数

字段名称字段详情
SmsCodestring

验证码。

示例值:12****
PhoneNumberstring

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

示例值:1321111****
SmsTokenstring

短信 Token。展开详情

示例值:sddsbvdbvjd****

返回参数

字段名称字段详情
Codestring

状态码。展开详情

示例值:OK
Messagestring

状态码的描述。

示例值:请求成功
Databoolean

验证是否成功。取值:展开详情

示例值:true
RequestIdstring

请求 ID。

示例值:8906582E-6722

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Unsupported.Account
Your account has not activated the product.诊断
400
SmsCodeVerifyFail
The specified smsCode is invalid.诊断

变更历史

变更时间变更内容概要操作
2021-12-24
新增错误码400

相关示例

该项目为短信验证码验证 CodeSample,生成的代码可以通过[安装各语言](https://darabonba.api.aliyun.com/module/alibabacloud/CS20151215?spm=api-workbench.CodeSample%20Detail%20Page.0.0.1e651e0fEm8Dxd)的包来进行测试。
2021-11-01