接口文档

初始化

xn('init')

停止默认初始化

xn('stopAutoInit');

设置访客信息

// customerinfo的可选健值见下表
xn('setCustomerInfo', JSONObject customerinfo); 

设置用户信息示例

xn('setCustomerInfo', {
    uid: '测试用户id',
    uname: '测试用户名称',
    userlevel: '测试用户等级（值需要传数字）'
});

设置聊窗语言

// setLanguage的可选健值见下表
xn('setLanguage', config.lan);

设置商品信息示例

xn('setCustomerInfo', {
    itemid: '测试商品id'
});

设置会话标识

xn('setCustomerInfo', {
    exterinfo: {
        conversationFlag: '会话标识'
    }
});

设置订单信息示例

xn('setCustomerInfo', {
    orderid: '测试订单id',
    orderprice: '测试订单金额（值需要传数字）'
});

设置额外信息示例

// 设置知识库，haier-esp示例
xn('setCustomerInfo', {
    exterinfo: {
        robot: {
            knowledgeIds: "1,2,3,4,5,6,7,8,9,10",
            userLabel: '10',
            channelLabel: 'evs',
            sceneLabel: '报销单'
        }
    }
});

// 设置超媒体集成参数
// 当超媒体接口需要personNumber参数时
xn('setCustomerInfo', {
    exterinfo: {
        magicParam: {
            personNumber: '123'
        }
    }
});

// 设置erp信息
xn('setCustomerInfo', {
    exterinfo: {
        erpparam: ''
    }
})

打开聊窗

xn('openChat', String settingid);

最小化聊窗

xn('minChat');

还原聊窗

xn('resizeChat');

隐藏聊窗

xn('hideChat');

关闭聊窗

xn('closeChat');

执行特定情况下的回调函数

// callbacks 格式为 [{type: 'loadScript', func: function(){}}], type可选值见下表, func由客户定义
xn('setCallback', Array callbacks);

参数说明

举例 :

function loadCallback(param){
   console.log('loadCallback=',param)
}

function connectKfCallback(param){
  console.log(param.kfid);
}

xn('setCallback', [
  {
    type: 'loadScript',
    func: loadCallback
  },
  {
    type: 'connectKf',
    func: connectKfCallback
  }
]);

隐藏自动断开时间

xn('config', {
    hideDisconnectMessage: true
});

​

内嵌融合式最小化聊窗

方法调用前:

方法调用后:

// className: 
// 必填,字符串类型,
// 镶嵌在客户网站上的自定义最小化聊窗的类名(显示未读消息等挂载元素的类名)

// style: 
// 非必填, 字符串类型
// 客户的自定义最小化聊窗的样式
// 默认未读消息背景颜色为red,字体颜色为白色
// 通过行内css修改

xn('setCustomMinChat',{className:'btn',style:'background:red;font-size:12px'});

隐藏WAP最小化聊窗

xn('config', {
    mui: {
        hideMinChat: true
    }
});