更新记录
1.0.0(2026-08-21) 下载此版本
- 首次发布:封装环信客服 Android / iOS 原生 SDK 为 UTS 合包插件
- 支持初始化、登录/登出、收发文本/图片/语音/文件、历史消息、未读数、连接与排队/输入状态监听
- 支持 uni-app Vue2/Vue3
平台兼容性
uni-app(5.0)
| Vue2 | Vue3 | Chrome | Safari | app-vue | app-nvue | Android | iOS | 鸿蒙 |
|---|---|---|---|---|---|---|---|---|
| √ | √ | - | - | - | - | - | - | - |
| 微信小程序 | 支付宝小程序 | 抖音小程序 | 百度小程序 | 快手小程序 | 京东小程序 | 鸿蒙元服务 | QQ小程序 | 飞书小程序 | 小红书小程序 | 快应用-华为 | 快应用-联盟 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| - | - | - | - | - | - | - | - | - | - | - | - |
uni-app x(4.19)
| Chrome | Safari | Android | iOS | 鸿蒙 | 微信小程序 |
|---|---|---|---|---|---|
| - | - | √ | √ | - | - |
环信客服UTS插件
将环信客服 Android SDK v1.3.3.9 与 iOS SDK v1.5.4 封装为同一套 UTS 插件,供 uni-app Vue2 / Vue3 使用
目录结构
uni_modules/uts-easemob-kefu/
├── package.json
├── readme.md
├── changelog.md
├── example/chat-demo.vue
└── utssdk/
├── interface.uts
├── app-android/ # index.uts + jar/so + Manifest
└── app-ios/ # index.uts + hybrid.swift + xcframework
环境
- HBuilderX ≥ 3.6.8(Vue2 使用 UTS)
- 仅 App 端(需自定义基座或云打包)
- Android minSdk 21;iOS 11.0+
快速使用(Vue2)
import {
init,
login,
bindChat,
sendTextMessage,
onMessages,
onConnection,
loadMessages
} from '@/uni_modules/uts-easemob-kefu'
// App.vue onLaunch
init({
appKey: 'your#appkey',
tenantId: '租户ID',
configId: '渠道configId',
imServiceNum: 'IM客服服务号',
debug: true,
showVisitorWaitCount: true,
showAgentInputState: true,
apnsCertName: 'iOS推送证书名', // 可选
visitorInfo: {
nickName: '访客',
phone: '***'
}
})
onConnection((res) => {
console.log(res.state, res.code)
})
onMessages((list) => {
console.log('收到消息', list)
})
// 登录后进入聊天页
login({
username: 'visitor001',
password: '123456',
success() {
bindChat()
loadMessages({
pageSize: 20,
success(list) { console.log(list) }
})
},
fail(err) {
console.error(err.code, err.message)
}
})
sendTextMessage({
content: '你好',
success() {},
fail(e) {}
})
更多示例见 example/chat-demo.vue。
主要 API
| API | 说明 |
|---|---|
init |
初始化 SDK |
login / loginWithToken / logout |
登录登出 |
bindChat / unbindChat |
进入/离开会话第二通道 |
sendTextMessage / sendImageMessage / sendVoiceMessage / sendFileMessage |
发消息 |
loadMessages |
历史消息 |
getUnreadCount / markAllAsRead |
未读 |
onMessages / onConnection / onVisitorWaitCount / onAgentInputState |
监听 |
完整类型见 utssdk/interface.uts。
消息字段
msgId / from / to / type / direction / status / timestamp / content / localPath / remoteUrl / duration
上架插件市场(云端)
- 用 HBuilderX 打开含本插件的工程
- 右键
uni_modules/uts-easemob-kefu - 选 UTS 插件,勾选 App-Android、App-iOS
- 使用者从市场导入后 云打包 即可
注意
- 标准运行基座不含本插件原生代码,请打 自定义基座 或直接云打包
- 生产环境账号请走服务端 REST 注册
- 进聊天页
bindChat,离开unbindChat - iOS 若因 SDK 头文件差异编译失败,对照
HelpDeskHeaders 微调hybrid.swift方法名即可
版本
- 插件
1.0.0 - Android:
kefu-sdk-v1.3.3.9 - iOS:HelpDesk
v1.5.4+ HyphenateChat

收藏人数:
下载插件并导入HBuilderX
赞赏(0)
下载 4441
赞赏 36
下载 12524185
赞赏 1943
赞赏
京公网安备:11010802035340号