网易七鱼 Android SDK 开发指南

简介

网易七鱼 Android SDK 是一个 Android 端客服系统访客解决方案,既包含了客服聊天逻辑管理,也提供了聊天界面,开发者可方便的将客服功能集成到自己的 APP 中。

快速集成

只需简单 3 步,即可将客服功能加入你的 APP:

  1. 添加 SDK 到项目中。

    • Android Studio: 在工程 build.gradle 文件中添加依赖即可。Download

      // 最新版本可参考 Download 徽章后对应的数值
      compile 'com.qiyukf.unicorn:unicorn:+'
      
    • Eclipse: 先下载 SDK,然后解压缩,将得到的 unicorn 文件夹作为库工程模块导入到你的工程中,并添加模块依赖。然后将 assets 文件夹的内容拷贝你的主工程的 assets 目录中,将 AndroidManifest 文件中的内容拷贝到你的主工程的 manifest 文件中,并将 manifest 中的 ${applicationId} 替换为你的包名。

  2. 在你的 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 的实现代码可参考 图片加载 一节。

  3. 在你的 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源码,开发者可以参考源码;更多的时候是需要开发者自己本地调试代码,可以通过断点跟踪等基本且有效的方法来定位和排查问题。

SDK包具体内容

sdk
├── libs
│   ├── qiyu-sdk-x.y.z.jar
│   └── android-support-v4.jar
├── res
│   └── ***
└── assets
    └── ***

上面文件中,qiyu-sdk-x.y.z.jar 是网易七鱼的 SDK 包,res 和 assets 为 SDK 所依赖的资源文件。

android-support-v4.jar 为工程依赖的外部库,所需最低版本为23.0.0(Android 6.0权限管理适配)。如果你的 APP 也依赖了这个 jar 包,可以将你的工程中的依赖移除,或者将这个库移动到一个更基础的库工程中做依赖。如果是使用 Android Studio 接入,SDK 工程的 build.gradle 文件已经添加了依赖,无需理会这个文件。

混淆配置

如果你的 apk 最终会经过代码混淆,请在 proguard 配置文件中加入以下代码:

-dontwarn com.qiyukf.**
-keep class com.qiyukf.** {*;}

初始化

网易七鱼 SDK 需要接收消息推送,因此有一个后台进程,进程名为 "packageName:core"。我们知道,Application 的 onCreate 在各个进程中都会被调用,包括 UI 主进程和七鱼的推送进程。在实现 Application 的 onCreate 时,如果需要在 onCreate 中调用除 init 接口外的其他接口,应先判断当前所属进程,并只有在当前是 UI 进程时才调用。SDK 的 init 接口无需做额外判断,SDK 会自动识别是否需要初始化。另外,要注意不要在主进程外的其他进程中再调用 Unicorn 提供的接口(init 除外)。判断当前进程是否是在主进程的代码示例如下:

public static boolean inMainProcess(Context context) {
    String mainProcessName = context.getApplicationInfo().processName;
    String processName = getProcessName();
    return TextUtils.equals(mainProcessName, processName);
}

/**
 * 获取当前进程名
 */
