SendSmsVerifyCode - 发送短信验证码

发送短信验证码。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

测试方案
CountryCodestring

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

86
PhoneNumberstring

手机号。

130****0000
SignNamestring

签名名称。

阿里云
TemplateCodestring

短信模板 CODE。

您可以登录短信服务控制台,选择国内消息国际/港澳台消息,在模板管理页面查看模板 CODE

说明 必须是已添加、并通过审核的短信模板;且发送国际/港澳台消息时,请使用国际/港澳台短信模板。
azsq_*****
TemplateParamstring

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

示例:如模板内容为:“您的验证码是${authCode},5 分钟内有效,请勿告诉他人。”。此时,该字段传入:{"authCode":"##code##"}

注意 上文中的 authCode 请替换成您实际申请的验证码模板中的参数名称

说明
  • 如果 JSON 中需要带换行符,请参照标准的 JSON 协议处理。
  • 模板变量规范,请参见短信模板规范。>
  • {"code":"##code##"}
    SmsUpExtendCodestring

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

    说明 扩展码是生成签名时系统自动默认生成的,不支持自行传入。无特殊需要此字段的用户请忽略此字段。如需使用,请联系您的商务经理。
    1213123
    OutIdstring

    外部流水号。

    外部流水号(透传)
    CodeLengthlong

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

    4
    ValidTimelong

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

    300
    DuplicatePolicylong

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

    • 1:覆盖处理(默认),即旧验证码会失效掉。

    • 2:保留,即多个验证码都是在有效期内都可以校验通过。

    1
    Intervallong

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

    60
    CodeTypelong

    生成的验证码类型。取值:

    • 1:纯数字(默认)。
    • 2:纯大写字母。
    • 3:纯小写字母。
    • 4:大小字母混合。
    • 5:数字+大写字母混合。
    • 6:数字+小写字母混合。
    • 7:数字+大小写字母混合。
    1
    ReturnVerifyCodeboolean

    是否返回验证码。取值:

    • true:返回。
    • false:不返回。
    true

    返回参数

    名称类型描述示例值
    object
    AccessDeniedDetailstring

    访问被拒绝详细信息。

    Messagestring

    状态码的描述。

    成功
    Modelobject

    请求结果数据。

    VerifyCodestring

    验证码。

    4232
    RequestIdstring

    请求 ID。

    a3671ccf-0102-4c8e-8797-a3678e091d09
    OutIdstring

    外部流水号。

    1231231313
    BizIdstring

    业务 ID。

    112231421412414124123^4
    Codestring

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

    OK
    Successboolean

    请求是否成功。

    • true:请求成功。

    • false:请求失败。

    true

    示例

    正常返回示例

    JSON格式

    {
      "AccessDeniedDetail": "无",
      "Message": "成功 ",
      "Model": {
        "VerifyCode": "4232",
        "RequestId": "a3671ccf-0102-4c8e-8797-a3678e091d09",
        "OutId": "1231231313",
        "BizId": "112231421412414124123^4"
      },
      "Code": "OK",
      "Success": true
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史