SendSmsVerifyCode_云通信号码认证服务_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.

接口说明

请确保在使用该接口前,已充分了解号码认证服务产品的收费方式和价格

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
SchemeNamestring

方案名称,如果不填则为“默认方案”。最多不超过 20 个字符。

示例值:测试方案参考取值来源:
    CreateSchemeConfig
CountryCodestring

号码国家编码。默认为 86,目前也仅支持国内号码发送。

示例值:86
PhoneNumberstring

手机号。

示例值:130****0000
SignNamestring

签名名称。

示例值:阿里云
TemplateCodestring

短信模板 CODE。展开详情

示例值:azsq_*****
TemplateParamstring

短信模板变量填写的参数值。验证码位置使用"##code##"替代。展开详情

示例值:{"code":"##code##"}
SmsUpExtendCodestring

上行短信扩展码。上行短信指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费,按运营商普通短信资费进行扣费。展开详情

示例值:1213123
OutIdstring

外部流水号。

示例值:外部流水号(透传)
CodeLengthinteger<int64>

验证码长度支持 4~8 位长度,默认是 4 位。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:4
ValidTimeinteger<int64>

验证码有效时长,单位秒,默认为 300 秒。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:300
DuplicatePolicyinteger<int64>

核验规则,当有效时间内对同场景内的同号码重复发送验证码时,旧验证码如何处理。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1枚举值:12
Intervalinteger<int64>

时间间隔,单位:秒。即多久间隔可以发送一次验证码,用于频控,默认 60 秒。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:60
CodeTypeinteger<int64>

生成的验证码类型。取值:展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1枚举值:1234567
ReturnVerifyCodeboolean

是否返回验证码。取值:展开详情

示例值:true

返回参数

字段名称字段详情
AccessDeniedDetailstring

访问被拒绝详细信息。

示例值:
Messagestring

状态码的描述。

示例值:成功
Modelobject

请求结果数据。

Codestring

请求状态码。返回 OK 代表请求成功。其他错误码,请参见返回码列表

示例值:OK
Successboolean

请求是否成功。展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
MOBILE_NUMBER_ILLEGAL
The mobile number is illegal.诊断
400
BUSINESS_LIMIT_CONTROL
The number has exceeded the limit for the day.诊断
400
FREQUENCY_FAIL
Check frequency fail.诊断
400
INVALID_PARAMETERS
parameter is not valid.诊断
400
FUNCTION_NOT_OPENED
You have not opened this function.诊断

变更历史

暂无变更历史

相关示例