Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 2.33 KB

sms.md

File metadata and controls

98 lines (73 loc) · 2.33 KB

短信验证码

该接口支持向特定手机号码发送验证码,并校验验证码是否正确的功能,以此来完成一些需要确认用户身份的操作,比如:

  • 使用手机号码和验证码进行登录
  • 通过手机号码和验证码的方式重置密码
  • 进行重要操作的验证确认等

info SDK 发送短信需要在知晓云控制台开通并开启发送短信权限,操作步骤请参考本页面末尾

发送短信验证码

BaaS.sendSmsCode(phone, callback)

参数说明

参数名 类型 说明
phone string 手机号
callback BaseCallback 回调

示例代码

String phone = "12345678901";
BaaS.sendSmsCode(phone, new BaseCallback<StatusResp>() {
    @Override
    public void onSuccess(StatusResp resp) {
        if (resp.isOk()) {
            // 发送短信验证码成功
        }
    }

    @Override
    public void onFailure(Throwable e) {
        // 发送失败
    }
});

错误状态码

状态码 说明
400 失败(rate limit 或参数错误)
402 当前应用已欠费
500 服务错误

校验短信验证码

BaaS.verifySmsCode(phone, code, callback)

参数说明

参数名 类型 说明
phone string 手机号
code number 验证码
callback BaseCallback 回调

示例代码

String phone = "12345678901";
String code = "123456";
BaaS.verifySmsCode(phone, code, new BaseCallback<StatusResp>() {
    @Override
    public void onSuccess(StatusResp resp) {
        if (resp.isOk()) {
            // 校验通过
        }
    }
    
    @Override
    public void onFailure(Throwable e) {
        // 校验不通过
    }
});

错误状态码

状态码 说明
400 验证码错误 / 参数错误

验证码发送频次

{% block tips1 %}

info 同一企业在 1 分钟内只能发送 30 条短信,如有更高频次需求,请联系客服上调

对同一手机号码在 1 分钟内只能发送 1 条短信

对同一手机号码在 1 天内不能发送超过 10 条短信

{% endblock tips1 %}

{% include "/js-sdk/frag/_enable_sms.md" %}