Android SDK
# Android 集成说明
智齿客服为企业提供了一整套完善的智能客服解决方案。智齿工单 SDK 为其提供所有工单支持，仅需提供使用的账户，就能完成一系列的工单操作。
智齿客服工单 SDK 具有以下特性：
- 提供登录-使用-退出完整流程。
- 分 2 种登录模块，外部登录同步 token 和常规用户名、密码登录。
- 支持工单的查询、操作、新建等基础功能。
相关限制及注意事项：
1、Android SDK 支持安卓系统 4.2 (API 17) 以上版本，支持竖屏和横屏。
2、开发工具 Android Studio 建议升级到 3.0 以上版本。
3、Android SDK 需要申请存储、拍照危险权限，否则部分功能无法使用。
# 文档介绍
# ● 集成流程示意图
# ● 文件说明
SDK 文件包含源码包（sobotordersdk）、Demo 源码 (Sobot_Order_Sdk_Demo_Android)、和 Doc 相关文档。
| 文件 | 描述 |
|---|---|
| SobotOrderApi | 该文件提供接入功能 |
# 集成方式
# ● 依赖集成
api 'com.sobot.zcsdk:ordersdk:+'
1
在build.gradle中如下所示：
dependencies {
api 'com.sobot.zcsdk:ordersdk:+'
api 'com.squareup.okhttp3:okhttp:4.4.0'
api 'androidx.appcompat:appcompat:1.0.0'
api 'com.google.android.material:material:1.4.+'
api 'androidx.recyclerview:recyclerview:1.0.0'
//目前支持常见的几种图片加载库，必须在下面的图片加载库中选择一个添加依赖
//implementation 'com.nostra13.universalimageloader:universal-image-loader:1.9.5'
//implementation 'com.squareup.picasso:picasso:2.71828'
//implementation 'com.facebook.fresco:fresco:2.6.0'
implementation 'com.github.bumptech.glide:glide:4.9.0'
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
【注意】
如果您想使用自己的图片加载方法，可以使用以下方法：SobotBitmapUtil.setImageLoader(new SobotImageLoader() {}); 使用这种方式后,网络图片显示时就不会走 SDK 内部的图片加载方式了。
# ● 导入集成
下载链接：Android_Order_SDK (opens new window)
导入Module
解压下载的智齿Android_Order_SDK_XXX.zip文件，将 sobotordersdk 模块直接引入到您的项目中，然后 Build-->clean projecty一下，之后在build.gradle添加项目依赖
完成上述步骤之后build.gradle中如下所示：
dependencies {
api project(":sobotordersdk")
api 'com.squareup.okhttp3:okhttp:4.4.0'
api 'androidx.appcompat:appcompat:1.0.0'
api 'com.google.android.material:material:1.4.+'
api 'androidx.recyclerview:recyclerview:1.0.0'
//目前支持常见的几种图片加载库，必须在下面的图片加载库中选择一个添加依赖
//implementation 'com.nostra13.universalimageloader:universal-image-loader:1.9.5'
//implementation 'com.squareup.picasso:picasso:2.71828'
//implementation 'com.facebook.fresco:fresco:2.6.0'
implementation 'com.github.bumptech.glide:glide:4.9.0'
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
【注意】
如果您想使用自己的图片加载方法，可以使用以下方法：SobotBitmapUtil.setImageLoader(new SobotImageLoader() {}); 使用这种方式后,网络图片显示时就不会走 SDK 内部的图片加载方式了。
# 功能说明
# ● 域名和初始化设置
域名说明：
默认 SaaS 平台域名为：https://api-c.sobot.com。
如果您是腾讯云服务，请设置为：https://api-c.soboten.com。
如果您是本地化部署，请使用自己的部署的服务域名。
【注意：启动智齿工单 SDK 之前，必须调用初始化接口 initWithHost ，否则将无法启动 SDK。】
/**
* 初始化方法,需要在启动智齿页面前调用
*
* @param host 可以为空，默认阿里云服务；如果需要，请设置自己的域名
*/
SobotOrderApi.initWithHost(Application application, String host);
1
2
3
4
5
6
2
3
4
5
6
# ● 启动智齿页面
# 1. 启动工单首页
方式 1 ：直接使用我们提供的方法，自动完成登录并跳转页面。
三种启动方法：
/**
* 通过邮箱密码方式启动工单系统，进入首页
* @param context
* @param loginUser 客服账号
* @param loginPwd 登录密码
* @param block 回调结果 可为空
*/
SobotOrderApi.startWithAcount(Context context, String loginUser, String loginPwd, SobotResultBlock block)；
/**
* 通过设置公司token方式启动工单系统，进入首页
* @param context
* @param loginUser 客服账号
* @param companyToken 公司token
* @param block 回调结果 可为空
*/
SobotOrderApi.startWithWithCompanyToken(Context context, String loginUser, String companyToken, SobotResultBlock block);
/**
* 通过账号+appKey+appId启动工单系统
*
* @param context
* @param loginUser 客服账号
* @param appKey 登录appKey 找售后同事获取(客户账号开通时会有这个)
* @param appId 登录appId 找售后同事获取(客户账号开通时会有这个)
* @param block
*/
SobotOrderApi.startWithAppkey(Context context, String loginUser, String appKey, String appId, SobotResultBlock block);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
方式 2 ：通过嵌入 fragment 的方式，自己完成登录并跳转页面。需要先完成登录，然后再执行跳转。
第一步、先登录
//登录方式一
/**
* 通过邮箱密码方式登录工单系统
* @param context
* @param loginPwd 客服邮箱
* @param loginPwd 登录密码
* @param isGoToActivity 是否进入工单中心界面 true 进入 false 只登录不进入
* @param block 回调结果 可为空
*/
SobotOrderApi.loginUser(Context context, String loginUser, String loginPwd,false, SobotResultBlock block)；
//登录方式二
/**
* 通过设置token方式登录工单系统
* @param context
* @param loginToken 登录客服token
* @param isGoToActivity 是否进入工单中心界面 true 进入 false 只登录不进入
* @param block 回调结果 可为空
*/
SobotOrderApi.loginUser(Context context, String loginToken, false, SobotResultBlock block)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
第二步、再进入 Fragment
参考代码
SobotWOclassificationFragment classificationFragment;
classificationFragment = (SobotWOclassificationFragment) getSupportFragmentManager()
.findFragmentById(getResId("order_fragment"));
if (classificationFragment == null) {
classificationFragment = SobotWOclassificationFragment.newInstance();
addFragmentToActivity(getSupportFragmentManager(), classificationFragment, getResId("order_fragment"));
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 2. 启动工单详情
【注意：执行操作之前，需要保证已完成登录。】
方法
/**
* 进入工单详情页
*
* @param context
* @param orderId 工单id
* @param block 回调结果 可为空
*/
SobotOrderApi.openOrderDetail(Context context, String orderId, SobotResultBlock block)；
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 3. 启动创建工单页面
【注意：执行操作之前，需要保证已完成登录。】
方法
/**
* 打开创建工单页面
*
* @param context
* @param param 可为空，也可添加参数 userName 用户昵称 userId 用户id
* @param block 回调结果
*/
SobotOrderApi.openCreateWorkOrder(final Context context, Map<String, Object> param, SobotResultBlock block)
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
示例代码
Map<String, Object> param = new HashMap<>();
if (TextUtils.isEmpty(userid.getText().toString())){
if(!TextUtils.isEmpty(nick.getText().toString())){
SobotToastUtil.showCustomToast(getSobotActivity(),"如果输入昵称，但是用户id为空，对应客户是也是空的，无效的");
}else{
if(SobotStringUtils.isEmpty(nick.getText().toString())){
SobotToastUtil.showCustomToast(getContext(),"用户昵称不能为空");
return;
}
param.put("userName", nick.getText().toString());
param.put("userId", userid.getText().toString());
}
}
SobotOrderApi.openCreateWorkOrder(getSobotActivity(), param, null);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# ● 登录
//登录方式一
/**
* 通过邮箱密码方式登录工单系统
* @param context
* @param loginPwd 客服邮箱
* @param loginPwd 登录密码
* @param isGoToActivity 是否进入工单中心界面 true 进入 false 只登录不进入
* @param block 回调结果 可为空
*/
SobotOrderApi.loginUser(Context context, String loginUser, String loginPwd,false, SobotResultBlock block)；
//登录方式二
/**
* 通过设置token方式登录工单系统
* @param context
* @param loginToken 登录客服token
* @param isGoToActivity 是否进入工单中心界面 true 进入 false 只登录不进入
* @param block 回调结果 可为空
*/
SobotOrderApi.loginUser(Context context, String loginToken, false, SobotResultBlock block)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# ● 退出登录
/**
* 退出工单系统
* @param context
* @param loginUser 登录账号
* @param block 回调结果 可为空
*/
SobotOrderApi.out(Context context, String loginUser, SobotResultBlock block)
1
2
3
4
5
6
7
2
3
4
5
6
7
# ● 设置调试模式，开启日志
/**
* 日志显示设置
*
* @param isShowLog true 显示日志信息 默认false不显示
*/
SobotOrderApi.setShowDebug(Boolean isShowLog)
1
2
3
4
5
6
2
3
4
5
6
# ● 自定义 UI 设置
# 1. UI 样式通过同名资源替换
在客户 APP 中 colors.xml 中添加同名颜色可覆盖智齿 SDK 中的颜色样式；也可通过在主项目中同一位置放一个同名的图片资源去替换智齿 SDK 界面中的图片；也可通过在主项目中同一位置放一个同名的文字资源去替换智齿 SDK 界面中的文字。
以下是常用的颜色配置，更多颜色、图片资源可到手动集成模块中下载源码包中去查找。
<!--工单 主题色 默认绿色 -->
<color name="sobot_wo_theme_color">#09AEB0</color>
<!-- 头部背景 -->
<color name="sobot_color_title_bar_bg">@color/sobot_wo_theme_color</color>
<!-- 状态栏的颜色设置 -->
<color name="sobot_status_bar_color">@color/sobot_color_title_bar_bg</color>
<!-- 头部中间昵称颜色 -->
<color name="sobot_color_title_bar_title">@color/sobot_wo_white_color</color>
<!-- 头部两侧菜单字体颜色 -->
<color name="sobot_color_title_bar_menu_text">@color/sobot_wo_white_color</color>
<!-- 一级文字 颜色 -->
<color name="sobot_wo_wenzi_gray1">#3D4966</color>
<!-- 二级文字 颜色 -->
<color name="sobot_wo_wenzi_gray2">#8B98AD</color>
<!-- 三级文字 颜色 -->
<color name="sobot_wo_wenzi_gray3">#BDC3D1</color>
<!-- 四级文字 颜色 -->
<color name="sobot_wo_wenzi_gray4">#CCCCCC</color>
<!--界面 通用背景颜色 -->
<color name="sobot_wo_bg_color">#EFF3FA</color>
<!-- 二级背景色 -->
<color name="sobot_wo_second_bg_color">#FFFFFF</color>s
<!-- 页面背景 三级颜色 -->
<color name="sobot_wo_third_bg_color">#EFF3FA</color>
<!-- 透明的背景色-->
<color name="sobot_wo_app_bg_transparent">@color/sobot_wo_transparent</color>
<!-- 搜索框背景颜色-->
<color name="sobot_wo_search_bg_color">#F6F8FC</color>
<!-- 超链接颜色-->
<color name="sobot_wo_link">@color/sobot_wo_blue_color</color>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# 源码和 Demo
点击下载 Demo 源码 (opens new window)
# 常见问题
1.token 怎么获取？
通过智齿登录接口获取登录 token，如果无法获取请使用用户名、密码完成登录，体验效果完全一样，请放心使用。
2.无法正常登录？
登录之前请确认是否执行初始化操作，初始化操作为本地赋值；不会有异步请求，主要会设置域名及基础配置信息，确认登录信息正确的情况下，主要验证一下是否为域名不匹配。
3.如果把工单主页面嵌入到其它框架使用？
请参考 Demo 项目，其中有使用 Fragment 把工单中心页面放入到里面管理的事例。
4. 如果监听工单提醒？
目前不支持消息提醒，如果需要请反馈给相关对接人员，后续有新增后将及时通知与您。
# 更新说明
《SDK 版本更新说明》 (opens new window)
# 智齿科技 SDK 收集使用个人信息说明
上次更新: 2024/5/14 16:23:54