ajSms

立即使用

init getSmsCode getVoiceCode checkSmsCode

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

ajSms 本模块封装了极光短信SDK，获取短信，语音验证码，校验短信。

模块使用攻略

在极光官网（https://www.jiguang.cn）申请开发者账号并创建应用，获取 appkey。

需要配置 config.xml 文件，config.xml添加以下代码，需通过云端编译生效，配置方法如下：

配置示例:

  1. <meta-data name="JPUSH_APPKEY" value="appkey"/>  
  2.   <meta-data name="JPUSH_CHANNEL" value="authchannel"/>

init

预取号并设置授权页样式

init()

params

appKey

  • 类型：字符串
  • 描述：（必须）极光创建App时候得到的appkey。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"init",//init初始化sdk；
  5.         code:0 //初始化成功
  6.         result:'success'
  7.     }

err：

  • 类型：JSON对象
  • 内部字段：
  1.     {
  3.         code: 0 //数字类型；
  4.                 //错误码：
  5.                 //-1（未知错误），
  6.                 //0（成功）
  7.     }

示例代码

  2.     var ajSms = api.require('ajSms');
  3.     var param = {
  4.         appKey:'your appKey'
  5.     };
  6.     ajSms.init(param, function(ret, err){
  7.         console.log(JSON.stringify(ret));
  8.         if(ret.code==0){
  9.             //初始化成功后可调用getSmsCode，getVoiceCode等方法
  10.         }
  11.     });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getSmsCode

获取短信验证码

getSmsCode()

params

phone

  • 类型：字符串
  • 描述：（必须）需要获取短信验证码的手机号。

tempId

  • 类型：字符串
  • 描述：（可选）极光后台设置的短信模板id，默认值为1。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"getCodeSuccess",//getCodeSuccess获取短信成功；getCodeFail获取短信失败
  5.         code:0 //获取验证码返回code
  6.         result:'uuid'
  7.     }

err：

  • 类型：JSON对象
  • 内部字段：
  1.     {
  3.         code: 0 //数字类型；
  4.                 //错误码：
  5.                 //-1（未知错误），
  6.                 //0（成功）
  7.     }

示例代码

  2.     var ajSms = api.require('ajSms');
  3.     var param={phone:'1371711245',tempId:'1'}
  4.     ajSms.getSmsCode(param,function(ret,err){
  5.         if(ret.cmd=="getCodeSuccess"){
  6.             //成功获取短信，等待短信发送
  7.         }else{
  8.         }
  9.     })

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getVoiceCode

获取语音验证码

getVoiceCode()

params

phone

  • 类型：字符串
  • 描述：（必须）需要获取短信验证码的手机号。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"getCodeSuccess",//getCodeSuccess获取短信成功；getCodeFail获取短信失败
  5.         code:0 //获取验证码返回code
  6.         result:'uuid'
  7.     }

err：

  • 类型：JSON对象
  • 内部字段：
  1.     {
  3.         code: 0 //数字类型；
  4.                 //错误码：
  5.                 //-1（未知错误），
  6.                 //0（成功）
  7.     }

示例代码

  2.     var ajSms = api.require('ajSms');
  3.     var param={phone:'1371711245'}
  4.     ajSms.getVoiceCode(param,function(ret,err){
  5.         if(ret.cmd=="getCodeSuccess"){
  6.             //成功获取语音短信，等待语音电话
  7.         }else{
  8.         }
  9.     })

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

checkSmsCode

获取语音验证码

checkSmsCode()

params

phone

  • 类型：字符串
  • 描述：（必须）需要获取短信验证码的手机号。

sec

  • 类型：字符串
  • 描述：（必须）收到的验证码。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"checkCodeSuccess",//checkCodeSuccess验证成功；checkCodeFail验证失败
  5.         code:200 //获取验证码返回code
  6.         result:"CheckCode Success"
  7.     }

err：

  • 类型：JSON对象
  • 内部字段：
  1.     {
  3.         code: 0 //数字类型；
  4.                 //错误码：
  5.                 //-1（未知错误），
  6.                 //0（成功）
  7.     }

示例代码

  2.     var ajSms = api.require('ajSms');
  3.     var param={phone:'1371711245',sec:'456852'}
  4.     ajSms.getSmsCode(param,function(ret,err){
  5.         if(ret.cmd=="checkCodeSuccess"){
  6.             //短信验证成功
  7.         }else{
  8.         }
  9.     })

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本