更新记录
4.4.0(2025-12-30) 下载此版本
4.4.0(2025-12-30)
- v7版本
- 新版UI样式
平台兼容性
uni-app(3.6.15)
| Vue2 | Vue3 | Chrome | Safari | app-vue | app-nvue | Android | iOS | 鸿蒙 |
|---|---|---|---|---|---|---|---|---|
| √ | √ | - | - | - | - | - | - | - |
| 微信小程序 | 支付宝小程序 | 抖音小程序 | 百度小程序 | 快手小程序 | 京东小程序 | 鸿蒙元服务 | QQ小程序 | 飞书小程序 | 快应用-华为 | 快应用-联盟 |
|---|---|---|---|---|---|---|---|---|---|---|
| - | - | - | - | - | - | - | - | - | - | - |
uni-app x(3.6.15)
| Chrome | Safari | Android | iOS | 鸿蒙 | 微信小程序 |
|---|---|---|---|---|---|
| - | - | - | - | - | - |
sobot-chat-client
Android 和 IOS 智齿客服系统插件
概述
智齿客服全面支持桌面网站、移动网站、微信、微博、APP五种接入方式,只要10分钟就可以将智齿客服嵌入所有营销路径,各渠道用户反馈汇总至智齿客服平台统一轻松管理,企业客服效率提升50%以上。
sobot-chat-client是一款实现手机用户与企业保持随时随刻沟通的客服工具。本插件封装了智齿客服的相关接口。使用此插件之前需要先注册智齿获取appkey
一 、使用插件前准备
注册方法如下:
使用管理员账号登陆智齿管理后台,在 桌面网站客服 > APP >添加App 创建应用后可得到 appkey 用于配置。
注意:本插件在ios上支持最低版本为13.0 , 在android 智齿最低版本为5.1
二、插件方法介绍
1、启动智齿客服 startZhiChi
2、启动客户服务中心 openSobotHelpCenter
3、获取未读消息数 getUnReadMessage
4、注销会话 closeSobotChat
5、参数说明整体参数说明
6、补充说明常见问题
三、导入插件方法
import {
startZhiChi,
openSobotHelpCenter,
closeSobotChat,
getUnReadMessage,
closeSobotChatPage
} from "@/uni_modules/sobot-chat-client"
四、启动智齿客服
示例代码如下
startZhiChi({
app_key: '1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a', // 替换为真实app_key
partnerid: 'znw12345'// 替换为真实app_key
});
相关参数,请参考参数说明
五、启动客户服务中心
示例代码如下
openSobotHelpCenter({
app_key: '1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a', // 替换为真实app_key
partnerid: 'znw12345'// 替换为真实app_key
});
相关参数,请参考参数说明
六、获取未读消息数
示例代码如下
let unReadCount = getUnReadMessage('partnerid');
uni.showToast({
title: '未读数:' + unReadCount,
icon: 'none'
});
partnerid:
- 类型:字符串
- 默认值:无
- 描述:对应用户的标识
七、注销会话
示例代码如下
closeSobotChat();
isClosePush(仅适用iOS):
- 类型:boolean
- 默认值:false
- 描述:是否同时关闭推送(离线用户后,可以继续接受客服推送的离线消息;如果没有开启推送,无需关注)
八、参数说明
适用于iOS和android系统(特殊说明除外)
api_host:
- 类型:字符串
- 默认值:https://api.sobot.com
- 描述:默认SaaS平台域名为:https://api.sobot.com,可为空
app_key:
- 类型:字符串
- 默认值:无
- 描述:注册智齿后,从智齿后台获得的app_key,不可为空
partnerid:
- 类型:字符串
- 默认值:无
- 描述:用户标识,可为空(建议填写,对数据统计更准确,不填默认是设备唯一标识)
choose_adminid:
- 类型:字符串
- 默认值:无
- 描述:指定客服ID,可为空
tran_flag:
- 类型:字符串
- 默认值:"0"
- 描述:定指客服时转接类型,0 可转入其他客服 1 必须转入指定客服(注意:如果当前指定的客服不在线,选择之后不能在转接到其他客服),可为空
user_nick:
- 类型:字符串
- 默认值:无
- 描述:用户昵称,可为空(填写后,客服后台会同步到备注),可为空
user_name:
- 类型:字符串
- 默认值:无
- 描述:用户真实姓名,可为空
user_tels:
- 类型:字符串
- 默认值:无
- 描述:用户电话,可为空
user_emails
- 类型:字符串
- 默认值:无
- 描述:用户邮箱,可为空
isVip
- 类型:字符串
- 默认值:指定客户是否为vip,"0":普通 "1":vip
- 描述:同PC端 设置-在线客服分配-排队优先设置-VIP客户排队优先 开启传1 默认不设置开启后 指定客户发起咨询时,如果出现排队,系统将优先接入。
vip_level
- 类型:字符串
- 默认值:无
- 描述:指定客户的vip等级,传入等级,设置-自定义字段-VIP等级(注意设置编码,不是显示值),可为空
user_label
- 类型:字符串
- 默认值:无
- 描述:用户标签,多个字段用逗号分隔,可为空
- 类型:字符串
- 默认值:无
- 描述:用户qq,可为空
face
- 类型:字符串
- 默认值:无
- 描述:用户头像,可为空
remark
- 类型:字符串
- 默认值:无
- 描述:用户备注,可为空
params
- 类型:json字典
- 默认值:无
- 描述:自定义用户资料,自动同步到客户工作台,可为空
- 示例:
params: JSON.stringify({ "deviceid": "iOS", "actionType": "to_group", "optionId": "4", "deciId": "a457f4dfe92842f8a11d1616c1c58dc1", "key2": "123456" })
customer_fields
- 类型:json字符串
- 默认值:无
- 描述:固定KEY的自定义字段,所有的KEY均在工作台设置后生效(设置->自定义字段->用户信息字段),可为空
- 示例:
//固定key来源:通过智齿后台 -> 在线客服 -> 客户信息设置获取 customer_fields: JSON.stringify({ "89da409afd8b4407bdf03a7a0d3071ac": "真是姓名", "69cfe2c709974e308c4a6bebf2155acd": "性别" })
multi_params
- 类型:json字典
- 默认值:无
- 描述:多轮会话 自定义字段,可为空
- 示例:
multi_params: JSON.stringify({ "deviceid": "iOS", "actionType": "to_group" })
groupid
- 类型:字符串
- 默认值:无
- 描述:技能组编号,根据传递的值转接到对应的技能组,可为空选
group_name
- 类型:字符串
- 默认值:无
- 描述:技能组名称,可选
good_msg_type
- 类型:number
- 默认值:0
- 描述:自动发送信息类型,0 不发 1 给机器人发送 2 给人工发送 3 机器人和人工都发送,可选,配合content一起使用
content
- 类型:字符串
- 默认值:无
- 描述:自动发送信息内容,可选
urlRegular
- 类型:字符串
- 默认值:@"((http[s]{0,1}|ftp)://[a-zA-Z0-9\.\-]+\.([a-zA-Z0-9]{1,4})(:\d+)?(/[a-zA-Z0-9\.\-~!@#$%^&+?:_/=<>])?)|(([a-zA-Z0-9]{2,4}).[a-zA-Z0-9\.\-]+\.([a-zA-Z]{2,4})(:\d+)?(/[a-zA-Z0-9\.\-~!@#$%^&+?:_/=<>])?)"
- 描述:链接地址正则表达式
telRegular
- 类型:字符串
- 默认值:@"0+\d{2}-\d{8}|0+\d{2}-\d{7}|0+\d{3}-\d{8}|0+\d{3}-\d{7}|1+[34578]+\d{9}|\+\d{2}1+[34578]+\d{9}|400\d{7}|400-\d{3}-\d{4}|\d{11}|\d{10}|\d{8}|\d{7}"
- 描述:电话号码正则表达式
isOpenRecord
- 类型:boolean
- 默认值:true
- 描述:是否开启语音功能,默认开启。
isOpenRobotVoice
- 类型:boolean
- 默认值:false
- 描述:是否开启机器人语音,(付费,否则语音无法识别)
isShowReturnTips
- 类型:boolean
- 默认值:false
- 描述:左上角返回时是否弹出(您是否结束会话?)。默认false,弹出,false不弹
isShowClose
- 类型:boolean
- 默认值:false
- 描述:导航栏右上角 是否显示 关闭按钮 默认不显示,关闭按钮,点击后无法监听后台消息
isOpenEvaluation:
- 类型:boolean
- 默认值:false
- 描述:返回时是否开启满意度评价 ,默认为false 未开启
isShowCloseSatisfaction
- 类型:boolean
- 默认值:false
- 描述:针对关闭按钮,单独设置是否显示评价界面,默认不显示
isCloseAfterEvaluation
- 类型:boolean
- 默认值:false
- 描述:评价完人工是否关闭会话,默认为false。
canBackWithNotEvaluation
- 类型:boolean
- 默认值:false
- 描述:左上角返回和右上角关闭 返回弹出评价窗口时,是否显示暂不评价按钮 默认 false ,不显示
hideRototEvaluationLabels:
- 类型:booleanean
- 默认值:false
- 描述:隐藏机器人时评价标签
hideManualEvaluationLabels:
- 类型:booleanean
- 默认值:false
- 描述:隐藏人工时评价标签
leaveMsgGroupId
- 类型:字符串
- 默认值:无
- 描述:留言技能组 id,获取:设置 —>工单技能组设置
showLeaveDetailBackEvaluate
- 类型:boolean
- 默认值:false
-
描述:已完成留言详情界面:返回时是否弹出服务评价窗口(只会第一次返回弹,下次返回不会再弹)
以下是商品卡片相关的参数
isSendInfoCard:
-
类型:boolean
-
默认值:false
-
描述:商品卡片信息是否自动发送(转人工成功时,自动发送商品卡片信息)
isEveryTimeSendCard:
- 类型:boolean
- 默认值:false
- 描述:是否每次进入都发送商品卡片
goodsTitle
- 类型:字符串
- 默认值:无
- 描述:内容描述,如果要显示必须填写;自定义咨询内容,在转接人工成功时,方便用户发送自己咨询的信息
goodsLabel
- 类型:字符串
- 默认值:无
- 描述:内容标签,如果要显示价格、分类等
goodsDesc
- 类型:字符串
- 默认值:无
- 描述:发送给客服的商品摘要,如果要显示必须填写;自定义咨询内容,在转接人工成功时,方便用户发送自己咨询的信息
goodsImage
- 类型:字符串
- 默认值:无
- 描述:图片URL;自定义咨询内容,在转接人工成功时,方便用户发送自己咨询的信息
goodsLink
- 类型:字符串
- 默认值:无 必填,且是有效链接
- 描述:当前商品URL;自定义咨询内容,在转接人工成功时,方便用户发送自己咨询的信息
商品卡片示例配置
goodsTitle: "商品名字",
goodsLabel: "30.5$",
goodsDesc: "商品描述",
goodsImage: "https://img.sobot.com/chatres/75574e5fa29a48458d1f57ab5489a4c5/msg/20200612/75574e5fa29a48458d1f57ab5489a4c5123456789/aae707c620744e92bb112de8b67cd3ed.png",
goodsLink: "https://home.firefoxchina.cn/",
isSendInfoCard: true,
isEveryTimeSendCard: true
以下是订单卡片相关的参数
autoSendOrderMessage
- 类型:boolean
- 默认值:false
- 描述:人工后,是否主动发送一条订单信息,true:发送,false:不发
isEveryTimeAutoSend
- 类型:boolean
- 默认值:false
- 描述:是否进入聊天页面都发送订单卡片
orderStatus
- 类型:number
- 默认值:
- 描述:订单状态: 待付款: 1,待发货: 2,运输中: 3,派送中: 4,已完成: 5,待评价: 6,已取消: 7; 0: 代表自定义状态,配合statusCustom使用
statusCustom
- 类型:字符串
- 默认值:无
- 描述:订单状态自定义状态,可以根据自己的需要填写
createTime
- 类型:字符串
- 默认值:无
- 描述:例如:1569491413000,不是这样的值,会发送不成功
orderCode
- 类型:字符串
- 默认值:无
- 描述:编号
goods
- 类型:json数组字符串
- 默认值:无
- 描述:订单卡片里边商品集合信息
orderUrl
- 类型:字符串
- 默认值:无
- 描述:订单链接
goodsCount
- 类型:字符串
- 默认值:无
- 描述:商品数量
totalFee
- 类型:字符串
- 默认值:无
- 描述:订单价格(价格的单位为分,比如1元,需要传100)
订单卡片示例配置
goods: JSON.stringify([{
"name": "商品名称111",
"pictureUrl": "https://img1.baidu.com/it/u=1086264495,2583232026&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500"
}, {
"name": "商品名称222",
"pictureUrl": "https://img.sobot.com/console/common/face/admin.png"
}]),
orderUrl: "https://www.sobot.com",
statusCustom: "已发货",
orderStatus: "0",
orderCode: "v2131232132",
autoSendOrderMessage: true,
goodsCount: "2",
totalFee: "3034",
createTime: "1569491413000",
custom_card
- 类型:json对象
- 默认值:
- 描述:自定义商品订单卡片参数参考地址
ishidesBottomBarWhenPushed(仅适用iOS)
- 类型:boolean
- 默认值:true
- 描述:push后隐藏 BottomBar
navcBarHidden(仅适用iOS)
- 类型:boolean
- 默认值:false
- 描述:SDK 页面中使用自定义的导航栏不在使用系统的导航栏(隐藏),默认 为false 跟随集成项目
isUseImagesxcassets(仅适用ios)
- 类型:boolean
- 默认值:false
- 描述:是否使用Images
isLandscapeMode(仅适用Android)
- 类型:boolean
- 默认值:false
- 描述:是否横屏,true 横屏,false 竖屏,默认竖屏
isShowPortrait(仅适用iOS)
- 类型:boolean
- 默认值:false
- 描述:仅支持竖屏,跟随APP配置
isDebugMode(仅适用iOS):
- 类型:booleanean
- 默认值:false
- 描述:根据此设置调用的推送证书,默认false, false:调用生产环境, true:测试环境
showfalsetification(仅适配安卓)
- 类型:boolean
- 默认值:false
- 描述:是否消息提醒,会话没结束时可在通知栏中显示最新收到的消息
absolute_language:
- 类型:字符串
- 默认值:无
- 描述:指定本地语言,指定后不再根据系统语言切换,详细支持语言见官网说明(例如:ar_lproj,zh-Hans_lproj,zh-Hant_lproj,en_lproj、tr_lproj、pl_lproj、ru_lproj、ja_lproj、ko_lproj等)
补充说明
1、无法启动插件 使用此插件,必须先传入app_key参数,其它参数可根据自己实际情况选择设置;

收藏人数:
下载插件并导入HBuilderX
赞赏(0)
下载 1567
赞赏 0
下载 12755389
赞赏 1832
赞赏
京公网安备:11010802035340号