JavaScript 网页插件

关于来鼓 2020 JavaScript 网站插件，以及通过链接直接打开的单页来鼓对话窗口的接口说明。

手动初始化 #

在加载了来鼓网站插件的前提下，你可以在自己的 JavaScript 中通过调用 _LAIGU('init') 来实现手动初始化。

使用方法如下：

在来鼓的嵌入代码后加入 _LAIGU('manualInit'); ，这个设置将会阻止来鼓插件代码在下载完毕后自动执行初始化操作。
当你需要初始化来鼓插件的时候，在 JavaScript 代码中调用 _LAIGU('init') 即可。

注意：

_LAIGU('manualInit'); 必须紧跟在来鼓的嵌入代码后面。
没有设置 _LAIGU('manualInit'); ，是无法使用 _LAIGU('init'); 的。
如果你在来鼓的代码还没有下载完毕的情况下调用了 _LAIGU('init')，它会等到来鼓代码下载完毕时才被响应。

示例：

<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 在这里开启手动模式（必须紧跟来鼓的嵌入代码）
    _LAIGU('manualInit');
</script>

<!-- 这是你自己的 JavaScript 代码 -->
<script>
    // 你可以自己的代码中选择合适的时机来调用手动初始化
    _LAIGU('init');
</script>
<!-- 在实际使用时你可能会面临很复杂的场景，但是沿着这个套路发挥吧。May force
 be with you -->

不使用来鼓的聊天按钮 #

有时候，也许你不想要显示来鼓自带的聊天按钮，那么你可以使用 _LAIGU('withoutBtn');。

注意:

本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。

示例：

<!-- 这是来鼓的嵌入代码 -->
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 在这里开启无按钮模式（常规情况下，需要紧跟在来鼓嵌入代码之后）
    _LAIGU('withoutBtn');
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时，就可以在自己的逻辑中选择合适的时机调用 withoutBtn
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('withoutBtn');
    _LAIGU('init');
</script>

初始化成功时的回调 #

有时候，也许你需要在来鼓网站插件加载成功后执行一些事件，那么可以使用 _LAIGU('allSet', callback)。

注意：

本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。

示例：

<!-- 这是你的代码 -->
<script type='text/javascript'>
    function yourFunction() {
        // 你可以根据自己的需求编写相应的代码
        console.log('来鼓网站插件初始化完毕。');
    }
</script>

<!-- 这是来鼓的嵌入代码 -->
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 初始化成功时的回调
    _LAIGU('allSet', yourFunction);
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时，就可以在自己的逻辑中选择合适的时机调用 allSet
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('allSet', yourFunction);
    _LAIGU('init');
</script>

如果你想在初始化成功时获知客服的在线状态，那么可以为你编写的 callback 函数添加一个参数，来鼓插件在调用它时，会返回当前的客服状态。

示例：

<!-- 我直接扩展上边例子中写的 yourFunction -->
<script type='text/javascript'>
    /**
     * [yourFunction]
     * @param {boolean} servability [true: 有客服在线, false: 无客服在线]
     */
    function yourFunction(servability) {
        // 你可以根据自己的需求编写相应的代码
        console.log('来鼓网站插件初始化完毕。');
        if (servability) {
            console.log('有客服在线');
        } else {
            console.log('无客服在线');
        }
    }
</script>

强制对话 #

如果你想让来鼓加载成功后直接打开聊天窗口可以如下设置：

示例：

<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 初始化成功后调用来鼓 showPanel
    _LAIGU('allSet', function(){
      _LAIGU('showPanel');
    });
</script>

会话开始时的回调 #

示例：

<!-- 这是你的代码 -->
<script type='text/javascript'>
    function handleStart() {
        console.log('会话开始回调')
    }
</script>

<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    //会话开始时的回调
    _LAIGU('startConversation',handleStart)
</script>

会话结束时的回调 #

示例：

<!-- 这是你的代码 -->
<script type='text/javascript'>
    function handleEnd() {
        console.log('会话开始回调')
    }
