1、功能启用
线上客服--->系统设置--->渠道配置--->用户来源分析
2、参数
可通过设置参数对网页插件进行一些设置。
2.1 设置方式
1、通过script标签上链接，示例如下
<script
id="fs-im-script"
type="text/javascript"
src="https://crm.ceshi112.com/open/imchat/static/creat.js?&webImId=2447060116862665016&autoOpen=3000"
></script>2、通过全局变量FSImChatParams（优先级小于script方式），示例如下
window.FSImChatParams = {
webImId: '2447060116862665016',
autoOpen: 3000,
serviceSessionParams: {}
}2.2 参数说明
| 参数名称 | 参数说明 | 示例 |
| autoOpen | 自动打开网页插件对话框事件；大于0的数字，单位为毫秒。 | {autoOpen: 10000} |
| serviceSessionParams | 发送会话消息时，会附带的参数，可用与记录用户来源 | { serviceSessionParams: {search_word: 'xxx', // 搜索词key_word: 'xxx', // 关键词source_website: 'xxx', // 来源网站landing_page: 'xxx', // 落地页consult_page: 'xxx', // 咨询页} } |
3、API方法
| 方法名 | 功能介绍 | 接收参数 | 使用示例 |
| openChatDialog | 打开网页插件对话框 | {} | FSImChat.openChatDialog() |
| updateParams | 更新网页插件初始化参数 | {serviceSessionParams // 消息发送附带参数} | FSImChat.updateParams({ serviceSessionParams: { sessionId: 'XXXX' }}) |
4、事件
4.1 事件监听
FSImChat.$on(FSImChat.EVENT.RECEIVE_MESSAGE)4.2 事件中心 FSImChat.eventBus
| 方法名 | 功能介绍 | 接收参数 | 使用示例 |
| $on | 监听事件 | 参数1：事件名称（详见3.3 可用事件）参数2：事件处理函数 | FSImChat.$on(FSImChat.EVENT.RECEIVE_MESSAGE, (data) => {}) |
| $once | 仅一次监听事件 | 参数1：事件名称（详见3.3 可用事件）参数2：事件处理函数 |
参数2：事件处理函数FSImChat.$once(FSImChat.EVENT.RECEIVE_MESSAGE, (data) => {})
|
| $off | 移除事件监听 | 参数1：事件名称（详见3.3 可用事件）参数2：需要移除事件处理函数（为空移除所有处理函数） | FSImChat.$off(FSImChat.EVENT.RECEIVE_MESSAGE) |
4.3 可用事件
| 事件名称 | 事件说明 | 参数值 |
| IM_CHAT_READY | 网页插件初始化完毕 | 无 |
| RECEIVE_MESSAGE | 接收到新消息 | { messageCount // 消息数} |