2.2 初始化配置接口

初始化前调用: 紧跟在V5的嵌入代码后调用。

2.2.1 手动初始化

当你的网页加载了V5的插件的前提下,如果不需要立即使用插件,可不必立即初始化插件,在需要的合适场景再手动初始化插件。

使用方法如下:

  1. 在V5的嵌入代码后,调用 V5CHAT('preventInit') ,阻止V5插件代码在下载完毕后自动执行初始化操作。
  2. 当你需要初始化V5插件的时候,在你的代码中调用 V5CHAT('init') 即可。

2.2.2 不显示V5的按钮或者邀请框

有时候,你在后台配置了显示邀请框,也许你不想要显示V5自带的聊天按钮(如您需要自定义对话按钮)或者邀请框,或者部分特殊页面不显示,此时你可以使用(初始化前调用):

V5CHAT('withoutBtn');       // 不显示浮动对话按钮
V5CHAT('withoutInvite');    // 不显示对话邀请框
V5CHAT('withoutChat');      // 不显示对话框

而后,在你需要的时候手动调用对应的接口显示 (初始化之后),参见 2.3。

2.2.3 指定页内iframe型对话框在PC端的宽高及其位置

如果您想要调整页内iframe型对话框在PC端的宽高,可以对其进行指定:

V5CHAT('width', '320px');       // 页内iframe型对话框的宽度
V5CHAT('height', '480px');      // 页内iframe型对话框的高度

其中第二个参数指定宽度值和高度值,建议宽度值不超过720px。

如果您想要调整页内iframe型对话框在PC端可视区域的位置,可以对其进行指定:

V5CHAT('position', {
    init: true,
    ...
});

参数说明:包含了init、left、top、right和bottom五种属性,均为非必选项。

  • init : 是否为初始化,非必须项,默认为true
  • left|right : 对话框距离可视区左侧或右侧边界的距离,必有其一
  • top|bottom : 对话框距离可视区顶部或底部边界的距离,必有其一

例如:init为true时,V5CHAT('position', {init: true, right: '2em', bottom: '3em'})可简写为 V5CHAT('position', {right: '2em', bottom: '3em'}),初始化是调用;反之,init为false时,V5CHAT('position', {init: false, right: '2em', bottom: '3em'})通常会和显示对话框V5CHAT('showChat')接口配合使用,且在其之前调用,用于修改对话框的位置。

2.2.4 指定语言

如果您想要使用英文版的聊天界面,您可以在初始化前指定语言环境:

V5CHAT('language', 'en');

其中第二个参数指定语言,目前支持:

  • en: 英语
  • zh: 简体中文
  • tw: 繁体中文

注意,目前部分带文字提醒的的模板,其中的【浮动对话按钮】和【邀请框】不支持多语言显示,仅支持简体中文,需要多语言显示的请选择不带文字的模板,或者在 onPluginLoad 的回调中进行自定义处理,修改插件按钮中的文字。

2.2.5 指定客户id

如果你的产品有自己的会员系统,客户信息需要关联到V5系统中,可以指定顾客的ID,来标识顾客的身份。

V5CHAT('openId', '<顾客的唯一标识>');

注意此ID的唯一性,避免客户身份出现混乱,如无客户账号登录或无需关联客户身份可不比执行此语句。

2.2.6 传递客户昵称

V5CHAT('nickname', '<昵称>');

2.2.7 传递客户头像

V5CHAT('avatar', '<头像URL>');

2.2.8 传递客户性别

V5CHAT('gender', number);

指定客户性别参数说明:

  • number : 1表示男,2表示女。

2.2.9 传递客户等级

如果指定了客户等级,那么该客户在排队等待时会自动插队优先接入(按等级由高到低的顺序依次自动接入)。

V5CHAT('vip', level);

指定客户等级参数说明:

  • level : 客户等级(支持由低到高的1至5),默认为0

使用此接口时,需配合传递客户昵称(参见 2.2.6)。

2.2.10 指定服务客服

可在V5插件代码插入后任何需要的时候调用(一般紧跟嵌入的V5插件代码后)。

V5CHAT('human', {
    human: 1,
    wid: 0,
    gid: 10001
});

指定客服参数说明:

  • human : 指定客服模式:

    • 1 立即转接指定客服(未建立连接情况下会自动建立连接)
    • 2 客户发送消息,建立连接后转指定客服
    • 3 客户点击“转人工”按钮或者问题触发转人工时,转指定客服
  • gid : 需指定的客服分组编号

  • wid : 需指定的客服编号

客服和客服分组编号可登录V5后台,【人工客服】-【客服】处查看。

2.2.11 配置客户信息(magic信息)

可在V5插件代码插入后任何需要的时候调用。

此接口可传递客户信息到座席端,供座席服务参考,建立连接前只可调用一次,插件会缓存传入参数并在连接建立后立即发出,建立连接后则可以任意调用。客户信息表示以数组形式,数组内容为 {key:'名称',val:'内容'} 格式,参考下方示例。

V5CHAT('metadata', [
    {key: '客户等级', val: '高级客户'},
    {key: '客户积分', val: '3000'},
    {key: '电话', val: '138xxxxxxxx'},
    {key: '浏览商品', val: 'iPhone X'}
]);

2.2.12 自定义开场白

初始化前调用,用于修改对话框内的第一句欢迎语。

V5CHAT('greeting', '你好,欢迎使用V5智能客服系统~');

// 要让开场白问题可点击,需按照如下格式(\n换行与[数字序号]):
V5CHAT('greeting', '你好欢迎使用\n[1] 第一条\n[2] 第二条')

2.2.13 人工服务时自动显示对话框

初始化前调用,默认true

V5CHAT('showChatOnHuman', false); // false 则不自动显示对话框

2.2.14 自定义常见问题列表

对话框显示前调用即可。

V5CHAT('faq', ['常见问题1', '常见问题2']); // 参数为字符串数组

2.2.15 自定义热点商品信息

可在V5插件代码插入后调用。

此接口可传递热点商品信息到客户端,供访客在咨询前选择是否咨询此商品。热点商品信息表示格式,参考下方示例。

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: '点击发送'
});

2.2.16 机器人回复消息的延迟显示

可在V5插件代码插入后调用。

此接口可用于机器人回复消息时,模拟人工回复的延迟显示(即当机器人接收到访客发送的信息后,会延迟timer/2秒后显示机器人回复消息框,并显示...模拟正在输入的状态,在闪烁timer/2秒后显示机器人回复的消息内容)。

V5CHAT('delay', timer); // 参数为字符串

timer 参数表示延迟显示的时间(单位:秒,最大可为10秒),主要有以下几种情况:

  • 固定延迟时间:单个数字(例如:'5')
  • 随机延迟时间:两个数字和半角的减号的组合(例如:'2-5')

results matching ""

    No results matching ""