private static String getProcessName() {
    BufferedReader reader = null;
    try {
        File file = new File("/proc/" + android.os.Process.myPid() + "/" + "cmdline");
        reader = new BufferedReader(new FileReader(file));
        return reader.readLine().trim();
    } catch (IOException e) {
        return null;
    } finally {
        if (reader != null) {
            try {
                reader.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

初始化包括两个部分,一是本地数据的初始化,二是从七鱼的服务器获取一些配置信息操作。本地数据的初始化是同步的,主要是检查本地是否已经有可以聊天的账号,如果有了,还会做一些缓存数据的初始化操作。如果没有,才会进入到第二部分,去七鱼服务器获取聊天账号。第二部分是异步操作,会在后台自动完成。

消息

新消息提醒

当用户不处在聊天界面时,收到客服的消息,APP 应当在通知栏或者聊天入口给出提醒。

通知栏提醒可以显示最近一条消息的内容,并提供给用户快速进入 APP 的入口。要打开通知栏提醒功能,只需给 YSFOptionsstatusBarNotificationConfig 域赋予非 null 值即可。同时,通过定制该域的各配置项,还能实现提醒开关,免打扰等功能。

要实现点击通知栏提醒直接跳转到会话窗口的功能,需要设置 StatusBarNotificationConfignotificationEntrance,并在对应的 Activity 里添加处理。如果没有设置 notificationEntrance,则是在 AndroidManifest 中设置的入口 Activity 中处理。示例代码如下:

Intent intent = getIntent();
if (intent.hasExtra(NimIntent.EXTRA_NOTIFY_CONTENT)) {
    // 打开客服窗口
    Unicorn.openServiceActivity(context, title, source);
    // 最好将intent清掉,以免从堆栈恢复时又打开客服窗口
    setIntent(new Intent());
}

在聊天入口的地方,APP 可以给出是否有未读消息,以及未读数的提示。APP 可以通过添加以下监听来跟踪未读数变化,更新界面,反馈给用户:

// 添加未读数变化监听,add 为 true 是添加,为 false 是撤销监听。
// 退出界面时,必须撤销,以免造成资源泄露
private UnreadCountChangeListener listener = new UnreadCountChangeListener() { // 声明一个成员变量
    @Override
    public void onUnreadCountChange(int count) {
        // 在此更新界面, count 为当前未读数,
        // 也可以用 Unicorn.getUnreadCount() 获取总的未读数
    }
}

private void addUnreadCountChangeListener(boolean add) {
    Unicorn.addUnreadCountChangeListener(listener, add);
}

默认情况下,只有访客在聊天界面时,才不会有通知栏提醒,其他界面以及 APP 在后台时,都会有消息提醒。如果当 APP 在前台时,不需要通知栏提醒新消息,可以调用Unicorn.toggleNotification(false)关闭消息提醒,然后在 APP 退到后台时,调用Unicorn.toggleNotification(true)重新打开。

用户收到新消息后(通过未读数变化监听接口可获知此事件),如果开发者需要显示新收到的消息,可通过下面接口获取最近一条消息:

/**
 * 获取和客服的最后一条聊天消息内容。
 * 可用于未读消息变化时,展示最后一条未读消息,或者展示客服的最后一条消息。
 * @return 最后一条消息
 */
UnicornMessage message = Unicorn.queryLastMessage();

在 V3.2 版本中增加了该接口的平台商家企业版本,需要传入商家ID,用于平台商家企业调用。

/**
 * 获取和客服的最后一条聊天消息内容。
 * 可用于未读消息变化时,展示最后一条未读消息,或者展示客服的最后一条消息。
 *
 * @param shopId 商家ID
 * @return 最后一条消息
 */
UnicornMessage message = POPManager.queryLastMessage(String shopId);

清除缓存文件

在 V3.4 版本中七鱼 SDK 增加了接收文件功能,为了防止文件过多占用用户手机存储空间,我们增加了清除缓存文件接口(只能清除文件缓存,无法清除聊天记录)

/**
 * 清除文件缓存,将删除SDK接收过的所有文件。<br>
 * 建议在工作线程中执行该操作。
 */
Unicorn.clearCache();

定制界面

客服窗口UI自定义

为了咨询客服窗口的界面风格能与集成七鱼 SDK 的 APP 能够整体统一,七鱼 SDK 提供了简洁的 UI 自定义配置选项。

配置选项接口名为 UICustomization,配置参数放在 YSFOptionsuiCustomization 变量中,开发者可在初始化 SDK 或者在运行时任意时候修改配置,当需要与 SDK 提供的默认界面不一样表现的地方,就修改对应的项,否则不赋值即可,界面会保留默认表现。修改各设置项后,都需要等到下次进入会话界面才会看到相应的更改。

各配置项说明如下:(以下配置项可以参考demo中的uiCustomization类;现有的七鱼中可以自定义配置都已经在uiCustomization类中;若此类中没有提供的方法,就说明七鱼暂时还不支持自定义)

参数名 类型 参数说明 取值说明
msgBackgroundUri String 客服消息窗口背景图片设置 uri(支持格式见表后)
msgBackgroundColor int 客服消息窗口颜色。如果同时设置 uri 和颜色,优先使用 uri 32 位颜色值
msgListViewDividerHeight int 消息列表消息项间距 单位为 pixel
hideLeftAvatar boolean 是否隐藏左侧(客服消息)头像 默认为 false,不隐藏
hideRightAvatar boolean 是否隐藏右侧(访客消息)头像 默认为 false,不隐藏
avatarShape int 头像形状风格 0为圆形头像,1为方形头像
leftAvatar String 左侧 (客服消息)头像图片 uri uri(支持格式见表后)
rightAvatar String 右侧 (访客消息)头像图片 uri uri(支持格式见表后)
tipsTextColor int 提示类消息的字体颜色(包括分配客服消息,消息时间标签等) 32 位颜色值
tipsTextSize float 提示类消息的字体大小(包括分配客服消息,消息时间标签等) 单位为 sp
msgItemBackgroundLeft int 左边消息项背景, 最好是 selector,同时影响文本和语音消息。 drawable resId
msgItemBackgroundRight int 右边消息项背景, 最好是 selector,同时影响文本和语音消息。 drawable resId
audioMsgAnimationLeft int 左侧语音消息播放时候的动画 animation-list,没有播放时显示最后一帧 drawable resId
audioMsgAnimationRight int 右侧语音消息播放时候的动画 animation-list,没有播放时显示最后一帧 drawable resId
textMsgColorLeft int 左侧文本消息颜色 32 位颜色值
hyperLinkColorLeft int 左侧文本消息中超链接的颜色 32 位颜色值
textMsgColorRight int 右侧文本消息颜色 32 位颜色值
hyperLinkColorRight int 右侧文本消息中超链接的颜色 32 位颜色值
textMsgSize float 文本消息字体大小 单位为sp
inputTextColor int 底部消息输入框的字体颜色 32 位颜色值
inputTextSize float 底部消息输入框的字体大小 单位为sp
topTipBarBackgroundColor int 顶部提示栏(没有客服,排队状态等)背景色 32 位颜色值
topTipBarTextColor int 顶部提示栏文字颜色 32 位颜色值
topTipBarTextSize float 顶部提示栏文字大小 单位为 sp
titleBackgroundResId int 标题栏背景图 drawable resId
titleBackgroundColor int 标题栏背景颜色,如果同时设置 drawable 和颜色,优先使用 drawable 32 位颜色值
titleBarStyle int 标题栏风格,影响标题和标题栏上按钮的颜色 目前支持: 0浅色系,1深色系
titleCenter boolean 标题居中 如果为 true ,居中,否则(默认)居左
buttonBackgroundColorList int 发送,选择,预览等按钮的颜色 ColorStateList,可参考 SDK 的 ysf_button_color_state_list
buttonTextColor int 发送,选择,预览等按钮的文字颜色 32 位颜色值
hideAudio boolean 是否隐藏语音输入栏 默认为 false,不隐藏
hideAudioWithRobot boolean 在机器人聊天界面是否隐藏输入栏 默认为false,不隐藏。给机器人发送语音后,会先转成文字消息,再发送给机器人
hideEmoji boolean 是否隐藏表情输入栏 默认为 false,不隐藏
screenOrientation int 屏幕旋转角度 0 为仅竖屏显示,1为仅横屏显示,2为根据重力感应切换
hideKeyboardOnEnterConsult boolean 在进入聊天界面时是否隐藏输入键盘 默认为 false,进入时就自动弹出键盘

图片 uri 支持的格式由开发者根据自己使用的图片加载框架定义。但必须要支持 file://, http:// 和 https:// 这3种。 如果开发者遇到下面两种情况,请首先检查图片加载器是否有正常初始化或是否支持当前图片路径: 1、设置的leftAvatar或者rightAvatar无效,展示的是app的icon; 2、聊天框中不展示接收到的信息(没有展示聊天气泡);

其他界面

SDK 的所有资源文件名均以 nim 或者 ysf 作为前缀,colors 和 strings 中的常量也以 nim 或 ysf 为前缀,以避免污染开发者的资源名字空间。

聊天界面的根 layout 文件为 ysf_message_fragment.xml, 通过修改该文件,以及其引用的各子 layout 文件,可以修改聊天界面的框架布局。通过修改其中引用的素材资源,可以修改界面的上各图标,字体,背景等。

SDK 自带的会话界面为 ServiceMessageActivity, 其 theme 为 ysf_window_theme, 如果需要修改标题栏样式,可以修改该 style。 该 style 位于 ysf_styles.xml 中。

如果修改 SDK 中的资源文件,以后升级 SDK 时要注意重新替换,以免又回到默认界面上。

SDK 还提供了以 fragment 嵌入的方式集成会话界面,开发者可以更灵活的使用 SDK。示例代码如下:

String title = "聊天窗口的标题";
// 访客来源信息
ConsultSource source = new ConsultSource(sourceUrl, sourceTitle, "custom information string");
/**
 * 构造一个 ViewGroup,用于放置sdk的评价和人工客服按钮。
 * 该控件推荐放在标题栏右边。可以用以下两种方式:
 * 1. 将 container 放到 layout 文件中
 * LinearLayout sdkIconContainer = (LinearLayout)findViewById(R.id.xxx);
 * 2. 动态构建,动态添加
 * LinearLayout sdkIconContainer = new LinearLayout(this);
 * sdkIconContainer.setOrientation(LinearLayout.HORIZONTAL);
 * 构造好后,还需要将 ViewGroup 添加到你的 Activity 中
 */
ServiceMessageFragment fragment = Unicorn.newServiceFragment(title, source, sdkIconContainer);
FragmentManager fm = getSupportFragmentManager();
FragmentTransaction transaction = fm.beginTransaction();
// 将 fragment 放到对应的 containerId 中。containerId 为 ViewGroup 的 resId
transaction.replace(containerId, fragment);
try {
    transaction.commitAllowingStateLoss();
} catch (Exception e) {
}

客服窗口输入窗口相关内容自定义

为了使我们的 SDK 界面定制性更强,在 V4.3.0 版本我们提供了输入框的相关内容自定义。 配置选项的接口名为 InputPanelOptions ,配置参数放在 YSFOptionsInputPanelOptions 变量中,开发者可在初始化 SDK 或者在运行时任意时候修改配置,当需要与 SDK 提供的默认界面不一样表现的地方,就修改对应的项,否则不赋值即可,界面会保留默认表现。修改各设置项后,都需要等到下次进入会话界面才会看到相应的更改。

参数名 类型 参数说明 取值说明
voiceIconResId int 音频输入图标id drawable resId
emojiIconResId int 表情输入图标id drawable resId
photoIconResId int 拍照和相册图标id drawable resId 当开启输入更多的时候该图标不会生效
moreIconResId int 输入更多(类似于微信 + 号的功能)的图标id drawable resId
showActionPanel boolean 是否开启输入更多功能 true 拍照和相册功能被替换为输入更多,false 不开启,输入更多图标也不会生效
actionPanelOptions ActionPanelOptions 输入更多弹框里面选项的相关配置 参考表格后面说明

在 ActionPanelOptions 可以通过设置 backgroundColor 去自定义输入更多弹出框的背景颜色,也可以通过配置 ActionPanelOptions 中的 ActionListProvider 接口去返回弹出框出现的选项列表(如果开启了输入更多功能,但是没配置这个列表,那么列表中会自动加入拍照和相册功能)上面整体的配置示例代码如下:

YSFOptions options = new YSFOptions();
options.inputPanelOptions = new InputPanelOptions();
options.inputPanelOptions.showActionPanel = true;
options.inputPanelOptions.moreIconResId = R.drawable.ysf_ic_actionpanel_strat;
options.inputPanelOptions.voiceIconResId = R.drawable.ic_launcher;
options.inputPanelOptions.emojiIconResId = R.drawable.ic_launcher;
options.inputPanelOptions.actionPanelOptions = new ActionPanelOptions();
options.inputPanelOptions.actionPanelOptions.actionListProvider = new ActionListProvider() {
    //实现 getActionList 方法,返回输入更多弹框的列表,SDK 中默认提供了 AlbumAction(相册)、CameraAction(相机)等 Action
    @Override
    public List<BaseAction> getActionList() {
        List<BaseAction> list = new ArrayList<>();
        list.add(new ImageAction(R.drawable.ic_home,R.string.ysf_action_camera_and_album));
        list.add(new SendTextAction(R.drawable.ic_kaola,R.string.ysf_action_text));
        list.add(new SendProductAction(R.drawable.ic_launcher,R.string.ysf_action_product));
        list.add(new DemoAction(R.drawable.ic_kaola,R.string.ysf_action_test));
        list.add(new CameraAction(R.drawable.ic_kaola,R.string.ysf_action_camera));
        list.add(new AlbumAction(R.drawable.ic_kaola,R.string.ysf_action_Album));
        return list;
    }
};
options.inputPanelOptions.actionPanelOptions.backgroundColor = 0xFF0000FF; //自定义输入更多弹框背景颜色

从上面的代码中可以看出列表中的每一个 item 为一个 Action ,SDK 提供了 BaseAction ,您可以继承它去实现你自己的 Action,然后加入列表。BaseAction 中提供了很多可自定义的内容,例如图标和文字,点击事件,还定义了创建文本消息和图片消息的方法。你可以通过如下代码去发送一条文本消息:

public class SendTextAction extends BaseAction {
    /**
     * 构造函数
     *
     * @param iconResId 图标 res id
     * @param titleId   图标标题的string res id
     */
    public SendTextAction(int iconResId, int titleId) {
        super(iconResId, titleId);
    }

    @Override
    public void onClick() {
        //buildTestMessage 为创建消息的方法,sendMessage 为 SDK 提供的发送消息的方法
        MessageService.sendMessage(buildTextMessage("hello world"));
    }
}

在 onClick 里面不仅仅可以发送文本消息,BaseAction 中还提供了 buildImageMessage 方法创建图片消息并发送,也可以在该方法跳转 APP 的界面,然后重写 BaseAction 中的 onActivityResult 方法去处理你选择的数据。

客服窗口外层右上角按钮自定义

在 V4.3.0 版本中我们加入了客服窗口右上角 title 的按钮自定义的功能,您可以通过配置在 title 的右侧加入一个按钮,按钮的图片字体颜色,点击事件都可以配置,该功能示例代码如下:

YSFOptions options = new YSFOptions();
options.titleBarConfig = new TitleBarConfig();
options.titleBarConfig.titleBarRightText = "进店";  //配置按钮下面的文字
options.titleBarConfig.titleBarRightImg = R.drawable.ic_menu_phone;  //配置按钮的图片 drawable resId
//设置按钮的点击事件
options.titleBarConfig.onTitleBarRightBtnClickListener = new OnTitleBarRightBtnClickListener() {
    @Override
    public void onClick(Activity activity) {
        ToastUtils.show("恭喜你,点击事件触发了");
    }
};

人工客服快捷入口

在 3.13 版本中,七鱼 SDK 新增人工客服模式下的快捷入口,可用于用户选择并发送订单给客服。

快捷入口位于输入框上方,仅在人工客服和留言状态下显示。如果需要展示快捷入口,需要按照以下方法配置:

  1. ConsultSource 中的 quickEntryList 赋值,添加快捷入口
ConsultSource source = new ConsultSource(uri, title, custom);
...
source.quickEntryList = new ArrayList<>();
source.quickEntryList.add(new QuickEntry(0, "查订单", iconUrl));
source.quickEntryList.add(new QuickEntry(1, "查物流", iconUrl));
  1. YSFOptions 中的 quickEntryListener 赋值,用于监听快捷入口点击
YSFOptions options = new YSFOptions();
...
options.quickEntryListener = new QuickEntryListener() {
    @Override
    public void onClick(Context context, String shopId, QuickEntry quickEntry) {
        ToastUtils.show("点击快捷入口" + quickEntry.getId());
        if (quickEntry.getId() == 0) {
            // 这里可根据 QuickEntry 做出相应的相应,如打开订单选择窗口
        }
    }
};

如果需要在用户选择订单后将商品信息发送给客服,需要调用以下接口

// 普通企业
MessageService.sendProductMessage(productDetail);

// 平台企业
POPManager.sendProductMessage(shopId, ProductDetail);

当使用这种方法发送商品的时候,手动发送相关配置参数不再生效,openTemplate 参数不会生效。在 V4.3.0 版本我们对发送商品接口进行了改造,老版本中 ProductDetail 中的show 参数是不生效的,改造之后 show 参数开始生效

可配置的访客分流表现

在之前版本中,当企业在管理后台配置了多入口访客分流时,访客请求人工客服,返回多入口选择时,会在消息流中生成一条消息,此种方式对于用户的提示可能较弱,因此,在4.0版本中,在 YSFOptions 中增加了一个配置项 categoryDialogStyle,用于配置多入口分流的样式,其定义如下:

/**
 * 选择咨询分类时自动弹出对话框的样式<br>
 * 0 表示不弹出<br>
 * 1 表示从中间弹出<br>
 * 2 表示从底部弹出
 */
public int categoryDialogStyle;

关联商户用户信息

关联用户和资料

七鱼 SDK 允许 APP 的用户以匿名方式向客户咨询,但如果 APP 希望客服知道咨询的用户的身份信息,可以通过 SDK 提供的 setUserInfo 接口告诉给客服。 该接口包含两个功能:

  1. 关联用户账户。调用过该接口后,客服即可知道当前用户是谁,并可以调看该用户之前发生过的访问记录。通过该接口,SDK还会把 APP 端相同用户 ID 的咨询记录整合在一起。如果调用 setUserInfo 接口前是匿名状态,那么匿名状态下的聊天记录也会被整合到新设置的这个用户下面。
  2. 提供用户的详细资料。通过设置参数 YSFUserInfo 的 data 字段, APP 能把用户的详细信息告诉给客服,这些信息会显示在客服会话窗口的用户信息栏中。该字段具有很强的可扩展性,具体请见本节后面的描述。

为了区分不同的 APP 用户,当 APP 端用户注销后,需要先调用 Unicorn.logout(),告诉 SDK,SDK 此时会关闭前一个用户的聊天记录,并重新分配一个新的聊天账号,以和之前的用户区分。

注意,该接口不允许直接从一个账号切换到另外一个账号。

为了方便开发者调用,这个接口没有设置回调接口,开发者也无需在用户资料发生变更后就调用该接口。开发者可在每次打开客服窗口时调用该函数,设置访客资料。SDK会缓存上次设置的资料,只有当资料发生改动时SDK才会上传,以节省流量。

访客信息为一个 json 数组,该数组中的 item 目前可包含以下字段:

现在,以下4个key由七鱼使用,他们的排序和标签名是固定的,不能指定index和label。

设置访客信息的示例如下:

YSFUserInfo userInfo = new YSFUserInfo();
// APP 的用户 ID
userInfo.userId = "uid";
// 当且仅当开发者在管理后台开启了 authToken 校验功能时,该字段才有效
userInfo.authToken = "auth-token-from-user-server";
// CRM 扩展字段
userInfo.data="[
    {"key":"real_name", "value":"土豪"},
    {"key":"mobile_phone", "hidden":true},
    {"key":"email", "value":"13800000000@163.com"},
    {"key":"avatar", "value": "https://qiyukf.com/def_avatar.png"},
    {"index":0, "key":"account", "label":"账号", "value":"zhangsan" , "href":"http://example.domain/user/zhangsan"},
    {"index":1, "key":"sex", "label":"性别", "value":"先生"},
    {"index":5, "key":"reg_date", "label":"注册日期", "value":"2015-11-16"},
    {"index":6, "key":"last_login", "label":"上次登录时间", "value":"2015-12-22 15:38:54"}
]";
Unicorn.setUserInfo(userInfo);

注销

如前所述,当关联的用户从 APP 注销后,也应当调用 SDK 的注销接口 Unicorn.logout()。这样,注销之后,客服再给前面用户发送消息,将进入留言,等到该用户下次再在同一台设备上登录后,能够再看到。如果 APP 的用户注销后,不调用七鱼的 logout 接口,七鱼不知道用户已经变更,那么客服如果给前面一个用户发起会话,发送消息,当前设备将仍旧能够收到消息,造成混乱。

Unicorn.logout() 接口等效于 Unicorn.setUserInfo(null)

注意:目前不支持跨设备的消息漫游,在其他设备上通过 setUserInfo(YSFUserInfo) 设置相同的用户, 这个设备上不能收到留言。

APP 访问轨迹与行为轨迹

在 4.0 版本中,SDK 支持记录用户在 APP 内的访问轨迹,并在联系客服时上报给客服。

使用 APP 访问轨迹功能,需要企业开通 访问轨迹 功能。

配置 APP 访问轨迹有两种方案,请选择适合自己的方案:

  1. 自动配置

在初始化时将 YSFOptionsautoTrackUser 赋值为 true(默认即为 true),为 AndroidManifest.xml 中所有 activity 标签的 label 赋值,该字段将作为访问轨迹页面标题。

该配置仅能记录 Activity 的访问轨迹,如果需要记录 Fragment 的访问轨迹,请参考方案 2

  1. 手动配置

在初始化时将 YSFOptionsautoTrackUser 赋值为 false,在需要记录的 Activity(或 Fragment)的 onResumeonPause 方法中添加如下代码

@Override
public void onResume() {
    super.onResume();

    // ...
    QiyuTracker.onResume(this, "页面标题");
    // ...
}

@Override
public void onPause() {
    super.onPause();

    // ...
    QiyuTracker.onPause(this, "页面标题");
    // ...
}

注:以上两种方案请选择一种,不要混合使用,否则可能出现轨迹错乱的问题。

在 V4.4.0 版本中,SDK 支持用户在 APP 内的行为轨迹,并在联系客服时上报给客服。

使用 APP 访问轨迹功能,需要企业开通 行为轨迹 功能。行为轨迹是建立在访问轨迹之上的,如果需要使用行为轨迹,请先开启访问轨迹

行为轨迹类似于用户的点击事件,APP 可以在用户任何操作的时候调用 SDK 的 API,这样就可以记录用户的行为,下面代码展示了如何上报用户的访问轨迹:

/**
 * 记录用户行为的方法
 * @param title  用户操作的类目是什么,可以是点击了收藏,可以是点击了查看,这个完全由客户端自己定义
 * @param jsonObject 用户操作的内容是什么,如果是商品,那么里面就是商品信息,如果是课程里面就是课程信息
 *                   如果不想传也是可以的
 */
QiyuTracker.onBehavior(this,"操作名称",jsonObject);

该方法可以在任何地方进行调用,当调用的时候 SDK 会根据情况选择上传到服务器

自定义客服分配

在打开客服咨询窗口或者构造 ServiceMessageFragment 时,接口中有一个参数是 ConsultSource,通过该参数,我们可以对分配客服的流程做一些自定义操作。

指定客服(组)

  1. 在 2.0 之前的版本中,请求客服时会根据企业在管理后台上对 APP 客服分配的设置,来决定首先接入机器人还是人工客服,如果管理后台开启了机器人,则首先会接入机器人。如果管理后台也允许接入人工客服,那么用户可以通过回复 'RG' 或者 '人工客服' 一类的关键字切换到人工客服,界面上也能展现一个人工客服的入口,用户点击此入口,也能接入人工客服。

  2. 在 2.0 版本中,七鱼加入了访客分配的逻辑。如果APP端开启了访客分配,那么当切换到人工客服时,会首先给出一个客服分组选择的入口,用户可以自主选择某个客服或者客服分组咨询。

  3. 在 2.2 版本中,SDK 在 ConsultSource 增加了指定客服或者客服组的参数,开发者可以在访客进入咨询界面前就指定好要为其服务的客服,例如从订单页面打开咨询界面时为其指定售后客服,在商品页面打开时,为其指定售前客服。在 ConsultSource 中,staffId 为客服 ID,groupId 为客服组 ID,其值可以在管理后台设置页面的「访客分配」页面中找到。如果这两个参数都没有设置,则按照2.0版本的逻辑分配客服,如果指定了其中一个,则只会分配指定的客服或者在指定的客服分组中分配,如果指定的客服不在线,或者指定的客服分组中没有客服在线,则会提示用户客服不在线。如果同时指定 staffIdgroupId,以 staffId 为准,忽略 groupId

  4. 机器人优先 在 3.1 版本中,SDK 又在 ConsultSource 中增加了 robotFirst 参数, 如果指定了 groupId 或者 staffId 时,该参数有效。如果 robotFirst 为 true,则会先由机器人接待,如果之后如果用户转人工服务,再分配给上面指定的groupId 或者 staffId。

  5. 配置常见问题模板 在 3.1 版本中,为了提高机器人的效率,在 ConsultSource 中还增加了 faqGroupId 参数。 faq 由客服人员在管理后台配置。如果指定了此参数,且请求客服为机器人客服,则会下发该 ID 对应的热门问题列表。

指定机器人

在 3.12 版本中,为了满足企业不同业务,在 ConsultSource 中增加了 robotId 参数,用于指定特定的机器人客服。机器人 ID 可以在管理后台 - 设置 - App接入 中查看。

汇报商品信息

在打开咨询窗口时,还可以带上用户当前正在浏览的商品或订单信息。在 ConsultSource 中,设置字段为 productDetail,其类型为 ProductDetail。各字段通过 ProductDetail.Builder 设置,可以设置的信息有:

字段 意义 备注
title 商品标题 长度限制为 100 字符,超过自动截断。
desc 商品详细描述信息。 长度限制为 300 字符,超过自动截断。
note 商品备注信息(价格,套餐等) 长度限制为 100 字符,超过自动截断。
picture 缩略图图片的 url。 该 url 需要没有跨域访问限制,否则在客服端会无法显示。
长度限制为 1000 字符, 超长不会自动截断,但会发送失败。
url 商品信息详情页 url。 长度限制为 1000 字符,超长不会自动截断,但会发送失败。
show 是否在访客端显示商品消息。 默认为0,即客服能看到此消息,但访客看不到,也不知道该消息已发送给客服。
alwaysSend 在会话开始后,仍可以发送该商品字段 默认为 false,不发送。
tags 展示在客服端的一些可操作入口 默认为空,每个 tag 在客服端将展示为一个按钮.
openTemplate 是否开启商品的最新展示样式 默认不开启,当开启的时候,发送的商品只展示配置的图片
sendByUser 是否需要用户手动发送 默认为false,当为 true 的时候,商品的下面讲出现一个按钮,用户可以点击该按钮发送商品
actionText 手动发送按钮的文本 默认文本为发送链接
actionTextColor 手动发送按钮文本的颜色 十六进制颜色例如:0xFFDB7093
isOpenReselect 是否显示重新选择按钮 默认为 false,不显示。
reselectText 重新选择按钮的文案 如果不设置,默认为"重新选择"
handlerTag 当点击重新选择按钮的时候,会将此字段回传 默认为 null
productReslectOnclickListener 商品重新选择的点击事件的回调,类似于我们普通的 OnClickListener 无默认实现

在3.1.0版本之前,商品信息只有在连上客服时发送一次,此后如果没有重新连接客服,无论商品信息是否改变,都不会再继续发送了。从3.1.0版本开始,开发者可以通过 alwaysSend 字段控制是否需要在中途发送新的商品信息。注意,如果上一次发送的商品链接和这一次的相同,后面一次的不会再发送给客服。在 V4.4.0 版本中,可以通过设置 ConsultSource 中的 isSendProductonRobot 去控制是否在进入机器人会话的时候发送商品

设置用户VIP等级

在 3.5 版本中,七鱼客服增加了设置用户 VIP 等级的功能,便于区分用户等级,允许 VIP 用户优先进线或为 VIP 用户指定专线客服,提升用户体验。

使用该功能需要在七鱼管理系统 -> 设置 -> VIP 客户设置页面打开 VIP 开关,否则设置将不会生效。

设置用户 VIP 等级需要为 ConsultSource 中的 vipLevel 字段赋值:

控制会话过程

从 3.5.5 版本开始,SDK 增加了开发者对于会话过程控制的力度,允许用户主动结束会话和主动退出排队。

控制会话过程的设置类是 SessionLifeCycleOptions,可以在开始会话前设置给 ConsultSourcesessionLifeCycleOptions 字段。示例代码如下:

ConsultSource source = new ConsultSource(null, "自定义入口", null);
SessionLifeCycleOptions lifeCycleOptions = new SessionLifeCycleOptions();
lifeCycleOptions.setCanCloseSession(boolean)
        .setCanQuitQueue(boolean)
        .setQuitQueuePrompt(String);
source.sessionLifeCycleOptions = lifeCycleOptions;
Unicorn.openServiceActivity(context, title, source);

如果使用 fragment 集成,则还需要对SessionLifeCycleOptionssessionLifeCycleListener字段赋值,配置会话界面退出监听器,说明如下:

/**
 * 会话界面退出监听器<br>
 * 仅在使用 fragment 集成时需要处理,如果使用 Activity 集成则无需处理。<br>
 * 如果需要在用户退出排队时给予挽留提示,则需要在宿主 activity 触发 onBackPressed 时调用 ServiceMessageFragment 的 onBackPressed 方法,
 * 只有当 fragmentonBackPressed 方法返回为 false 时,才能调用 Activity 的 onBackPressed。示例代码<br>
 * <pre>
 * public class ServiceMessageActivity extends Activity {
 *     public void onBackPressed() {
 *         if (!messageFragment.onBackPressed()) {
 *             super.onBackPressed();
 *         }
 *     }
 * }
 * </pre>
 * 如果给予提示后用户仍然选择退出排队,则会回调{@link #onLeaveSession()},开发者需要在回调中关闭 fragment 。
 */
public interface SessionLifeCycleListener {

    /**
     * 用户主动离开客服咨询界面,此时需要关闭 fragment<br>
     */
    void onLeaveSession();
}

图片加载

图片加载基本上每个 APP 都会用到,各个 APP 也都会有自己的实现或者依赖的第三方库。为了避免 SDK 引入第三方图片库后,与 APP 自身依赖的图片库冲突,或者与 APP 用了不同的库造成浪费,从 2.0.0 版本开始,七鱼 SDK 需要由 APP 实现一个图片加载接口,并传给 YSFOptions。 下面是两个常用的第三方图片加载库的接口实现示例,开发者可以直接使用。

图片加载参数中的 uri 格式,只要是 APP 选用的图片框架支持即可。但请注意,必须支持本地文件 uri (file://)和 网络文件 uri (http:// 或者 https://) 这两种格式。

UniversalImageLoader实现

该实现依赖 universal-image-loader 库,需要在工程的 build.gradle 文件中添加依赖:

compile 'com.nostra13.universalimageloader:universal-image-loader:1.9.5'

如果使用的 IDE 是 Eclipse,则需要在 libs 中添加 universal-image-loader 的 jar 包。

public class UILImageLoader implements UnicornImageLoader {
    private static final String TAG = "UILImageLoader";

    @Override
    public Bitmap loadImageSync(String uri, int width, int height) {
        DisplayImageOptions options = new DisplayImageOptions.Builder()
                .cacheInMemory(true)
                .cacheOnDisk(false)
                .bitmapConfig(Bitmap.Config.RGB_565)
                .build();

        // check cache
        boolean cached = true;
        ImageDownloader.Scheme scheme = ImageDownloader.Scheme.ofUri(uri);
        if (scheme == ImageDownloader.Scheme.HTTP
                || scheme == ImageDownloader.Scheme.HTTPS
                || scheme == ImageDownloader.Scheme.UNKNOWN) {
            // non local resource
            cached = MemoryCacheUtils.findCachedBitmapsForImageUri(uri, ImageLoader.getInstance().getMemoryCache()).size() > 0
                    || DiskCacheUtils.findInCache(uri, ImageLoader.getInstance().getDiskCache()) != null;
        }

        if (cached) {
            ImageSize imageSize = (width > 0 && height > 0) ? new ImageSize(width, height) : null;
            Bitmap bitmap = ImageLoader.getInstance().loadImageSync(uri, imageSize, options);
            if (bitmap == null) {
                Log.e(TAG, "load cached image failed, uri =" + uri);
            }
            return bitmap;
        }

        return null;
    }

    @Override
    public void loadImage(String uri, int width, int height, final ImageLoaderListener listener) {
        DisplayImageOptions options = new DisplayImageOptions.Builder()
                .cacheInMemory(true)
                .cacheOnDisk(false)
                .bitmapConfig(Bitmap.Config.RGB_565)
                .build();
        ImageSize imageSize = (width > 0 && height > 0) ? new ImageSize(width, height) : null;

        ImageLoader.getInstance().loadImage(uri, imageSize, options, new SimpleImageLoadingListener() {
            @Override
            public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
                super.onLoadingComplete(imageUri, view, loadedImage);
                if (listener != null) {
                    listener.onLoadComplete(loadedImage);
                }
            }

            @Override
            public void onLoadingFailed(String imageUri, View view, FailReason failReason) {
                super.onLoadingFailed(imageUri, view, failReason);
                if (listener != null) {
                    listener.onLoadFailed(failReason.getCause());
                }
            }
        });
    }
}

fresco实现

fresco 库本身提供了一整套图片缓存和加载的功能,由于 SDK 中部分 ImageView 需要做自定义的绘制,因此只会用到其下载,解码和缓存的逻辑。

该实现依赖 fresco 库,需要在工程的 build.gradle 文件中添加依赖:

compile 'com.facebook.fresco:fresco:0.9.0'

如果使用的 IDE 是 Eclipse,则需要在 libs 中添加 fresco 的 jar 包。

public class FrescoImageLoader implements UnicornImageLoader {
    private Context context;

    public FrescoImageLoader(Context context) {
        this.context = context.getApplicationContext();
    }

    @Override
    public Bitmap loadImageSync(String uri, int width, int height) {
        Bitmap resultBitmap = null;
        ImagePipeline imagePipeline = Fresco.getImagePipeline();
        boolean inMemoryCache = imagePipeline.isInBitmapMemoryCache(Uri.parse(uri));
        if (inMemoryCache) {
            ImageRequestBuilder builder = ImageRequestBuilder.newBuilderWithSource(Uri.parse(uri));
            if (width > 0 && height > 0) {
                builder.setResizeOptions(new ResizeOptions(width, height));
            }
            ImageRequest imageRequest = builder.build();
            DataSource<CloseableReference<CloseableImage>> dataSource =
                    imagePipeline.fetchImageFromBitmapCache(imageRequest, context);
            CloseableReference<CloseableImage> imageReference = dataSource.getResult();
            try {
                if (imageReference != null) {
                    CloseableImage closeableImage = imageReference.get();
                    if (closeableImage != null && closeableImage instanceof CloseableBitmap) {
                        Bitmap underlyingBitmap = ((CloseableBitmap) closeableImage).getUnderlyingBitmap();
                        if (underlyingBitmap != null && !underlyingBitmap.isRecycled()) {
                            resultBitmap = underlyingBitmap.copy(Bitmap.Config.RGB_565, false);
                        }
                    }
                }
            } finally {
                dataSource.close();
                CloseableReference.closeSafely(imageReference);
            }
        }
        return resultBitmap;
    }

    @Override
    public void loadImage(String uri, int width, int height, final ImageLoaderListener listener) {
        ImageRequestBuilder builder = ImageRequestBuilder.newBuilderWithSource(Uri.parse(uri));
        if (width > 0 && height > 0) {
            builder.setResizeOptions(new ResizeOptions(width, height));
        }
        ImageRequest imageRequest = builder.build();

        ImagePipeline imagePipeline = Fresco.getImagePipeline();
        DataSource<CloseableReference<CloseableImage>> dataSource = imagePipeline.fetchDecodedImage(imageRequest, context);

        BaseBitmapDataSubscriber subscriber = new BaseBitmapDataSubscriber() {
            @Override
            public void onNewResultImpl(@Nullable Bitmap bitmap) {
                if (listener != null) {
                    new AsyncTask<Bitmap, Void, Bitmap>() {
                        @Override
                        protected Bitmap doInBackground(Bitmap... params) {
                            Bitmap bitmap = params[0];
                            Bitmap result = null;
                            if (bitmap != null && !bitmap.isRecycled()) {
                                result = bitmap.copy(Bitmap.Config.RGB_565, false);
                            }
                            return result;
                        }

                        @Override
                        protected void onPostExecute(Bitmap bitmap) {
                            if (bitmap != null) {
                                listener.onLoadComplete(bitmap);
                            } else {
                                listener.onLoadFailed(null);
                            }
                        }
                    }.execute(bitmap);
                }
            }

            @Override
            public void onFailureImpl(DataSource dataSource) {
                if (listener != null) {
                    listener.onLoadFailed(dataSource.getFailureCause());
                }
            }
        };

        dataSource.subscribe(subscriber, UiThreadImmediateExecutorService.getInstance());
    }
}

Glide实现

该实现依赖 Glide 库,需要在工程的 build.gradle 文件中添加依赖:

compile 'com.github.bumptech.glide:glide:3.7.0'

如果使用的 IDE 是 Eclipse,则需要在 libs 中添加 Glide 的 jar 包。

public class GlideImageLoader implements UnicornImageLoader {
    private Context context;

    public GlideImageLoader(Context context) {
        this.context = context.getApplicationContext();
    }

    @Nullable
    @Override
    public Bitmap loadImageSync(String uri, int width, int height) {
        return null;
    }

    @Override
    public void loadImage(String uri, int width, int height, final ImageLoaderListener listener) {
        if (width <= 0 || height <= 0) {
            width = height = Integer.MIN_VALUE;
        }

        Glide.with(context).load(uri).asBitmap().into(new SimpleTarget<Bitmap>(width, height) {
            @Override
            public void onResourceReady(Bitmap resource, GlideAnimation<? super Bitmap> glideAnimation) {
                if (listener != null) {
                    listener.onLoadComplete(resource);
                }
            }

            @Override
            public void onLoadFailed(Exception e, Drawable errorDrawable) {
                if (listener != null) {
                    listener.onLoadFailed(e);
                }
            }
        });
    }
}

Picasso实现

该实现依赖 Picasso 库,需要在工程的 build.gradle 文件中添加依赖:

compile 'com.squareup.picasso:picasso:2.5.2'

如果使用的 IDE 是 Eclipse,则需要在 libs 中添加 Picasso 的 jar 包。

public class PicassoImageLoader implements UnicornImageLoader {
    private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
    private Context context;
    private ExecutorService threadPool;
    private Handler uiHandler;

    public PicassoImageLoader(Context context) {
        this.context = context.getApplicationContext();
        uiHandler = new Handler(Looper.getMainLooper());
        threadPool = Executors.newFixedThreadPool(CPU_COUNT + 1);
    }

    @Nullable
    @Override
    public Bitmap loadImageSync(String uri, int width, int height) {
        return null;
    }

    @Override
    public void loadImage(final String uri, final int width, final int height, final ImageLoaderListener listener) {
        threadPool.execute(new Runnable() {
            @Override
            public void run() {
                RequestCreator requestCreator = Picasso
                        .with(context)
                        .load(uri)
                        .config(Bitmap.Config.RGB_565);
                if (width > 0 && height > 0) {
                    requestCreator = requestCreator
                            .resize(width, height)
                            .centerCrop();
                }

                Bitmap bitmap = null;
                try {
                    bitmap = requestCreator.get();
                } catch (IOException e) {
                    e.printStackTrace();
                }

                if (listener == null) {
                    return;
                }

                if (bitmap != null && !bitmap.isRecycled()) {
                    final Bitmap finalBitmap = bitmap;
                    uiHandler.post(new Runnable() {
                        @Override
                        public void run() {
                            listener.onLoadComplete(finalBitmap);
                        }
                    });
                } else {
                    uiHandler.post(new Runnable() {
                        @Override
                        public void run() {
                            listener.onLoadFailed(null);
                        }
                    });
                }
            }
        });
    }
}

主动消息推送

在 4.1 版本中,为了增强企业的主动营销能力,加入给 iOS 和 Android 用户主动推送消息的服务端接口。服务端推送说明见 消息推送

推送消息到达访客端,体现出来的,其实就是一条带扩展字段的普通消息,用户进入客服界面后,也会在消息流中正常展示出来。如果 App 也需要处理这条消息,可以添加对这一事件的监听。接口使用示例如下:


 private void addPushMessageListener() {
        if (qiyuPushMessageListener == null) {
            qiyuPushMessageListener = new OnPushMessageListener() {
                @Override
                public void onReceive(UnicornMessage message, PushMessageExtension extension) {
                    qiyuPushMessage = message;
                    pushMessageExtension = extension;
                    showPushMessageIfResumed();
                }
            };
            Unicorn.addPushMessageListener(qiyuPushMessageListener);
        }
    }

自定义响应事件

为了让用户在使用七鱼 SDK 时拥有更大的灵活性,我们将持续添加更多的事件自定义响应接口。

URL链接点击响应

如果用户或者客服发送的文本消息中带有 URL 链接,SDK 将会解析出该链接。用户点击这个链接后,SDK 默认会打开系统的浏览器,并访问这个 URL。同时 SDK 提供了一个配置选项,允许应用自己处理这个点击事件,用于在应用的内置浏览器中打开链接,以及做钓鱼网址过滤等等场景。

设置自定义的链接点击响应需要在初始化 SDK 时,为 YSFOptionsonMessageItemClickListener 赋值:

// 初始化代码
// YSFOptions options = new YSFOptions();
OnMessageItemClickListener messageItemClickListener = new OnMessageItemClickListener() {
    // 响应 url 点击事件
    public void onURLClicked(Context context, String url) {
        // 打开内置浏览器等动作
    }
}
options.onMessageItemClickListener = messageItemClickListener;

// ... 其他初始化代码
// Unicorn.init(this, "你的appid", options, new UILImageLoader());

平台商家企业

网易七鱼在 V3.2 版本中加入了平台商家企业的支持,平台商家就是类似京东,天猫一类的企业,下属很多其他的第三方商家,每个第三方商家都能够独立管理自己的客服,平台不直接管理客服的分配,绩效等日常工作。如果您不是平台商家企业,可以忽略这部分内容。

本节内容仅仅介绍平台电商接入的相关知识,所有内容是在前面内容基础上编写的,有关 SDK 接入,客服分配,UI 定制等基础知识,请先阅读前文内容。

指定商家

平台商家在申请客服时需要指定商家ID,需要在打开会话界面时传入的ConsultSource中指定shopIdshopId为企业在管理后台创建商家时填入的商家ID。如果不指定shopId将默认申请平台企业下的客服。

商家入口和最近联系商家入口

七鱼客服SDK可以在会话界面添加商家入口和最近联系商家列表入口(以下简称会话列表),商家入口位于评价按钮的左侧,会话列表入口位于消息流的右上角以浮层模式展现。

如果需要开启商家入口,需要在打开会话界面时传入的ConsultSource中指定shopEntrance,如果不指定将不显示商家入口。ShopEntrance中的字段通过ShopEntrance.Builder设置,包含如下信息

字段 类型 说明 备注
logo String 商家logo url 图片地址
name String 商家名称 最多显示三个字符超出将显示“xx...”

如果需要开启会话列表入口,需要在ConsultSource中指定sessionListEntrance,如果不指定将不显示会话列表入口。SessionListEntrance中的字段通过SessionListEntrance.Builder设置,包含如下信息

字段 类型 说明 备注
imageResId DrawableRes资源id 入口图片资源id 建议为半透明图片,如果不设置将显示默认图片
position Position枚举类型 入口位置 目前包含TOP_LEFT和TOP_RIGHT,即屏幕左上角和右上角,如果不设置将默认位于右上角

同时,需要在初始化 SDK 时,为YSFOptionsonShopEventListener赋值,用于用户点击商家入口和会话列表入口时做出响应,示例代码如下

YSFOptions options = new YSFOptions();
options.onShopEventListener = new OnShopEventListener() {
    @Override
    public boolean onShopEntranceClick(Context context, String shopId) {
        // 点击商家入口响应
    }

    @Override
    public boolean onSessionListEntranceClick(Context context) {
        // 点击会话列表入口响应,以下为示例代码
        SessionListActivity.start(context);
        return true;
    }
};

最近联系商家列表

方法 返回类型 方法说明 备注
getContactId() String 获取商家ID
getMsgStatus() MsgStatusEnum 获取最后一条消息状态 MsgStatusEnum为消息状态,包含发送中、已发送等
getUnreadCount() int 获取商家的未读消息条数
getContent() String 获取最后一条消息的预览内容
getTime() long 获取最后一条消息的时间戳
getSessionStatus() SessionStatusEnum 获取会话状态 v3.3新增 SessionStatusEnum为会话状态,如会话中、排队中等

获取商家信息

由于七鱼SDK对会话和商家信息的管理是独立的,因此在POPManager.getSessionList()接口返回的信息中没有包含商家信息,如果要获取商家信息,需要调用以下接口

/**
 * 根据商家ID获取商家信息,如名称,logo
 *
 * @param shopId 商家ID
 * @return 如果用户联系过该商家,返回商家信息,否则返回 null
 */
ShopInfo shopInfo = POPManager.getShopInfo(String shopId);

ShopInfo接口包含如下方法

方法 返回类型 说明 备注
getAccount() String 获取商家ID 即查询商家信息时传入的shopId
getName() String 获取商家名称
getAvatar() String 获取商家logo 图片地址

高级能力开放

创建消息和发送消息

在我们 SDK 中消息的载体是通过 SDK 中的 IMessage 类去实现的,我们发送消息给客服需要两个步骤,一是创建 IMessage 对象,二是发送 IMessage,在 V4.3.0 版本中我们开放了创建消息和发送消息的接口,APP 可以通过 UnicornMessageBuilder 类中的方法去创建不同类型的 IMessage,然后通过 MessageService 中的方法去发送 IMessage。

自定义消息处理

在我们平时使用 ListView 和 RecyclerView 的时候可以根据数据源的不同使用不同的 item 布局,那我们 SDK 也是采取了这种方式去展示消息的,当 SDK 收到消息时,会根据 IMessage(消息的载体) 中不同的 Attachment(也就是我们所说的数据源) 展示不同的布局(每种布局都是一个 ViewHolder)。这只是 SDK 中展示消息的相关的处理逻辑,在 V4.3.0 版本中我们加入了用户自定义处理消息的接口,APP 可以通过该接口去实现消息的处理,这里所说的处理和展示是完全分离的,SDK 在收到消息的时候,会通知 APP 我收到消息,APP 可以根据消息中的 attachment 类型去做不同的处理,但是这个处理不会影响我们 SDK 的展示工作,相关内容的示例代码如下:

//告诉 SDK 语音消息不需要展示 UI 了
MsgCustomizationRegistry.hideViewForMsgType(AudioAttachment.class);
//注册 handler 的工厂
MsgCustomizationRegistry.registerMessageHandlerFactory(new MessageHandlerFactory() {
    @Override
    public UnicornMessageHandler handlerOf(UnicornMessage message) {
        //下面是根据不同的消息进行不同的处理
        if(message.getAttachment() instanceof AudioAttachment){
            return new AudioDemoHandler();  //自定义处理音频消息的 Handler
        }else if(message.getAttachment() instanceof ImageAttachment){
            return new ImageDemoHandler();  //自定义的图片消息
        }else if(message.getAttachment() instanceof ProductAttachment){
            return new ProductDemoHandler(); //自定义商品消息
        }else {
            return null;  //不做处理
        }

    }
});

在这里 hideViewForMsgType 方法有必要说一下,当我们处理的消息不希望展示在客服界面的时候,可以使用该方法去隐藏。上面代码已经很清晰,在 SDK 初始化的时候,你可以注册一个 Factory,当 SDK 收到消息的时候回调用 handlerOf 方法,在 handlerOf 方法中可以根据不同的 attachment 返回不同的 handler,返回之后会调用 Handler 的 onMessage 方法,上面的三个 handler 都是需要 APP 通过继承 UnicornMessageHandler 类去实现,下面的代码展示了如何自定义一个 handler:

public class DemoMsgHandler implements UnicornMessageHandler {
    /**
     *
     * @param context: 消息流所在的上下文
     * @param message:你将要处理的 message ,通过 message.getAttachment 可以拿到你注册的 attachment
     * @param handledOnce:之前是否已经成功处理过该消息,有些活动只需要处理一次,例如一条订单消息只需要弹一次订单列表,所以可以根据这个参数去判断是否需要处理
     * @return 是否处理了该消息,true 为处理了该消息,false 为没处理该消息
     */
    @Override
    public boolean onMessage(Context context, UnicornMessage message, boolean handledOnce) {
        //此方里面可以进行一些处理跳转界面,弹框等操作
        Intent intent = new Intent(context, OrderListActivity.class);
        context.startActivity(intent);
        return true;
    }
}

SDK 中事件的拦截处理

我们知道 sdk 中有很多事件,例如请求客服事件,请求访客评价事件等事件,在 V4.4.0 版本中我们开放了请求客服事件的拦截,App 可以通过实现 API 去监听 sdk 请求客服的事件并得到请求客服事件的一些数据,APP 可以通过修改数据去干预请求客服的事件以达到请求特定客服的目的。下面的代码展示了如何去监听一个请求客服事件:

//一、首先在初始化的时候去赋值 YsfOption 中的 SDKEvents。然后去实现一个 EventProcessFactory 接口,每当有事件发生都会调用 eventOf 方法
YSFOptions options = new YSFOptions();
options.sdkEvents = new SDKEvents();
options.sdkEvents.eventProcessFactory = new EventProcessFactory() {
    @Override
    public UnicornEventBase eventOf(int eventType) {
        //0 代表请求客服事件
        if(eventType == 0){
            return new DemoRequestStaffEvent();
        }
        return null;
    }
};
//二、去自定义一个请求客服事件拦截器 DemoRequestStaffEvent,当有请求客服事件的时候,就会调用 onEvent 方法
/**
 * 请求客服事件的拦截器
 */
public class DemoRequestStaffEvent implements UnicornEventBase<RequestStaffEntry>{
    /**
     * 当事件发生的时候,会回调这个方法,在这个方法中,事件是处于等待的状态的只有调用了
     * callback 中的方法,事件才会继续
     * @param entry 请求客服事件的一些参数
     * @param context 当前界面的 context 对象,使用之前请判断是否为 null
     * @param callback sdk 的回调对象 具体请查看 EventCallback
     */
    @Override
    public void onEvent(final RequestStaffEntry entry, Context context, final EventCallback<RequestStaffEntry> callback) {
        if(context == null){
            ToastUtil.showLongToast("请求客服的信息为:" + entry.toString());
        }else {
            //当处理成功之后可以调用 onProcessEventSuccess 通知 sdk 可以请求客服了
            AlertDialog dialog = new AlertDialog.Builder(context).setMessage("请求客服的信息为" + entry.toString()+"是否拦截")
                    .setPositiveButton("是", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialog, int which) {
                            callback.onInterceptEvent();
                        }
                    })
                    .setNegativeButton("否", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialog, int which) {
                            callback.onProcessEventSuccess(entry);
                        }
                    }).create();
            dialog.show();
        }

    }
}

