Qiabot插件接口使用文档
一. 多语言使用说明
支持语言列表
目前系统支持以下语言(语言代码: 说明):
- zh-CN:简体中文
- zh-TW:繁体中文
- en-US:英语(美国)
- ar-SA:阿拉伯语
- bn-BD:孟加拉语
- de-DE:德语
- es-ES:西班牙语
- fr-FR:法语
- he-IL:希伯来语
- hi-IN:印地语
- id-ID:印尼语
- ja-JP:日语
- ko-KR:韩语
- mr-IN:马拉地语
- pt-BR:葡萄牙语(巴西)
- ru-RU:俄语
- sw-KE:斯瓦希里语
- tr-TR:土耳其语
- ur-PK:乌尔都语
- vi-VN:越南语
系统会自动读取浏览器的语言设置。
如果浏览器语言不在以上列表中,则默认使用简体中文(zh-CN) 。
此外,也可以通过在 URL 中添加 lang 这个 querystring 参数手动指定语言,例如: ?lang=en-US。
二. 传递顾客自定义属性
自定义属性需要在下面这里预先定义好(只有 name 属性不需要自定义),否则会被忽略。


「聊天链接」示例
通过给链接添加 custom_attr(或metadata,兼容旧版) 参数来传递顾客的自定义属性信息到工作台。
示例:
注意: custom_attr 中,key 和 value 都要添加双引号
https://dzz.qbchat.cc/?name=老王&custom_attr={"dep":
["sales"],"age":19,"vip":"gold"}
注意:如果你要在 custom_attr 中添加带有 & 或者 = 的数据,那么你需要先对它们进行转义
& %26
= %3D
正确
https://dzz.qbchat.cc/?custom_attr={"dep":
["sales"],"age":19,"vip":"gold","address":"http://xyz.qiabot.com?
a%3D1%26b%3D2"}
错误
https://dzz.qbchat.cc/?custom_attr={"dep":
["sales"],"age":19,"vip":"gold","address":"http://xyz.qiabot.com?a=1&b=1"}
三.「网页插件」示例
在下面的插件代码的基础上略做修改即可


```jsx
<script>
(function (d, t) {
......(中略)
g.onload = function () {
window.ChatWidget.init({
baseUrl: BASE_URL,
position: 'right',
// 可以如下添加用户属性信息,其中 name 是系统自带的,不需要预先自定义
// name: "老王",
// custom_attr(或 metadata,兼容旧版): {"age": "22", "vip": "gold"}
});
}
})(document, "script");
</script>
```
四. 同步顾客身份
以下特殊属性会同步顾客身份,即值相同的顾客会被合并
identifier
这里的identifier 来自于你的产品自己的用户系统
请千万不要随意传这个字段,否则会出现多个顾客因为参数相同被识别成同一个顾客并相互串消息的情况!
「聊天链接」示例
传递参数时,只要参数的值是相同的,即视为同一个顾客,系统会自行执行合并。
https://dzz.qbchat.cc/?identifier=123abc&phone=18088888888
「网页插件」示例
在下面的插件代码的基础上略做修改即可

```jsx
<script>
(function (d, t) {
......(中略)
g.onload = function () {
window.ChatWidget.init({
baseUrl: BASE_URL,
position: 'right',
// 可以如下同步顾客身份
// identifier: "用户ID",
});
}
})(document, "script");
</script>
```
