2 接口说明

接口调用入口为全局的 V5CHAT 方法，可接受两个参数，第一个为接口名称，第二个为接口需传入的参数(可选，可为字符串、函数和对象等类型，部分接口无需参数)。示例： V5CHAT('msg', '你好') 。

需要注意的是，每个接口调用的时机会有所区别，最重要的一点是所有接口调用需要在 嵌入插件代码之后 ，回调型接口是直接在嵌入插件代码后进行调用，此外还有部分接口可在回调型接口中调用，以及部分接口可在初始化后的任意需要的时刻调用，具体参看对应的分类与接口说明。

注：部分JS接口和回调接口对网页链接形式的弹出框无效，仅支持页内iframe加载的插件样式。

接口总览

V5CHAT('onPluginLoad', function() {
    // 插件加载完成的回调【参见 2.1.1】
});

V5CHAT('onReady', function() {
    // 对话窗口加载完毕的回调【参见 2.1.2】
});

V5CHAT('onConnect', function() {
    // 会话连接建立的回调【参见 2.1.3】
});

V5CHAT('onMessage', function(text) {
    // 收到消息的回调【参见 2.1.4】
});

V5CHAT('onStatusChange', function(status) {
    // 服务状态的回调【参见 2.1.5】 status:
    // `0`: 机器人服务中
    // `1`: 等待人工的排队中，此时仍然由机器人自动回复
    // `2`: 人工客服服务中
    // `3`: 人工客服服务中，但开启了托管，由机器人自动回复
});

V5CHAT('onChatShow', function() {
    // 对话框显示的回调【参见 2.1.6】
});

V5CHAT('onChatHide', function() {
    // 对话框隐藏的回调【参见 2.1.7】
});

V5CHAT('onDestroy', function() {
    // 销毁插件后的回调【参见 2.1.8】
});

V5CHAT('withoutBtn');       // 不显示浮动对话按钮【参见 2.2.2】

V5CHAT('withoutInvite');    // 不显示对话邀请框【参见 2.2.2】

V5CHAT('withoutChat');      // 不显示对话框【参见 2.2.2】

V5CHAT('width', '320px');   // 页内iframe型对话框的宽度【参见 2.2.3】

V5CHAT('height', '480px');  // 页内iframe型对话框的高度【参见 2.2.3】

V5CHAT('position', {  // 页内iframe型对话框的位置【参见 2.2.3】
    init: true,
    ...
});

V5CHAT('language', 'en');   // 指定语言【参见 2.2.4】

V5CHAT('openId', 'openId'); // 指定客户id【参见 2.2.5】

V5CHAT('nickname', '昵称');  // 传递客户昵称【参见 2.2.6】

V5CHAT('avatar', '头像URL'); // 传递客户头像【参见 2.2.7】

V5CHAT('gender', '性别'); // 传递客户性别【参见 2.2.8】

V5CHAT('vip', '客户等级'); // 传递客户等级【参见 2.2.9】

// 指定服务客服(组)【参见 2.2.10】
V5CHAT('human', {
    human: 1,
    wid: 0,
    gid: 10001
});

// 传递客户信息(magic信息)【参见 2.2.11】
V5CHAT('metadata', [
    {key: '客户等级', val: '高级客户'},
    {key: '客户积分', val: '3000'},
    {key: '电话', val: '138xxxxxxxx'},
    {key: '浏览商品', val: 'iPhone X'}
]);

V5CHAT('greeting', '你好');  // 自定义开场白【参见 2.2.12】

V5CHAT('showChatOnHuman', false); // 人工服务时不自动显示对话框【参见 2.2.13】

V5CHAT('faq', ['常见问题1', '常见问题2']);  // 自定义常见问题【参见 2.2.14】

// 自定义热点商品信息【参见 2.2.15】
V5CHAT('defHot', {
    img: 'https://rs.v5kf.com/upload/10000/15099584511.png',
    name: 'v5免费一键生成小程序',
    desc: '不仅仅让你快速拥有小程序，还能为你的小程序接入一个智能客服系统',
    link: 'https://www.v5kf.com/web/exp/wxpro.html',
    price: 'xxx元', // *此参数为可选
    btn: '点击发送'
});

V5CHAT('delay', timer);     // 机器人回复消息的延迟显示【参见 2.2.16】

V5CHAT('showChat');         // 显示对话框【参见 2.3.2】

V5CHAT('hideChat');         // 隐藏对话框【参见 2.3.2】

V5CHAT('showInvite');       // 显示对话邀请框【参见 2.3.2】

V5CHAT('hideInvite');       // 隐藏对话邀请框【参见 2.3.2】

V5CHAT('showBtn');          // 显示浮动对话按钮【参见 2.3.2】

V5CHAT('hideBtn');          // 隐藏浮动对话按钮【参见 2.3.2】

V5CHAT('openLink', url);    // 新窗口打开对话链接, url可不填(使用默认对话链接)【参见 2.3.2】

V5CHAT('connect');          // 建立对话连接【参见 2.3.3】

V5CHAT('msg', '你好');       // 发送文本消息【参见 2.3.4】
// 等价于
V5CHAT('msg', {
    type: 1,
    json: {
        text: '你好'
    }
});