• 初始化

    .init() 组件默认会在onload事件后自动初始化，当不能自动初始化时，可手动调用此方法。

    • // 初始化网页客服组件
// 组件默认会在 onload 事件后自动初始化
window.KF5SupportBoxAPI.init();

  • 准备就绪

    .ready(callback) 此API提供的方法除init、ready本身外，其他的方法均需要在组件初始化完成之后才能调用。故提供ready方法来保证需要调用的方法能正常执行。

    • @param Function callback 在组件初始化完成后执行的回调函数。使用方法：

      window.KF5SupportBoxAPI.ready(function()
{
        // 在这里调用除 init、ready 以外的其他API方法
        // .........
});

  • 传递用户信息给组件

    .identify(data) 您可以借助此API方法开发功能收集用户信息并传递给组件，通过组件提交工单时自动填写表单对应字段，方便客服人员在后台查看。

    • @param Object data 可以传递的值如下：

      • name 用户昵称

      • email 用户邮箱

      • phone 用户手机

      window.KF5SupportBoxAPI.ready(function()
{
        // 传递用户信息给组件使用
        window.KF5SupportBoxAPI.identify({
                "name" : "用户昵称" ,
                "email" : "用户邮箱" ,
                "phone" : "用户手机" ,
                //自定义用户信息
                "metadata" : [
                        { name : '性别', value : '男' } ,
                        { name : '爱好', value : '广泛' } ,
                        { name : 'XXX', value : 'XXX' }
                ]
        });
});

  • 移除默认按钮

    .removeButton() 当您需要自定义组件的悬浮按钮时，此方法可以用来移除默认按钮。此API方法需要在组件初始化完成以后调用，请参考ready和identify的调用方法，以下其他API方法同样如此。

    • window.KF5SupportBoxAPI.ready(function()
{
        // 移除默认按钮
        window.KF5SupportBoxAPI.removeButton();
});

  • 显示默认按钮

    .showButton(callback)

    • @param Function callback showButton动画完成后执行的回调函数，可选。

      window.KF5SupportBoxAPI.ready(function()
{
        // 显示默认按钮
        window.KF5SupportBoxAPI.showButton(function(){
                // 动画完成后执行的回调函数
                // .........
        });
});

  • 隐藏默认按钮

    .hideButton(callback)

    • @param Function callback hideButton动画完成后执行的回调函数，可选。

      window.KF5SupportBoxAPI.ready(function()
{
        // 隐藏默认按钮
        window.KF5SupportBoxAPI.hideButton(function(){
                // 动画完成后执行的回调函数
                // .........
        });
});

  • 打开组件弹出层

    .open(callback)

    • @param Function callback open动画完成后执行的回调函数，可选。

      window.KF5SupportBoxAPI.ready(function()
{
        // 打开组件弹出层
        window.KF5SupportBoxAPI.open(function(){
                // 动画完成后执行的回调函数
                // .........
        });
});

  • 关闭组件弹出层

    .close(callback)

    • @param Function callback close动画完成后执行的回调函数，可选。

      window.KF5SupportBoxAPI.ready(function()
{
        // 关闭组件弹出层
        window.KF5SupportBoxAPI.close(function(){
                // 动画完成后执行的回调函数
                // .........
        });
});

  • 刷新组件内页面

    .refresh() 将组件重置到初始化状态。

    • window.KF5SupportBoxAPI.ready(function()
{
        // 刷新组件内页面
        window.KF5SupportBoxAPI.refresh();
});