帮助与文档

> >
다운로드

注意:SMSSDK离线集成方式已经不再提供更新,请移步查看Gradle集成方式文档

一、说明

(1)3.x与之前的旧版本互不兼容,请严格按照本文档进行3.x的首次集成或老版本的升级操作。

(2)3.x之前版本的集成,请参考:Android 短信SDK集成文档

-->集成之前先要申请Mob的appkey与appsecret,点这里提供了申请介绍;申请完添加短信SDK的产品;得到key我们开始集成;

(3)注意:3.0.0版本开始离线集成没有aar包,全部是jar包,aar包不需要导入和引用

二、获取SDK

请至Mob官网下载最新SDK,解压后会看到以下目录结构:

 

QQ截图20170526142919

 

SMSSDK下存放的是短信SDK的全部内容。

三、导入SDK

1.Eclipse

 

Eclipse版本的SMSSDK目录下包含两个工程:

QQ截图20170526145621

SMSSDK:短信SDK核心库(必须)

ShortMessageSDKGUI:我们提供的开源GUI库(非必须)

如果你不想定制自己的UI,可以直接使用我们提供的ShortMessageSDKGUI,否则,不需要导入ShortMessageSDKGUI。接下来,我们以使用ShortMessageSDKGUI为例说明。

1.1、首先将上述两个工程导入Eclipse:

smssdk_导入eclipse

1.2、将上述两个工程挂接到你的工程上:

右键你的工程 → Properties → Android

smssdk_挂接gui

同时将SMSSDK挂接到ShortMessageSDKGUI上:

smssdk_sdk挂到gui上

注意:如果你不需要使用ShortMessageSDKGUI,请直接将SMSSDK挂接到你的项目上。

2.Android Studio

从3.1.0版本开始,不再提供独立的Android Studio版本下载,推荐AS版开发者按照最新的maven集成方式进行在线下载安装。

AS版本的SMSSDK目录下包含以下内容:

旧版3.0.0及其以下带有aar

smssdk_as目录结构

新版3.1.0及其以上全是jar包

MobCommons.jar:Mob 通用公共库(必须)

MobTools.jar:Mob 工具公共库(必须)

3.1.0版本开始没有aar包全部是jar,不需要导aar包。

SMSSDK-<version>.aar:SMSSDK 核心(必须)

SMSSDKGUI-<version>.aar:SMSSDK GUI 开源库(非必须)

HowToUse.txt:使用说明

注意:如果你同时使用ShareSDK,保留一份公共库就行(公共库版本一致或兼容)。

2.1、将以上文件按需放入Android Studio项目所要使用SMSSDK的Module所在的Libs里面:

3.0.0版本有aar的:

smssdk_导入as项目

3.1.0以上没有aar的:

以下是旧版本需要导aar的步骤:

2.2、在Module的build.gradle里面将libs加入仓库(repositories):

repositories{
    flatDir{
        dirs 'libs' //就是你放aar的目录地址
    }
}

2.3、在Module的build.gradle里面添加依赖(dependencies )注意:SMSSDK-<verison>,是随着版本变化的;eg:3.0.0的版本则需要改成:compile name:'SMSSDK-3.0.0',ext:'aar'

dependencies {
    ....//你的其他依赖
    compile name:'SMSSDK-<version>',ext:'aar'
    compile name:'SMSSDKGUI-<version>',ext:'aar'
}

最终,你的build.gradle看起来应该像这样:

smssdk_as build文件

四、添加代码

1.配置AndroidManifest.xml

1.1、添加以下权限:

<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.GET_TASKS" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

1.2、添加以下Activity:

<activity
   android:name="com.mob.tools.MobUIShell"
   android:theme="@android:style/Theme.Translucent.NoTitleBar"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:windowSoftInputMode="stateHidden|adjustResize"/>

1.3、在Application节点下添加以下属性:

android:name="com.mob.MobApplication"

1.4、在Application节点下添加以下meta-data:

<!-- 通过AndroidManifest配置AppKey和AppSecret,如果你选择通过代码配置,则不需要配置以下meta-data -->
<meta-data android:name="Mob-AppKey" android:value="你的AppKey"/>
<meta-data android:name="Mob-AppSecret" android:value="你的AppSecret"/>

最终,你的AndroidManifest.xml看起来应该像这样:

smssd_manifest

 2.使用SDK功能

有两种方法完成验证码短信的发送和验证:调用可视化界面和使用无界面接口

2-1、以可视化界面完成操作

