qiyuSdk

立即使用

概述

网易七鱼 SDK 是客服系统访客端的解决方案，既包含了客服聊天逻辑管理，也提供了聊天界面，开发者可方便的将客服功能集成到自己的 APP 中。
本模块支持 iOS 7 以上，Android 2.3 以上版本，同时支持手机、Pad。在iOS 9.2 以上版本中支持 IPv6，能正常通过苹果审核。 详情请前往官网：http://www.qiyukf.com

Method

• openServiceWindow
• setCustomUIConfig
• setUrlClickCallback
• setUnreadCountCallback
• getUnreadCount
• setUserInfo
• logout

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

配置

模块会在应用启动时初始化七鱼服务，因此需要在 config.xml 的 widget 标签下添加以下内容，否则七鱼服务将无法正常启动！

<feature name="qiyuSdk">
    <param name="appKey" value="七鱼管理后台的appKey" />
    <param name="appName" value="七鱼管理后台的App名称" />
</feature>

方法接口描述

* openServiceWindow

启动客服聊天窗口

openServiceWindow(params)

params

示例代码

var qiyuSdk = api.require('qiyuSdk');
var params = {
    source:{
        sourceTitle:'网易七鱼APICloud',
        sourceUrl:'http://www.qiyukf.com',
        sourceCustomInfo:'我是来自自定义的信息'
    },
    commodityInfo:{
        commodityInfoTitle:'APICloud商品',
        commodityInfoDesc:'这是来自网易七鱼APICloud的商品描述',
        pictureUrl:'http://qiyukf.com/res/img/companyLogo/blmn.png',
        commodityInfoUrl:'http://www.qiyukf.com',
        note:'￥1000',
        show:true
    },
    sessionTitle:'网易七鱼',
    groupId:0,
    staffId:0
}
qiyuSdk.openServiceWindow(params);

* setCustomUIConfig

自定义客服聊天窗口UI

setCustomUIConfig(params)

params

示例代码

var qiyuSdk = api.require('qiyuSdk');
var params = {
    sessionTipTextColor:'#CC00FF',
    sessionTipTextFontSize:20,
    customMessageTextColor:'#CC00FF',
    serviceMessageTextColor:'#CC00FF',
    messageTextFontSize:20,
    tipMessageTextColor:'#CC00FF',
    tipMessageTextFontSize:20,
    inputTextColor:'#CC00FF',
    inputTextFontSize:20,
    sessionBackgroundImage:'widget://image/session_bg.png',
    sessionTipBackgroundColor:'#000000',
    customerHeadImage:'widget://image/customer_head.png',
    serviceHeadImage:'widget://image/service_head.png',
    sessionMessageSpacing:2,
    showHeadImage:true,
    naviBarColor:'#CC00FF',
    naviBarStyleDark:true,
    showAudioEntry:false,
    showEmoticonEntry:false,
    autoShowKeyboard:false
}
qiyuSdk.setCustomUIConfig(params);

* setUrlClickCallback

设置聊天窗口中的链接点击事件回调

setUrlClickCallback(callback)

params

示例代码

var qiyuSdk = api.require('qiyuSdk');
qiyuSdk.setUrlClickCallback(
    function(ret, err){
        api.toast({
            msg: ret,
            duration: 2000,
            location: 'bottom'
        });
    }
);

* setUnreadCountCallback

监听未读消息数，用于更新界面

setUnreadCountCallback(callback)

params

示例代码

var qiyuSdk = api.require('qiyuSdk');
qiyuSdk.setUnreadCountCallback(
    function(ret, err){
        api.toast({
            msg: '未读消息数：' + ret,
            duration: 2000,
            location: 'bottom'
        });
    }
);

* getUnreadCount

主动获取未读消息数

getUnreadCount(callback)

params

示例代码

var qiyuSdk = api.require('qiyuSdk');
qiyuSdk.getUnreadCount(
    function(ret, err){
        api.toast({
            msg: '未读消息数：' + ret,
            duration: 2000,
            location: 'bottom'
        });
    }
);

* setUserInfo

设置CRM个人信息

setUserInfo(params)

params

示例代码

var qiyuSdk = api.require('qiyuSdk');
var params = {
    userId:'uid10101010',
    data:'[{\"key\":\"real_name\", \"value\":\"土豪\"},{\"key\":\"mobile_phone\", \"hidden\":true},{\"key\":\"email\", \"value\":\"13800000000@163.com\"},{\"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\"}]'
}
qiyuSdk.setUserInfo(params);

* logout

注销当前账号

logout()

示例代码

var qiyuSdk = api.require('qiyuSdk');
qiyuSdk.logout();