</script>

<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    //会话结束时的回调
    _LAIGU('endConversation',handleEnd)
</script>

英文版 #

示例：

<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    //如果需要英文版，可用如下配置
    _LAIGU('language','en')
</script>

如果您用的是聊天链接的方式，那么英文版您可以这样:

正确：
/standalone.html?_=t&eid=我是企业ID&language=en
错误：
/standalone.html?_=t&eid=我是企业ID&language=EN

打开聊天窗 #

在某些需求下，你可能希望在自己编写的代码中掌控来鼓聊天窗。

在来鼓网站插件初始化成功的前提下，调用 _LAIGU('showPanel') 就可以打开来鼓聊天窗。

注意：

如果你在来鼓插件还没有初始化成功的情况下调用了本接口，它将无法被正确执行。
如果你想要在来鼓插件加载完毕后立即调用聊天窗，那么可以组合「初始化成功时的回调」接口来实现。

示例：

<!-- 你可以直接在 HTML 元素中绑定 showPanel -->
<a href="javascript:void(0)" onclick="_LAIGU('showPanel')">联系客服</a>
<!-- 当然也可以在 Javascript 中调用 -->
<script>
    _LAIGU('showPanel');
</script>

如果你想要在调用聊天窗时指定客服或客服组，只需要添加相应的参数即可。

注意：

你可以从来鼓工作台「设置」中的「ID 查询」处获取客服或客服组的 Token。

示例：

<!-- HTML -->
<a href="javascript:void(0)" onclick="_LAIGU('showPanel', {agentToken:
 '客服智子的 Token'})">联系客服-智子</a>
<!-- Javascript -->
<script>
    // 指定客服
    _LAIGU('showPanel', {
        agentToken: '客服智子的 Token'
    });
    // 指定客服组
    _LAIGU('showPanel', {
        groupToken: '客服组的 Token'
    });
    // 如果你同时传递了 agentToken 和 groupToken
    // 那么 groupToken 将被忽略
    _LAIGU('showPanel', {
        agentToken: '客服智子的 Token', // 只有我会起作用
        groupToken: '客服组的 Token' // 我被抛弃了
    });
</script>

隐藏聊天窗 #

在来鼓网站插件初始化成功的前提下，调用 _LAIGU('hidePanel') 就可以隐藏来鼓聊天窗。

示例：

<!-- HTML -->
<button onclick="_LAIGU('hidePanel')">隐藏窗口</button>
<!-- Javascript -->
<script>
    _LAIGU('hidePanel');
</script>

通过配置指定分配客服或客服组 #

某些情况下，你可能希望直接以配置的形式来指定要分配的客服或客服组，那么你可以使用 _LAIGU('assign', {})。

assign 配置对来鼓自带按钮和「打开聊天窗」接口都生效，但是当「打开聊天窗」接口本身携带了客服信息时，就会忽略 assign 的配置。

注意：

本接口不一定要紧跟在来鼓的嵌入代码后面，但尽量在建立对话之前使用。

示例：

<script>
    // 指定客服
    _LAIGU('assign', {
        agentToken: '客服智子的 Token'
    });
    // 指定多个客服
    _LAIGU('assign', {
        agentToken: 'Token1,Token2,Token3'
    });
    // 指定客服组
    _LAIGU('assign', {
        groupToken: '客服组的 Token'
    });
    // 如果你同时传递了 agentToken 和 groupToken
    // 那么 groupToken 将被忽略
    _LAIGU('assign', {
        agentToken: '客服智子的 Token', // 只有我会起作用
        groupToken: '客服组的 Token' // 我被抛弃了
    });
</script>

传递顾客信息 #

在来鼓工作台中，你可以手动为对话中的顾客添加个人信息，而通过 _LAIGU('metadata', {}) 接口，可以将这个工作自动化。

来鼓默认的顾客个人信息包括：

