2.3 开放调用接口

2.3.1 获取聊天接口状态

V5CHAT.isReady      // 对话框是否加载完成
V5CHAT.isConnect    // 是否已建立连接

2.3.2 控制V5插件的组件的显示隐藏

onPluginLoad 后可调用(或者 V5CHAT.isReadytrue 时)。

V5CHAT('showChat');     // 显示对话框
V5CHAT('hideChat');     // 隐藏对话框
V5CHAT('showInvite');   // 显示对话邀请框
V5CHAT('hideInvite');   // 隐藏对话邀请框
V5CHAT('showBtn');      // 显示浮动对话按钮
V5CHAT('hideBtn');      // 隐藏浮动对话按钮
V5CHAT('openLink', url);// 新窗口打开对话链接, url可不填(不填则使用默认对话链接)

2.3.3 建立对话连接

初始化后,建立连接前调用。

V5客服系统的设计是在客户有所操作(发消息,点击对话按钮,转人工按钮等)之后才建立会话连接,这样避免大量无效客户进入客服服务需求,会话连接建立后才可以使用 V5CHAT('msg', '消息内容') 来发送消息,当你需要在合适的时机发起会话或者发送消息时,可使用此接口主动建立连接,此接口调用前 V5CHAT.isConnect 不为true状态才有效(已连接状态没有必要调用)。

V5CHAT('connect');

2.3.4 消息发送接口

建立连接后调用( onConnect 回调后, V5CHAT.isConnecttrue 时)。

使用此接口可在对话连接建立时发送消息,比如客户点击页面上的某些内容需要通知到客服时。消息接口支持多种消息类型,详细格式见如下说明。

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

支持的消息类型type和json参数说明:

消息类型 type
文本 1
图片 2
图文 9
// 文本消息
{
    type: 1,
    json: {
        text: '文本消息'
    }
}
// 图片消息
{
    type: 2,
    json: {
        src: '[图片URL]'
    }
}
// 图文消息
{
    type: 9,
    json: [ // 多图文数组
        {
            name : '图文标题',
            img: '封面图片URL',
            link: '图文链接',
            desc: '图文内容简述'
        }
    ]
}

results matching ""

    No results matching ""