变更记录

V4.5.0(2018-10-09)

新增

  1. 新增录制和发送小视频的功能
  2. 兼容低版本不能识别 SVG 图片的问题

V4.4.0(2018-09-06)

新增

  1. 新增请求客服事件 App 方拦截的功能
  2. 新增机器人发送卡片的功能
  3. 新增卡片底部重新选择按钮的功能
  4. 新增消息已读未读的功能
  5. 新增用户行为轨迹的功能
  6. 修复了 ServerEnvs 文件的空指针问题
  7. 修复服务直达没有存储到本地的问题
  8. 增加是否拉取已读未读消息的开关

V4.3.0(2018-08-08)

新增

  1. 新增自定义消息处理的接口
  2. 新增商品消息新样式
  3. 新增客服界面右上角按钮自定义
  4. 新增用户进入人工客服界面可以手动发送商品的功能
  5. 新增客服界面输入框相关内容自定义
  6. 优化用户输入联想功能,根据用户输入的消息与企业知识库进行匹配
  7. 新增了创建 IMessage 和发送 IMessage 的接口
  8. 修改了 sendProductMessage 的逻辑,使 show 参数生效

V4.2.2(2018-07-12)

新增

  1. 增加用户切换账户之后未读消息的拉取功能

V4.2.1(2018-06-21)