address // 地址
age // 年龄
comment // 备注
email // 邮箱
gender // 性别
name // 名字
qq // QQ
tel // 电话
weibo // 微博
weixin // 微信
contact // 联系人

注意：

如果你在来鼓的代码还没有下载完毕的情况下调用了本接口，它会等到来鼓代码下载完毕后才被执行。

示例：

<!-- 这是你的代码 -->
<script type='text/javascript'>
    /**
     * [在顾客访问你的网站期间，当他触发了某些特定事件时，你可以即时的调整顾客信息]
     * [假设 doSomething 是你用来处理某个特定事件的函数]
     */
    function doSomething () {
        // 传递顾客信息
        _LAIGU('metadata', {
            action: '触发了 doSomething'
        });
    }
</script>

<!-- 这是来鼓的嵌入代码 -->
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 传递顾客信息
    _LAIGU('metadata', {
        name: '智子', // 来鼓默认字段
        address: '半人马座阿尔法星', // 来鼓默认字段
        aaa: 'bla bla bla', // 自定义字段
        xyz: 'lalala' // 自定义字段
    });
</script>

在来鼓工作台中，上方传入的数据将以如下形式分类呈现：

个人信息:

姓名: 智子
地址: 半人马座阿尔法星
自定义信息:

aaa: bla bla bla
xyz: lalala
action: 触发了 doSomething

添加顾客自定义事件信息 #

如果你的产品有多种形式（网页、APP），且都使用了来鼓，那么可以使用 _LAIGU('trackEvent', '事件名称','事件详细数据') 来记录顾客的自定义事件信息。

注意：

事件名称为长度6到32的字符串
事件详细数据只支持key 和 value，key 和 value 均为字符串

示例：

<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 在这里添加自定义事件
    _LAIGU('trackEvent','添加购物车',{'金额':'180元','数量':'2'});
</script>

追踪自定义聊天按钮点击事件 #

有时访客点击了您网站上某个特定的聊天按钮，但是出于某些原因可能并没有主动发起对话。此时您可以通过追踪这个特定聊天按钮的点击事件来判断客户的访问意图。通过调用 _LAIGU(' showPanel', {greeting: "消息内容"}) 方法来通知客服人员，客服就可以根据消息内容来做出判断，从而更好地和客户主动展开对话，进而提高您的访客转化率。

示例

<ul>
    <li onClick="_LAIGU('showPanel', {greeting: '咨询A套餐'})">A 套餐</li>
    <li onClick="_LAIGU('showPanel', {greeting: '咨询B套餐'})">B 套餐</li>
    <li onClick="_LAIGU('showPanel', {greeting: '咨询C套餐'})">C 套餐</li>
</ul>

注意: 此用法适用于自定义聊天按钮场景，仅在对话创建前生效。若开启了强制对话或者无消息访客过滤均会导致些方法无效

获取未读消息 #

来鼓官方的聊天按钮可以显示未读消息的数量，以及提供最近一条未读消息的预览。

如果你设置了无按钮模式，这两个数据也就无法被呈现了。但是通过 _LAIGU('getUnreadMsg', callback); 接口，你可以从 callback 的参数中得到这些数据，用自己的方式在显示它们。

注意：

本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。
由于存储未读消息的依赖于浏览器的 localStorage，所以在 IE8 以下的浏览器中，是无法获取未读消息的。

示例：

<div>
    <div>我的数据来自未读消息接口</div>
    <div>未读消息数量: <b id="unreadNum">0</b></div>
    <div>最后一条未读消息的内容:<b id="unreadMsg"></b></div>
