bgnMobSMS

来自于：布谷鸟模块工作室

概述

模块概述

bgnMobSMS封装了mob提供的免费短信+语音验证码的SDK，使用此模块可轻松实现验证手机号码真实性的功能，当前封装的SDK版本为3.2.0，开发者可享受Mob提供的免费技术服务，获取短信验证码，短信或语音消息费用全免，不限条数，不限全球运营商，覆盖全球，无国界的支持手机验证，覆盖全球212个国家，1000多个运营商让您的App在全球覆盖的区域更广，自定义UI，高度自定义的UI设计理念，让用户体验更完美。三秒内急速下发，mob与移动、联通、电信三大运营商紧密合作，一级通道确保验证码下发稳定，用户注册流畅，配置简单，无需与短信平台合作的繁琐手续，SDK快速集成全面的数据统计，全面的数据接口，获得较为完善的用户信息让您看得到用户的行为，深入了解用户。

模块使用攻略

使用之前须从mob（www.mob.com）开放平台申请开发者账号并创建应用，获取 appkey和appsecret，选择SMSSD按官方要求完成相关设置。请见论坛示例：https://community.apicloud.com/bbs/thread-117479-1-1.html

使用此模块之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

名称：bgnMobSMS
参数：appKey、appSecret
配置示例:

  <feature name="bgnMobSMS">
    <param name="appKey" value="d0d84bbf23b4a0e4"/>
    <param name="appSecret" value="a354f72aa1b4c2b8eaad137ac81434cd"/>
  </feature>

注意：IOS系统平台由于Mob官方的技术限制只能在自定义apploader或云平台上编译正式版本的方式下运行，该模块无法在测试版编译方式下运行

模块接口

send

发送短信验证码

send({params}, callback(ret, err))

params

tempCode：

类型：字符串
描述：（可选项）用户自定义的短信模版编号，不传则使用官方提供的默认短信模版。

country：

类型：字符串
描述：（可选项）国家地区编号，默认为86。

phone：

类型：字符串
描述：（必填项）手机号码。

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true      //布尔型；true||false，当前短信是否发送成功
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；
                //错误码：
    msg:    //错误消息
}

示例代码

var sms = api.require('bgnMobSMS');
sms.send({
    phone:"13600000000"
},function(ret, err) {
    if (ret.status) {
        alert("短信发送成功");
    } else {
        alert('短信发送失败,原因：'+err.msg);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

voice

发送语音验证码

voice({params}, callback(ret, err))

params

country：

类型：字符串
描述：（可选项）国家地区编号，默认为86。

phone：

类型：字符串
描述：（必填项）手机号码。

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true      //布尔型；true||false，当前语音是否发送成功
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；
                //错误码：
    msg:    //错误消息
}

示例代码

var sms = api.require('bgnMobSMS');
sms.voice({
    phone:"13600000000"
},function(ret, err) {
    if (ret.status) {
        alert("语音发送成功");
    } else {
        alert('语音发送失败,原因：'+err.msg);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

verify

验证收到的验证码

verify({params}, callback(ret, err))

params

code：

类型：字符串
描述：（必填项）手机接收到的验证码。

country：

类型：字符串
描述：（可选项）国家地区编号，默认为86。

phone：

类型：字符串
描述：（必填项）手机号码。

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true      //布尔型；true||false，验证是否成功
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；
                //错误码：
    msg:    //错误消息
}

示例代码

var sms = api.require('bgnMobSMS');
sms.verify({
    code:"1234",
    phone:"13600000000"
},function(ret, err) {
    if (ret.status) {
        alert("验证成功");
    } else {
        alert("验证失败");
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getVersion

同步方式获取当前SMSSDK版本号

getVersion()

示例代码

var sms = api.require('bgnMobSMS');
var version = sms.getVersion();

补充说明

该方法无参数，不需要回调，是一个同步方式，直接返回的字符串就是当前SDK的版本号

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本