Web JS 接入

提供标准化的客服界面封装，开发者通过简短的代码，就可以直接将智能客服集成到网页中，省去大量的开发调试时间。

接入步骤:

获取接入代码, 粘贴到您的页面中即

完成机器人设置后，点击左侧菜单“对接渠道”->“Web接入设置”进入Web接入页面点击复制代码粘贴到您的页面。代码如下:

<script type="text/javascript" src="https://bot.4paradigm.com/web/assets/ics-web-sdk-js.js"></script>
<script type="text/javascript">
    window.onload = function() {
        // 属性设置(具体参考用户绑定和自定义外观部分)

        // 初始化init方法(详细参数参考init方法部分, 此处以官方机器人为例, 请您复制自己接入页面的代码)
        IcsWebSdkJs.init('https://bot.4paradigm.com/web/chat/98/44b6e722-4b9a-4822-813f-b37be09f72a0')
    }
</script>

init方法

init方法用来初始化一个机器人到您的页面下

IcsWebSdkJs.init(url, target, visitorId, userId, grouopId)

参数

如果不需要传入某个可选参数, 可以传入null

参数	意义
url	体验机器人的url
target(可选)	您页面上的一个DOM元素, 初始化后的机器人组件会直接放到该元素下, 如果期望定位生效, 请将该元素的position值设置为 relative
visitorId(可选)	visitorId为访客的ID, 可用于绑定您自己内部的id系统 (visitorId由creatVisitor方法获取, 详见用户绑定部分), 此时如果没有target传false
userId(可选)	为您自己的系统中的Id, 用于打通两个系统的id映射, 在工作台中嵌入iframe时会拼接在你填写的链接尾部
groupId(可选)	业务组Id, 如果传入, 开启分组接待后, 转人工将直接转到该业务组. (业务组Id 可在全局设置业务组设置中获取)
noCookie(可选)	禁止使用Cookie，默认为false。 Cookie仅被用来保存访客的唯一id，如果禁止Cookie的使用将导致每次刷新页面都创建新的访客，访客无法看到自己的历史会话记录。可在初始化话后调用`IcsWebSdkJs.setCookie()` 方法保存cookie。

用户绑定(可选)

如果您的项目里面有自己的账号系统, 我们也提供了方法关联两个系统的用户,具体方法如下:

方法一

在初始化时先调用createdVisitor方法，并把您系统的用户id（如：uid）传入，再在回调里调用init方法：

IcsWebSdkJs.creatVisitor('https://bot.4paradigm.com/web/chat/98/44b6e722-4b9a-4822-813f-b37be09f72a0',{partnerUserId:uid} ,id => {
      IcsWebSdkJs.init('https://bot.4paradigm.com/web/chat/98/44b6e722-4b9a-4822-813f-b37be09f72a0'); // 初始化组件, url为体验机器人的URL
    })

方法二

在接入代码的初始化部分可以先通过creatVisitor方法, 创建一个新访客.该方法将返回一个我们系统内部的ID,
将此ID保存下来, 用于与您的用户关联.

IcsWebSdkJs.creatVisitor('https://bot.4paradigm.com/web/chat/98/44b6e722-4b9a-4822-813f-b37be09f72a0',{} ,id => {
      console.log(id);
      // 此处可以将id保存到您的系统中, 用于相互关联
      IcsWebSdkJs.init('https://bot.4paradigm.com/web/chat/98/44b6e722-4b9a-4822-813f-b37be09f72a0'); // 初始化组件, url为体验机器人的URL
    })

如果已有ID可以在初始化方法中传入直接传入ID, 就能跨浏览器拉取对应的历史会话, 且在客服工作台中您看到的也将是同一用户.

// 如果已经有绑定的id, 请将在初始化时传入id
IcsWebSdkJs.init('https://bot.4paradigm.com/web/chat/98/44b6e722-4b9a-4822-813f-b37be09f72a0',false, id); // 初始化组件, url为体验机器人的URL

creatVisitor方法

在初始化访客时, 我们还支持您传入初识化的参数, 用于在客服工作台展示相关信息

IcsWebSdkJs.creatVisitor(url, message , fn)

参数

参数	意义
url	体验机器人的URl
message	初始化visitor的参数
fn	回调函数, 返回访客id

message参数

参数	意义
username	姓名
nickname	昵称
phone	电话, 可以逗号分隔传入多个
mail	邮箱, 可以逗号分隔传入多个
company	公司
qq	QQ号
remarks	备注
partnerUserId	您系统内部的用户id

所有参数的是可选的, 若为全空时, 可以传入null或{}

功能函数

隐藏组件

IcsWebSdkJs.hiddenAll(); // 隐藏组件

显示按钮图片

IcsWebSdkJs.hidden(); // 显示按钮图片(可从隐藏状态或窗口状态切换到此状态)

显示对话框

IcsWebSdkJs.show(); // 显示对话框(可从隐藏状态或显示按钮状态切换到此状态)

获取初始化状态

IcsWebSdkJs.getIsInit(); // true:已初始化  false:为初始化

示例代码

下载接入示例代码

Web JS接入