</div>
<!-- 这是一个简单的处理未读消息的示例 -->
<script>
    /**
     * [处理未读消息]
     * @param  {[string, object]} msg [string: 'hasBeenRead',
 object: 未读消息数据]
     */
    function yourFunction(msg) {
        var text = '',
            num = 0;
        if (msg === 'hasBeenRead') { // 消息已被阅读
            num = 0;
        } else if (typeof(msg) === 'object') {
            var unreadNum = document.getElementById('unreadNum').innerHTML,
                lastMsg = msg[msg.length - 1];
            num = isNaN(+unreadNum) ? msg.length : +unreadNum + msg.length;
            // content_type 是消息的类型：
            // text（文字）、photo（图片）、file（文件）
            // content 是消息的内容
            if (lastMsg.content_type === 'text') {
                // 文字消息中可能会存在表情图片，由于路径问题
                // 将文字消息中的图片处理为文字'[表情]'
                text = lastMsg.content.replace(
                    /<img [^>]*src=['"]([^'"]+)[^>]*>/gi, '[表情]'
                );
            } else if (lastMsg.content_type === 'photo') {
                text = '[图片]';
            } else if (lastMsg.content_type === 'file') {
                text = '[文件]';
            } else {
                text = '[新消息]';
            }
        }
        // 未读消息数量
        document.getElementById('unreadNum').innerHTML = num;
        // 最后一条消息的内容
        document.getElementById('unreadMsg').innerHTML = text;
    }
</script>
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 获取未读消息
    _LAIGU('getUnreadMsg', yourFunction);
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时，就可以在自己的逻辑中选择合适的时机调用 getUnreadMsg
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('getUnreadMsg', yourFunction);
    _LAIGU('init');
</script>

获取邀请事件 #

如果你不想使用来鼓提供的邀请弹窗，那么可以用 _LAIGU('getInviting', callback); 来获取邀请事件，然后编写自己喜欢的弹窗。

注意：

当你使用了本接口后，来鼓提供的邀请弹窗将不再出现。
本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。

想要在自己编写的邀请弹窗中「接受邀请」，可以使用「打开聊天窗」接口。
如果你看过来鼓工作台的「对话邀请」设置，应该知道来鼓自带的邀请弹窗拥有「手动邀请」和「自动邀请」。本接口只针对客服手动发出的邀请进行推送。

示例：

<!-- 这是一个简单的处理邀请事件的示例 -->
<script>
    /**
     * [处理邀请事件]
     * @param  {string} agentToken [发出邀请的客服的 token]
     */
    function yourFunction(agentToken) {
        // 你可以在这里面调用你自己编写的邀请窗口
        // 当顾客接受邀请时，你只需要使用下面的方法，即可成功响应邀请
        //「打开聊天窗」接口
        _LAIGU('showPanel', {
            agentToken: agentToken
        });
    }
</script>
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 获取邀请事件
    _LAIGU('getInviting', yourFunction);
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时，就可以在自己的逻辑中选择合适的时机调用 getInviting
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('getInviting', yourFunction);
    _LAIGU('init');
</script>

拒绝邀请 #

当你使用「获取邀请事件」接口时，可以用 _LAIGU('rejectInvitation') 在自己编写的弹窗中触发来鼓的拒绝邀请事件。

注意:

只有在使用了「获取邀请事件」接口时，本接口才有效。

示例：

<script>
    /**
     * [你自己编写的拒绝邀请函数]
     */
    function yourFunction() {
        // 你可以先执行自己的逻辑代码
        // 在适当的时机调用一下来鼓的拒绝邀请接口即可
        _LAIGU('rejectInvitation');
    }
</script>

获取聊天窗口可见性 #

如果你想在来鼓聊天窗口显示或隐藏时处理一些自己的事件，那么可以使用 _LAIGU(‘getPanelVisibility’, callback)` 来获取聊天窗口可见性。

比如你编写了自己的聊天按钮，想在来鼓聊天窗口显示时隐藏聊天按钮（反之亦然），那么这个接口可以帮助你实现需求。

注意：

本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。

示例：

<!-- 你需要根据实际情况编写你自己的处理函数 -->
<script>
    /**
     * [根据聊天窗口的可见状态执行相应的事件]
     * @param  {string} visibility [聊天窗口的可见状态，visible || invisible]
     */
    function yourFunction(visibility) {
        if (visibility === 'visible') {
            console.log('聊天窗口处于显示状态');
        } else {
            console.log('聊天窗口处于隐藏状态');
        }
    }
</script>
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 获取聊天窗口可见性
    _LAIGU('getPanelVisibility', yourFunction);
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时
    // 就可以在自己的逻辑中选择合适的时机调用 getPanelVisibility
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('getPanelVisibility', yourFunction);
    _LAIGU('init');
</script>

设置当指定客服不可服务时如何处理 #

当你指定的客服不在线或无法服务时，可以通过在来鼓嵌入代码之后设置 _LAIGU('fallback', 1); 来指定不同的处理方式。

fallback 接受的参数为数字类型，目前有 1、2、3

1 // 不转接（进入留言也面）
2 // 转接到客服所属于的组
3 // 转接到全企业（这是来鼓默认的处理方式）

注意：

本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。

示例：

<!-- 这是来鼓的嵌入代码 -->
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 设置 fallback
    _LAIGU('fallback', 1);
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时，就可以在自己的逻辑中选择合适的时机调用 fallback
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('fallback', 1);
    _LAIGU('init');
</script>

同步顾客身份 #

如果你的产品有多种形式（网页、APP），且都使用了来鼓，那么可以使用 _LAIGU('clientId', '顾客的唯一标识') 来同步顾客的身份（包括顾客信息、聊天记录等）。

「顾客的唯一标识」来自你自己的用户系统。

注意：

顾客唯一标识为长度6到32的字符串
本接口不一定要紧跟在来鼓的嵌入代码后面，但必须在来鼓插件初始化之前使用。

示例：

<!-- 这是来鼓的嵌入代码 -->
<script type='text/javascript'>
    (function(a, b, c, d, e, j, s) {
        a[d] = a[d] || function() {
            (a[d].a = a[d].a || []).push(arguments)
        };
        j = b.createElement(c),
            s = b.getElementsByTagName(c)[0];
        j.async = true;
        j.charset = 'UTF-8';
        j.src = 'https://static.laigukf.com/widget/loader.js?_=t';
        s.parentNode.insertBefore(j, s);
    })(window, document, 'script', '_LAIGU');
    _LAIGU('entId', '我是企业ID');
    // 设置 clientId
    _LAIGU('clientId', '顾客的唯一标识');
</script>

<script type='text/javascript'>
    // 当你使用了「手动初始化」时，就可以在自己的逻辑中选择合适的时机调用 clientId
    // 只要是在来鼓初始化之前，就可以被正确执行
    _LAIGU('clientId', '顾客的唯一标识');
    _LAIGU('init');
</script>

「聊天链接」传递顾客信息 #

你可以通过给链接添加 metadata 参数来传递顾客的信息到来鼓工作台。

如果你传递了默认信息以外的数据，它在来鼓工作台中将以「自定义信息」的方式被呈现出来。

来鼓默认的顾客个人信息包括：

address, // 地址
age, // 年龄
comment, // 备注
email, // 邮箱
gender, // 性别
name, // 名字
qq, // QQ
tel, // 电话
weibo, // 微博
weixin // 微信

示例：

注意: metadata 中，key 和 value 都要添加双引号

/standalone.html?_=t&eid=我是企业ID&metadata=
{"name":"老王","qq":"123456","age":"11","gender":"男"}

注意：如果你要在 metadata 中添加带有 & 或者 = 的数据，那么你应该先对它们进行转义

&  %26
=  %3D

正确：

/standalone.html?_=t&eid=我是企业ID&metadata={"name":"老王","qq":"123456",
"age":"11","gender":"男","网址":"http://example.com?a%3D1%26b%3D2"}

错误：

/standalone.html?_=t&eid=我是企业ID&metadata={"name":"老王","qq":"123456",
"age":"11","gender":"男","网址":"http://example.com?a=1&b=1"}

「聊天链接」指定多个客服 #

/standalone.html?_=t&eid=我是企业ID&fallback=1&agentid=token1,token2,token3

「聊天链接」设置当指定客服不可服务时如何处理 #

当你指定的客服不在线或无法服务时，可以通过在链接中增加 fallback 参数来指定不同的处理方式。

fallback 接受的参数为数字类型，目前有 1、2、3

1 // 不转接（进入留言页面）
2 // 转接到客服所属于的组
3 // 转接到全企业（这是来鼓来鼓默认的处理方式）

示例：

/standalone.html?_=t&eid=我是企业ID&fallback=1

「聊天链接」同步顾客身份 #

如果你的产品有多种形式（网页、APP），且都使用了来鼓，那么可以通过在链接中添加 clientid 参数来传递顾客的唯一标识，从而同步顾客的身份（包括顾客信息、聊天记录等）。

「顾客的唯一标识」来自你自己的用户系统。

示例：

/standalone.html?_=t&eid=我是企业ID&clientid=我是顾客唯一标识

展开对话窗口（创建对话/排队/留言）回调接口 #

点击聊天按钮展开聊天窗时调用（必须处于有对话，或排队，或留言的状态之一）。

参数说明

type 参数共 3 个值，queue（排队），ticket（工单），conv（对话）；
convId 参数只有在 type 参数值为 conv 时才有值，当 type 参数值不为 conv 时 convId 的值为空字符串。

特殊情况

访客消息过滤开启时，访客输入第一条消息前不会调用；输入第一条后，会调用一次，后面每次点击聊天按钮展开聊天时调用一次；
机器人开启时，建立与机器人的对话也会正常调用；转人工时，如果进入排队或留言，后面每次点击聊天按钮展开聊天窗时会以相应的 type 调用；如果有机器人接待，同时有可能进入排队，这种情况按照排队处理

<script>
_LAIGU('convClickCallback', clickCallback);
function clickCallback(type, convId) {
 console.log(type);
 if (type === 'conv') {
   console.log(convId);
 }
}
</script>

商品卡片 #

网页插件发送商品卡片

企业希望看到用户发起对话时正在浏览的商品信息，以便客服更好的进行客户服务,那么企业可以通过以下方式实现：

<div>
    <button onclick="sendCardMsg()">发送商品卡片</button>
</div>
<script>
  function sendCardMsg() {
    _LAIGU('product', {
      picUrl: 'https://xxx/xxx.jpg',
      title: '来鼓 - 客服系统',
      description: '商品的描述信息',
      productUrl: 'https://xxx/xxx.html',
      salesCount: 111,
      success: data => {
        console.log(data, 'data');
      },
      error: error => {
        console.log(error, 'error');
      }
    });
  }
</script>

工作台插件（iframe）发送商品卡片

如果你已经配置来鼓「自定义iframe」，同时希望嵌入在 iframe 中的页面能够直接发送商品卡片给客户（ex：比如嵌入的页面是企业商品库，客服可以直接在该页面发送商品卡片），那么通过以下方式实现：

<div>
    <button onclick="sendCardMsg()">发送商品卡片</button>
</div>
<script>
  function sendCardMsg() {
    window.parent.postMessage({
      type: 'sendProductCard',
      content: {
        picUrl: 'https://xxx/xxx.jpg',
        title: '来鼓 - 客服系统',
        description: '商品的描述信息',
        productUrl: 'https://xxx/xxx.html',
        salesCount: 111,
      }
    }, '*');
  }
</script>

商品卡片消息的字段规则：

字段	是否必传	验证规则	描述
picUrl	是	字符串且长度小于等于2000	建议商品配图尺寸：242*184，或同等比例
title	是	字符串且长度小于等于100	商品标题
description	是	字符串且长度小于等于500	商品介绍
productUrl	是	字符串且长度小于等于2000	商品 URL
salesCount	否	正整数且不超过15位	商品销量数目

What are your Feelings

Updated on 2021年9月26日

Cookie	Duration	Description
cookielawinfo-checkbox-analytics	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional	11 months	The cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy	11 months	The cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.

常见问题

新手入门

使用来鼓

开发指南