网页在线客服插件-高级设置文档

更新时间:2026-06-20

不使用自带的聊天按钮

有时候,也许你不想要显示自带的聊天按钮,那么你可以使用custom_config: ['withoutBtn']

示例:

<!-- 这是知你的嵌入代码 -->
 <script type="text/javascript">
            !function (e, t, n, a, i, r, c) {
                e[a] = e[a] || function () {
                    (e[a].a = e[a].a || ).push(arguments);
                };
                r = t.createElement(n);
                c = t.getElementsByTagName(n)[0];
                r.async = !0;
                r.charset = "UTF-8";
                r.src = "https://zhiniplugin.h5bqb.top/customer/widget/zhini.js?_=t";
                c.parentNode.insertBefore(r, c);
            }(window, document, "script", "_ZHINI");
            _ZHINI({
                    channel_id: "网页插件的渠道id",     //  网页插件的渠道id
                    client_id: "顾客的唯一标识",       // 顾客的唯一标识,可为空;
                    custom_config: ['withoutBtn']      // 自定义配置,withoutBtn表示不使用自带的聊天按钮
             });
</script>

初始化成功时的回调

有时候,也许你需要在知你网站插件加载成功后执行一些事件,那么可以使用callback_actions{allSet: function}

示例:

!function (e, t, n, a, i, r, c) {
    e[a] = e[a] || function () {
            (e[a].a = e[a].a || ).push(arguments);
        };
    r = t.createElement(n);
    c = t.getElementsByTagName(n)[0];
    r.async = !0;
    r.charset = "UTF-8";
    r.src = "https://zhiniplugin.h5bqb.top/customer/widget/zhini.js?_=t";
    c.parentNode.insertBefore(r, c);
}(window, document, "script", "_ZHINI");
_ZHINI({
    channel_id: "5d382ff9a5ea64393a6cc9e9",   // 网页插件的渠道id,已自动填写;
    callback_actions: {
        allSet: function () {
            console.log('网站插件初始化完毕。');
            //_ZHINI({action: 'showPanel'});  // 可以在这里调用显示聊天窗的接口
        }
    }
});

显示和隐藏知你自带的聊天按钮

在某些需求下,你可能希望在自己编写的代码中掌控知你自带的聊天按钮。
【当然你可以「不使用知你自带的聊天按钮」,那样就可以随心掌控了】

在知你网站插件初始化成功的前提下,
调用_ZHINI({action: 'showBtn'})就可以打开知你自带的聊天按钮;
调用_ZHINI({action: 'hideBtn'})就可以隐藏知你自带的聊天按钮。

注意:

  • 如果你在知你插件还没有初始化成功的情况下调用了本接口,它将无法被正确执行。
  • 隐藏知你自带的聊天按钮不会自动隐藏聊天窗口,如果要隐藏聊天窗口可以使用「打开和隐藏聊天窗口」接口来实现。
  • 如果你不使用知你自带的聊天按钮,调用本接口不会有任何效果。

示例:

<!-- 你可以直接在 HTML 元素中绑定 showBtn、hideBtn -->
<a href="javascript:void(0)" onclick="_ZHINI({action: 'showBtn'})">显示客服按钮</a>
<a href="javascript:void(0)" onclick="_ZHINI({action: 'hideBtn'})">隐藏聊天按钮</a>

<!-- 当然也可以在 Javascript 中调用 -->
<script>
    _ZHINI({action: 'showBtn'});
    //_ZHINI({action: 'hideBtn'}); 
</script>

自定义访客唯一身份标识、名称及头像

如果您希望同一个用户无论何时何地通过知你网页在线客服咨询时,客服可以看到该用户之前的所有沟通记录,您需要按以下步骤实现:

第一步,先确认网站初始化页面中加入知你嵌入的JS代码。详见知你 - 【设置】-【网页在线客服】-【接入代码】
第二步,根据业务需要生成当前用户的唯一标识 client_id。(注意:client_id需要您自行生成,确保同一用户在不同浏览器访问时,使用的 client_id 保持一致)。

代码示例:

function  initWebplugin(clientId)  {
_ZHINI({
    action:"init",  // 初始化开始指令;
    client_id:clientId,    // 用户的唯一标识,由您自行生成,必填且不能为无效字符,否则不生效;
    name: "小知",        // 访客昵称,可传用户昵称、姓名或业务系统中的展示名,方便客服识别;
    avatar: "https://xxx.com/avatar.png"          // 访客头像,需传入可公网访问的图片URL;
    });
};
let clientId="自定义ID";  // 此处为需要传递的用户自定义ID;
initWebplugin(clientId);  // 此处为调用初始化;

注意:

  1. 此方法需要在加载完成第一步(原知你嵌入的JS代码)之后调用,否则无法生效。
  2. 如调用此方法会根据您传入的 clientId 建立聊天会话窗口,用户唯一身份标识即为您传入的 clientId 。
  3. 传入的 clientId 不能为空,为空则自定义的clientId不生效。
  4. 传入的 clientId 字符长度最长为32位,超出将会为自动截取前32位字符,请注意字符长度。
  5. 限制每分钟调用不超过3次。