服务端 API

快速集成方案(uni-app)

最近更新时间:2022-01-24 11:10:05

什么是 uni-app TUIKit?

uni-app TUIKit 是基于 IM SDK 实现的一套 UI 组件,其包含会话、聊天、群组管理等功能,基于 UI 组件您可以像搭积木一样快速搭建起自己的业务逻辑。

目前我们提供了示例客服群、示例好友的基础模板,在线客服功能包括:

  • 支持发送文本消息、图片消息、语音消息、视频消息等常见消息。
  • 支持双人语音、视频通话功能。
  • 支持常用语、订单、服务评价等自定义消息。
  • 支持创建群聊会话、群成员管理等。
会话列表界面 C2C 聊天界面 群组聊天界面

uni-app TUIKit 支持平台

  • Android
  • iOS
  • 微信小程序

如何集成 TUIKit?

快速搭建

步骤1:安装依赖

  1. uni-app TUIKit 支持源码集成,下载 uni-app TUIKit 源码。将 TUIKit 文件夹与自己的工程文件夹置于同级,例如:
  2. 根据 package.json 进行对应依赖安装。
    说明:

    可参见 uni-app 官网

步骤2:初始化TUIKit

将 app.vue 中的代码复制到 myApplication 项目中,填写 SDKAppID。

步骤3:集成静态资源文件

  1. 在 myApplication 项目中集成静态资源文件 (工具、图片等)。
  2. 在 myApplication 引入 mixins,用于实现 setData 等功能。

步骤4:集成所需模块

  1. 将 pages 和 components 复制到 myApplication 项目中。
  2. 也可以只集成自己所需要的模块,将 pages 和其对应的 components 复制到 myApplication 项目目录下。

步骤5:更新路由

根据页面更新路由:更新 pages.json 中的 pages 路由。

步骤6:获取签名和登录

注意:

  • 正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig
uni.$TUIKit.login({userID: 'your userID', userSig: 'your userSig'})
.then(function(imResponse) {
console.log(imResponse.data); // 登录成功
if (imResponse.data.repeatLogin === true) {
// 标识帐号已登录,本次登录操作为重复登录。v2.5.1 起支持
console.log(imResponse.data.errorInfo);
}
})
.catch(function(imError) {
console.warn('login error:', imError); // 登录失败的相关信息
});

开启音视频通话

常见问题

1. uni-app 同时支持 Android,iOS, 微信小程序平台,IM SDK 如何选择?

请选择 tim-wx-sdk ,npm 安装或者静态引入:

// 从v2.11.2起,SDK 支持了 WebSocket,推荐接入;v2.10.2及以下版本,使用 HTTP
npm install tim-wx-sdk@latest --save
import TIM from 'tim-wx-sdk';
// 创建 SDK 实例,`TIM.create()`方法对于同一个 `SDKAppID` 只会返回同一份实例
uni.$TUIKit = TIM.create({
SDKAppID: 0 // 接入时需要将0替换为您的即时通信 IM 应用的 SDKAppID
});
// 设置 SDK 日志输出级别,详细分级请参见 setLogLevel 接口的说明
uni.$TUIKit.setLogLevel(0); // 普通级别,日志量较多,接入时建议使用
// uni.$TUIKit.setLogLevel(1); // release 级别,SDK 输出关键信息,生产环境时建议使用
如果您的项目需要关系链功能,请使用 tim-wx-friendship.js
import TIM from 'tim-wx-sdk/tim-wx-friendship.js';
说明:

  • 为了 uni-app 更好地接入使用 tim,快速定位和解决问题,请勿修改 uni.$TUIKit 命名,如果您已经接入 tim ,请将 uni.tim 修改为 uni.$TUIKit。
  • 请将 IM SDK 升级到 2.15.0,该版本支持了 iOS 语音播放。
  • 若同步依赖过程中出现问题,请切换 npm 源后再次重试。
切换 cnpm 源
>npm config set registry http://r.cnpmjs.org/
>
>

2. 如何上传图片、视频、语音消息等富媒体消息?

请使用 cos-wx-sdk-v5

// 发送图片、语音、视频等消息需要 cos-wx-sdk-v5 上传插件
npm install cos-wx-sdk-v5@0.7.11 --save
import COS from "cos-wx-sdk-v5";
// 注册 COS SDK 插件
uni.$TUIKit.registerPlugin({
'cos-wx-sdk': COS
});

3. uni-app 打包 iOS 语音消息无法播放怎么办?

请将 IM SDK 升级到 2.15.0,该版本支持了 iOS 语音消息播放。

4. uni-app 打包 app 发送语音消息时间显示错误怎么办?

uni-app 打包 app,recorderManager.onStop 回调中没有 durationfileSize,需要用户自己补充 duration 和 fileSize。

  • 通过本地起定时器记录时间,计算出 duration。
  • 本地计算文件大小,fileSize = (音频码率) x 时间长度(单位:秒) / 8,粗略估算。
    详细代码请参见 uni-app TUIKit
    注意:

    语音消息对象中必须包括 durationfileSize,如果没有 fileSize,语音消息时长是一串错误的数字

5. video 视频消息层级过高无法滑动怎么办?

在项目中通过视频图片代替,没有直接渲染 video,在播放时渲染的方式规避了层级过高问题。

6. 微信小程序环境,真机预览,报系统错误,体积过大怎么办?

运行时请勾选代码压缩,运行到小程序模拟器>运行时是否压缩代码。

7. 引入原生音视频插件报以下错怎么办?


根据 uni-app 原生插件调试制作自定义基座

8. 微信小程序如果需要上线或者部署正式环境怎么办?

请在微信公众平台>开发>开发设置>服务器域名中进行域名配置:

将以下域名添加到 request 合法域名

从v2.11.2起 SDK 支持了 WebSocket,WebSocket 版本须添加以下域名:

域名 说明 是否必须
wss://wss.im.qcloud.com Web IM 业务域名 必须
wss://wss.tim.qq.com Web IM 业务域名 必须
https://web.sdk.qcloud.com Web IM 业务域名 必须
https://webim.tim.qq.com Web IM 业务域名 必须

v2.10.2及以下版本使用 HTTP,HTTP 版本须添加以下域名:

域名 说明 是否必须
https://webim.tim.qq.com Web IM 业务域名 必须
https://yun.tim.qq.com Web IM 业务域名 必须
https://events.tim.qq.com Web IM 业务域名 必须
https://grouptalk.c2c.qq.com Web IM 业务域名 必须
https://pingtas.qq.com Web IM 统计域名 必须

将以下域名添加到 uploadFile 合法域名

域名 说明 是否必须
https://cos.ap-shanghai.myqcloud.com 文件上传域名 必须

将以下域名添加到 downloadFile 合法域名

域名 说明 是否必须
https://cos.ap-shanghai.myqcloud.com 文件下载域名 必须

技术咨询

了解更多详情您可 QQ 咨询:309869925技术交流群

参见文档

目录