JGsms
概述
JGsms简介
JGsms模块封装了极光短信验证服务,满足 App 短信验证需求
固件要求
iOS:7.0及以上
Androidconfig.xml中配置
<meta-data name="JPUSH_APPKEY" value="您应用的Appkey"/>
<meta-data name="JPUSH_CHANNEL" value="developer-default"/>
字段描述:
· JPUSH_APPKEY:通过极光推送网站获得
· JPUSH_CHANNEL:目前默认‘developer-default’
模块接口
init
初始化
init({params}, callback(ret))
params
appKey:
- 类型:字符串
- 描述:注册成为JPush开发者,创建应用得到appKey(仅iOS支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //布尔型;true||false
}
示例代码
var demo = api.require('JGsms');
demo.init({
appKey : '10002431',
}, function(ret, err){
alert(JSON.stringify(ret));
});
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本
getCode
获取短信验证码
getCode({params}, callback(ret))
params
PhoneNumber:
- 类型:字符串
- 描述:手机号码
tempId:
- 类型:字符串类型
- 描述:短信模板ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
uuid:'', //字符串类型;发送成功后返回uuid(仅android支持)
value:, //字符串;(仅iOS支持)
error:, //错误信息
errorCode:, //数字类型,错误码(仅android支持)
}
示例代码
var demo = api.require('JGsms');
demo.getCode({
PhoneNumber : '10002431',
}, function(ret){
alert(JSON.stringify(ret));
});
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本
getVoiceCode
获取语音验证码
getVoiceCode({params}, callback(ret))
params
PhoneNumber:
- 类型:字符串
- 描述:手机号码
language:
- 类型:字符串
- 描述:(可选项)播报语音
- 默认:'China'
- 'China' //中文播报
- 'English' //英文播报
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
uuid:'', //字符串类型;发送成功后返回uuid(仅android支持)
value:, //字符串;(仅iOS支持)
error:, //错误信息
errorCode:, //数字类型,错误码(仅android支持)
}
示例代码
var demo = api.require('JGsms');
demo.getVoiceCode({
PhoneNumber : '10002431',
}, function(ret){
alert(JSON.stringify(ret));
});
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本
commitCode
提交验证码
commitCode({params}, callback(ret))
params
PhoneNumber:
- 类型:字符串
- 描述:手机号码
code:
- 类型:字符串
- 描述:验证码
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
value:, //字符串;
error:, //错误信息
code:'', //字符串类型;验证成功验证码信息(仅android支持)
errorCode:, //数字类型;错误码(仅android支持)
}
示例代码
var demo = api.require('JGsms');
demo.commitCode({
PhoneNumber : '10002431',
code:''
}, function(ret){
alert(JSON.stringify(ret));
});
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本