0.0.2 • Published 4 years ago

@cloudbase/extension-sms v0.0.2

Weekly downloads
6
License
ISC
Repository
github
Last release
4 years ago

验证码登录(扩展)

安装

方法1: 使用npm:

npm install --save @cloudbase/extension-sms

方法2: 使用CDN

<script src="//unpkg.com/@cloudbase/extension-sms/built/index.umd.js"></script>

Usage

const extSms = require('@cloudbase/extension-sms')

tcb.init({
    env:'xxx',
});

tcb.registerExtension(extSms)

const res = await tcb.invokeExtension('CloudInfinite',opts)

opts 包含以下属性

名称类型是否必须说明
actionString操作类型,支持 Send, Login, Verify
phoneString电话号码
appTcbtcb实例
smsCodeString短信验证码,action 为 LoginVerify 时需要传入
customDomainStringHTTP触发的自定义域名

action目前包含以下类型

  • Send: 发送短信验证码
  • Verify: 校验短信验证码
  • Login: 短信验证码登录

功能说明

发送短信验证码

const app = tcb.init({
    env: '您的环境ID'
});

const opts = {
    action: 'Send',
    app,
    phone: '' // 用户输入的手机号
};

try {
    await tcb.invokeExtension(extSms.name, opts); // 发送短信验证码
    console.log('短信验证码发送成功')
} catch (error) {
    console.log('短信验证码发送失败:', error.message)
}

注意:前往短信服务(SMS),调整短信发送频率配置

校验短信验证码

const app = tcb.init({
    env: '您的环境ID'
});

const opts = {
    action: 'Verify',
    app,
    phone: '', // 用户手机号
    smsCode: '', // 需要校验的验证码
};

try {
    await tcb.invokeExtension(extSms.name, opts); // 校验短信验证码
    console.log('短信验证码校验成功')
} catch (error) {
    console.log('短信验证码校验失败', error.message)
}

短信验证码登录

const app = tcb.init({
    env: '您的环境ID'
});

const opts = {
    action: 'Login',
    app,
    phone: '', // 用户手机号
    smsCode: '', // 接收到的短信验证码
}

try {
    await tcb.invokeExtension(extSms.name, opts); // 正式登录
    console.log('短信验证码登录成功')
} catch (error) {
    console.log('登录失败:', error.message)
}

注意:登录成功后,验证码自动失效。