新增

  1. 支持 bot 富文本的功能
  2. 支持客服端发送的自定义商品信息

V4.1.0(2018-05-17)

新增

  1. 新增用户输入联想,访客输入内容可与企业知识库进行实时匹配
  2. 新增对服务器端主动发送消息方案的支持
  3. 商品链接增加tags字段,用于提供操作入口
  4. 优化长消息阅读体验

V4.0.0(2018-04-08)

新增

  1. 支持 APP 访问轨迹
  2. 访客排队过程中可退出排队
  3. 访客排队过程中可与机器人继续会话
  4. 对机器人回答差评后可填写差评原因
  5. 接入反垃圾系统,垃圾消息将被禁止发送

V3.14.0(2018-02-06)

新增

  1. 满意度评价支持添加标签
  2. 满意度评价支持自动弹出

V3.13.0(2017-12-26)

新增

  1. 增加人工客服模式下的订单选择入口

V3.12.0(2017-11-16)

新增

  1. 增加指定机器人客服
  2. 增加发送正在输入的内容到客服端
  3. 支持 Android 8.1

修改

  1. SDK 改为异步初始化,提升启动速度

V3.11.1(2017-10-17)

新增

  1. 添加静默访客结束会话提示

V3.10.0(2017-09-07)

新增

  1. 增加会话超时提醒
  2. 一触即达增加卡片模板

