UniApp SDK 接入與下載
在 UniApp 專案中接入聊天,同一套業務程式碼可以釋出到 H5、微信小程式和 App(Android / iOS)。各目標使用的入口不同,下面按目標說明。

| 釋出目標 | 使用 | 說明 |
|---|---|---|
| H5 | @deeprespond/im-uniapp/h5 | 基於 Web SDK,支援獨立 RTC 頻道 |
| 微信小程式 | @deeprespond/im-uniapp/miniprogram | 基於微信小程式 SDK,RTC 頻道只能查詢 |
| App(Android / iOS) | @deeprespond/im-uniapp/app + uni_modules 原生外掛 | 原生外掛負責推送、系統來電和 RTC 媒體 |
當前 JavaScript SDK 為 1.1.1,原生外掛為 1.0.0-alpha,見版本與支援狀態。
安裝
bash
npm install @deeprespond/im-uniapp@1.1.1只發布到 H5 和小程式時,裝這一個包就夠了。釋出 App 時,再把需要的原生外掛解壓到專案的 uni_modules/ 目錄:
| 外掛 | 用途 | 下載 |
|---|---|---|
| 全部外掛 | 下列外掛的合集 | deeprespond-uniapp-plugins-1.0.0-alpha.zip |
deeprespond-im | IM 原生能力 | 下載 |
deeprespond-rtc | 音影片與 RTC 媒體 | 下載 |
dr-rtc-video / dr-rtc-video-x | 影片畫面元件(uni-app / uni-app x) | 影片元件 · 影片元件 X |
| 推送通道 | FCM 與國內廠商通道,按需選擇 | FCM · 華為 · 榮耀 · 小米 · OPPO · vivo · 魅族 |
校驗檔案:UNI_MODULES_SHA256SUMS。外掛目錄中的 UNIAPP_RELEASE.md 寫明瞭依賴順序。外掛上架 DCloud 外掛市場後,這裡會補充市場連結;新版本使用新的下載目錄,舊地址不變。
不能訪問 npm 的內網專案,可以安裝離線包:下載 deeprespond-im-uniapp-1.0.0-alpha.tgz,執行 npm install ./deeprespond-im-uniapp-1.0.0-alpha.tgz。
建立客戶端(H5)
H5 目標的匯入要放在 H5 條件編譯中;之後的登入、會話和訊息用法與 Web SDK 相同:
ts
// #ifdef H5
import { createDRUniAppH5Client } from '@deeprespond/im-uniapp/h5';
const im = createDRUniAppH5Client({ appKey: 'org#app', apiUrl: 'https://im.example.com' });
if (!im.auth.currentUser) await im.auth.loginWithTicket({ ticket }); // 业务服务端签发的登录凭证
const list = im.conversations.list(); // 会话列表:先显示本地数据,后台同步
list.subscribe(() => render(list.getSnapshot().items));
// #endif已經在用 @deeprespond/im-web 的專案,也可以直接從 @deeprespond/im-web/uniapp-h5 匯入,是同一個入口。小程式和 App 目標的接入寫法見對應的 Demo。
可執行的 Demo
| Demo | 倉庫目錄 | 原始碼包 | 執行指南 |
|---|---|---|---|
| H5 | sdk/uniapp/demo | deeprespond-uniapp-demo-h5-1.0.1.zip | H5 Demo |
| 微信小程式 | sdk/uniapp/demo-miniprogram | deeprespond-uniapp-demo-miniprogram-1.0.1.zip | 小程式 Demo |
| App(Android / iOS) | sdk/uniapp/demo-app | deeprespond-uniapp-demo-app-1.0.1.zip | App Demo |
原始碼包的校驗檔案:DEMO_PACKAGES_SHA256SUMS。
能做什麼
| 功能 | 文件 |
|---|---|
| 登入、會話、訊息、好友、群組 | 與 Web SDK 相同:初始化、登入與連線、會話、訊息 |
| AI 機器人的流式回覆 | AI 回覆 |
| 獨立 RTC 頻道(H5、App) | Web 頻道接入、App Demo |
H5 中的音影片
- 需要 HTTPS 或
localhost,以及瀏覽器的 WebRTC;預設不採集,在使用者操作中開啟麥克風或攝像頭,並處理拒絕許可權和自動播放失敗。 - 頁面解除安裝時,取消還沒完成的加入,對已加入的頻道呼叫
leave(),再清理訂閱和影片元素。只移除頁面元素不會退出頻道。 - H5 入口不能當作 App 的原生音影片實現,App 請使用
deeprespond-rtc外掛。
