cordova-plugin-jsms

cordova-plugin-jsms

English doc.

极光官方支持的 Cordova 短信验证码插件，支持 Android 和 iOS 平台。

目前不提供免费使用，有意可联系官方商务客服。

Install

• 在线

    cordova plugin add cordova-plugin-jsms --variable APP_KEY=Your_App_KEY
  

  或

  cordova plugin add https://github.com/jpush/cordova-plugin-jsms.git --variable APP_KEY=Your_App_Key
  

• 本地

    cordova plugin add <Plugin path> --variable APP_KEY=Your_App_Key
  

  这里了解如何获得 AppKey。

API

init

初始化 JSMS 功能，主要是检测一些配置信息，如果配置错误将初始化失败，打印错误日志，调用其他接口前必须先初始化。

接口定义

window.jsms.init()

代码示例

window.jsms.init()

setDebugMode

是否开启 JSMS Debug 模式。

接口定义

window.jsms.setDebugMode(successCallback, errorCallback, enabled)

参数说明

• successCallback: 成功回调。
• errorCallback: 失败回调，以参数形式返回错误信息。
• enabled：true / false。

代码示例

window.jsms.setDebugMode(function () {
  // success callback.
}, function (errorMsg) {
  // error callback.
  console.log(errorMsg)
}, true)

getSmsCode

请求短信验证码。

接口定义

window.jsms.getSmsCode(successCallback, errorCallback, phoneNum, tempId)

参数说明

• successCallback: 成功回调，以参数形式返回 uuid（本次获取行为的唯一标识码）。
• errorCallback: 失败回调，以参数形式返回错误码。
• phoneNum: 字符串，要接收短信验证码的手机号。
• tempId: 字符串，短信模板 ID。

代码示例

window.jsms.getSmsCode(function () {
  // success callback.
}, function (errorCode) {
  // error callback.
}, '159xxxxxxxx', '1')

getVoiceCode

获取语音验证码。

接口定义

window.jsms.getVoiceCode(successCallback, errorCallback, phoneNum)

参数说明

• successCallback：成功回调，以参数形式返回 uuid（本次获取行为的唯一标识码）。
• errorCallback：错误回调，以参数形式返回错误信息。
• phoneNum：字符串，手机号码。

代码示例

window.jsms.getVoiceCode(function (uuid) {
    // success callback.
}, function (errorMsg) {
    // error callback.
}, '159xxxxxxxx')

checkSmsCode

验证用户输入的短信验证码。

接口定义

window.jsms.checkSmsCode(successCallback, errorCallback, phoneNum, code)

参数说明

• successCallback：成功回调，以参数形式返回验证码信息。
• errorCallback：错误回调，以参数形式返回错误码。
• phoneNum：字符串，收到验证码的手机号码。
• code：字符串，用户输入的验证码。

代码示例

window.jsms.checkSmsCode(function (code) {
  // success callback.
}, function (errorCode) {
  // error callback.
}, '159xxxxxxxx', '51234')

setIntervalTime

设置前后两次获取验证码的时间间隔，默认为 30 秒。

接口定义

window.jsms.setIntervalTime(successCallback, errorCallback, intervalTime)

参数说明

• successCallback：成功回调。
• errorCallback：错误回调。
• intervalTime：间隔时间，单位是毫秒。

代码示例

window.jsms.setIntervalTime(function () {
    // success callback
}, function () {
    // error callback
}, 60000)   // 设置间隔时间为 60 秒

getIntervalTime

获取当前设置的时间间隔。

接口定义

window.jsms.getIntervalTime(successCallback, errorCallback)

参数说明

• successCallback：成功回调，以参数形式返回时间间隔（单位为毫秒）。
• errorCallback：错误回调，以参数形式返回错误码。

代码示例

window.jsms.getIntervalTime(function (intervalTime) {
    // 默认为 30000 ms
}, function (errorCode) {
    // error callback
})

Todo

• Android 端开发
• iOS 端开发

Support

• QQ 群: 413602425
• 官网文档
• 极光社区

Contribute

Please contribute! Look at the issues.

License

MIT © JiGuang