网易七鱼 Android SDK 是一个 Android 端客服系统访客解决方案,既包含了客服聊天逻辑管理,也提供了聊天界面,开发者可方便的将客服功能集成到自己的 App 中。
网易七鱼Android SDK使用方法
只需简单 3 步,即可将客服功能加入你的 App:
添加 SDK 到项目中。
Android Studio: 在工程 build.gradle 文件中添加依赖即可。
// 最新版本可参考 Download 徽章后对应的数值
compile 'com.qiyukf.unicorn:unicorn:+'
Eclipse: 先下载 SDK,然后解压缩,将得到的 unicorn 文件夹作为库工程模块导入到你的工程中,并添加模块依赖。然后将 assets 文件夹的内容拷贝你的主工程的 assets 目录中,将 AndroidManifest 文件中的内容拷贝到你的主工程的 manifest 文件中,并将 manifest 中的 ${applicationId} 替换为你的包名。
在你的 Application 类的 onCreate 函数中,加入以下初始化代码:
public class YourApplication extends Application {
public void onCreate() {
// ... your codes
// appKey 可以在七鱼管理系统->设置->App 接入 页面找到
Unicorn.init(this, "appKey", options(), new UnicornImageLoader());
// ... your codes
}
// 如果返回值为null,则全部使用默认参数。
private YSFOptions options() {
YSFOptions options = new YSFOptions();
options.statusBarNotificationConfig = new StatusBarNotificationConfig();
return options;}
上面代码中,UnicornImageLoader 可根据你 App 中图片加载模块做自定义实现,以免 SDK 中引入第三方图片管理库后造成与 App 的冲突或者浪费。在 demo 中,实现了依赖于 UniversalImageLoader 的 UILImageLoader。其代码以及依赖于 fresco、Glide、Picasso 的实现代码可参考 图片加载 一节。
在你的 App 的合适页面添加客服入口按钮,并在响应函数中加入如下代码:
String title = "聊天窗口的标题";/**
* 设置访客来源,标识访客是从哪个页面发起咨询的,用于客服了解用户是从什么页面进入。
* 三个参数分别为:来源页面的url,来源页面标题,来源页面额外信息(保留字段,暂时无用)。
* 设置来源后,在客服会话界面的"用户资料"栏的页面项,可以看到这里设置的值。
*/ConsultSource source = new ConsultSource(sourceUrl, sourceTitle, "custom information string");/**
* 请注意: 调用该接口前,应先检查Unicorn.isServiceAvailable(),
* 如果返回为false,该接口不会有任何动作
*
* @param context 上下文
* @param title 聊天窗口的标题
* @param source 咨询的发起来源,包括发起咨询的url,title,描述信息等
*/Unicorn.openServiceActivity(context, title, source);
在打开的页面中,用户就可以咨询客服了。
由于开发环境的不同,很多情况下会出现集成报错或者配置无效的问题。我们官网提供了demo源码,开发者可以参考源码;更多的时候是需要开发者自己本地调试代码,可以通过断点跟踪等基本且有效的方法来定位和排查问题。
- PC官方版
- 安卓官方手机版
- IOS官方手机版