public void sendCode(Context context) {
    RegisterPage page = new RegisterPage();
    //如果使用我们的ui,没有申请模板编号的情况下需传null
    page.setTempCode(null);
    page.setRegisterCallback(new EventHandler() {
        public void afterEvent(int event, int result, Object data) {
            if (result == SMSSDK.RESULT_COMPLETE) {
                // 处理成功的结果
                HashMap<String,Object> phoneMap = (HashMap<String, Object>) data;
                String country = (String) phoneMap.get("country"); // 国家代码,如“86”
                String phone = (String) phoneMap.get("phone"); // 手机号码,如“13800138000”
                // TODO 利用国家代码和手机号码进行后续的操作
            } else{
                // TODO 处理错误的结果
            }
        }
    });
    page.show(context);
}

2-2、以无界面接口完成操作

// 在尝试读取通信录时以弹窗提示用户(可选功能)
SMSSDK.setAskPermisionOnReadContact(true);

EventHandler eventHandler = new EventHandler() {
    public void afterEvent(int event, int result, Object data) {
        // afterEvent会在子线程被调用,因此如果后续有UI相关操作,需要将数据发送到UI线程
        Message msg = new Message();
        msg.arg1 = event;
        msg.arg2 = result;
        msg.obj = data;
        new Handler(Looper.getMainLooper(), new Callback() {
            @Override
            public boolean handleMessage(Message msg) {
                int event = msg.arg1;
                int result = msg.arg2;
                Object data = msg.obj;
                if (event == SMSSDK.EVENT_GET_VERIFICATION_CODE) {
                    if (result == SMSSDK.RESULT_COMPLETE) {
                        // TODO 处理成功得到验证码的结果
                        // 请注意,此时只是完成了发送验证码的请求,验证码短信还需要几秒钟之后才送达
                    } else {
                        // TODO 处理错误的结果
                        ((Throwable) data).printStackTrace();
                    }
                } else if (event == SMSSDK.EVENT_SUBMIT_VERIFICATION_CODE) {
                    if (result == SMSSDK.RESULT_COMPLETE) {
                        // TODO 处理验证码验证通过的结果
                    } else {
                        // TODO 处理错误的结果
                        ((Throwable) data).printStackTrace();
                    }
                }
                // TODO 其他接口的返回结果也类似,根据event判断当前数据属于哪个接口
                return false;
            }
        }).sendMessage(msg);
    }
};
// 注册一个事件回调,用于处理SMSSDK接口请求的结果
SMSSDK.registerEventHandler(eventHandler);

// 请求验证码,其中country表示国家代码,如“86”;phone表示手机号码,如“13800138000”
SMSSDK.getVerificationCode(country, phone);

// 提交验证码,其中的code表示验证码,如“1357”
SMSSDK.submitVerificationCode(country, phone, code);

// 使用完EventHandler需注销,否则可能出现内存泄漏
protected void onDestroy() {
    super.onDestroy();
    SMSSDK.unregisterEventHandler(eventHandler);
}

注:无GUI接口文档点击这里查看详情

其中EventHandler是短信SDK的操作回调,具体说明文档请参阅:短信SDK操作回调章节。

 

3.关于配置AppKey和AppSecret的说明

配置AppKey和AppSecret有两种方式:

(1)通过AndroidManifest配置

(2)通过代码配置

以上方法择一即可,建议使用第一种方式进行配置。

3.1、通过AndroidManifest配置:

(1)在Application节点下添加以下属性:

android:name="com.mob.MobApplication"

注意:如果你有自己的Application类,那么也可以让你的Application类继承MobApplication即可。

(2)在Application节点下添加以下子节点:

<!-- 通过AndroidManifest配置AppKey和AppSecret,如果你选择通过代码配置,则不需要配置以下meta-data -->
<meta-data android:name="Mob-AppKey" android:value="你的AppKey"/>
<meta-data android:name="Mob-AppSecret" android:value="你的AppSecret"/>

3.2、通过代码配置:

如果选择通过代码配置,则不需要继承MobApplication,只要在使用SMSSDK之前,调用以下代码:

// 通过代码注册你的AppKey和AppSecret
MobSDK.init(context, "你的AppKey", "你的AppSecret");

五、代码混淆

如果你开启了proguard混淆,需要在proguard的rules里面添加以下规则:

# SMSSDK
-dontwarn com.mob.**
-keep class com.mob.**{*;}

-dontwarn cn.smssdk.**
-keep class cn.smssdk.**{*;}

 

다운로드 다운로드 다운로드 다운로드

相关文档