修改

  1. 修复用户评价时可能会FC的问题
  2. 修复平台商户的名字包含'时会FC的问题
  3. 修复使用 Android Studio 3.0 测试版本时编译失败的问题

V3.9.5(2017-08-15)

新增

  1. 增加对客服主动邀请评价的支持
  2. 增加对自定义文案的支持

V3.9.0(2017-07-20)

新增

  1. 增加对留言功能可关闭的支持。
  2. 一触即达增加自动生成工单和图文混排等模板。
  3. UI自定义中增加标题文字居中选项。

V3.7.1(2017-06-22)

修改

  1. 修复在 OPPO 手机上后台自启动时因为 startService 抛出异常导致初始化失败的问题。
  2. 修复在小米手机上因为 AlarmManager.set 接口抛出安全异常导致崩溃的问题。
  3. 修正 APP 使用 360 加固后初始化时调用 getAnnotation 接口可能会失败,进而导致崩溃的问题。
  4. 修正 OPPO 手机上 bindService 可能会失败的问题。
  5. 修正在某些网络环境下,底层网络解包会抛出异常,导致崩溃的问题。

V3.7.0(2017-05-24)

新增

  1. 增加对富媒体消息的支持。
  2. 增加对机器人回答评价功能。

V3.6.1(2017-05-10)

修改

  1. 修复在系统版本低于 7.0 的手机上可能无法正常拍照的问题。

V3.6.0(2017-04-27)

修改

  1. 修复部分手机写 log 可能造成崩溃的问题。

V3.5.5(2017-04-10)

新增

  1. 增加访客端主动退出会话和退出排队的设置。

修改

  1. 打开会话时无需传入 authToken 字段。
  2. 汇报用户信息增加回调接口,用于确认设置是否成功。
  3. 修正在 targetSdkVersion 大于等于24时,系统版本大于等于 7.0 的手机不能打开拍照页面的问题。

V3.5.0(2017-03-28)

新增

  1. 增加服务直达功能。
  2. 增加 VIP 等级设置。
  3. 请求客服和汇报用户信息增加 authToken 校验字段。
  4. 增加崩溃和异常后的日志反馈功能。

V3.4.0(2017-02-21)

新增

  1. 增加对文件类型消息的支持。
  2. 增加清除缓存的接口。

修改

  1. 修正写 log 时可能的崩溃。

V3.3.0(2017-01-20)

新增

  1. 会话列表中增加会话状态。

修改

  1. 使用 MappedByteBuffer 替代直接文件写入,优化 log 性能。
  2. 修复一些非常偶现的崩溃,包括:从老版本升级并关闭 sdkIconContainer 导致的崩溃,因线程竞争导致的登录状态报告时候的崩溃等。
  3. 进程间唤起方式由 Broadcast 改为 Service,避免极个别机型上收到消息不能唤起 UI 进程的问题。

V3.2.0(2017-01-04)

新增

  1. 新增平台电商企业接入控制,增加 POPManager 接口,增加获取访客会话列表功能。