微信小程式 SDK
在微信、企業微信的小程式中接入聊天:登入、單聊與群聊、好友、聊天室、訊息同步、檔案和錄音,並提供把資料繫結到頁面的工具。介面與 Web SDK 一致,媒體和生命週期按小程式的能力適配。

| 專案 | 說明 |
|---|---|
| 當前版本 | 1.1.1(版本與支援狀態) |
| 基礎庫 | 2.21.3 以上 |
| 宿主 | 微信、企業微信;不支援 QQ、支付寶、抖音等 |
| 音影片 | 不支援即時通話;獨立 RTC 頻道只能查詢 |
安裝已釋出 SDK
在你的小程式工程中安裝,然後在開發者工具中執行“構建 npm”:
bash
npm install @deeprespond/im-miniprogram@1.1.1在開發者工具的專案配置中,把 miniprogram_npm/@deeprespond/** 加入 setting.babelSetting.ignore,SDK 已經編譯過,不需要再轉譯。
| 你的工程 | 使用的包 |
|---|---|
| 原生小程式 | @deeprespond/im-miniprogram(預打包,無執行時依賴) |
| Taro React | @deeprespond/im-web/miniprogram + @deeprespond/im-web-react/miniprogram,先匯入 @deeprespond/im-web/polyfills |
| SDK 放在分包中 | 主包匯入 /bind,載入客戶端後用 createDRClientRef 設定引用 |
配置合法域名
在小程式後臺把以下地址加入伺服器域名:
| 型別 | 地址 |
|---|---|
| request | IM 服務的 HTTPS 地址、物件儲存的上傳地址 |
| socket | IM 服務的 WSS 地址 |
| downloadFile | 檔案下載地址 |
用到相簿、麥克風的,還要在小程式後臺宣告對應的隱私介面。
小程式的請求不支援 PATCH,SDK 改用 POST 並帶 X-HTTP-Method-Override: PATCH。IM 服務已支援;如果中間有你自己的閘道器,請放行這個請求頭。
能做什麼
| 功能 | 文件 |
|---|---|
| 建立客戶端、登入、頁面資料繫結、聊天頁 | 快速整合、頁面與媒體 |
| 會話、訊息、好友、群組、聊天室 | 與 Web SDK 相同:會話、訊息、群組、聊天室 |
| AI 機器人的流式回覆 | AI 回覆 |
| 獨立 RTC 頻道(只能查詢) | RTC 頻道查詢與限制 |
與網頁的區別
- 檔案按路徑收發,不支援 Blob;圖片本地快取預設 50 MiB,單次下載最多 200 MiB。
- 手機微信進入後臺約 4 秒後暫停連線,回到前臺自動恢復;電腦版微信不會因後臺斷開。
- 使用者資料按應用、使用者和介面地址隔離;不支援加密儲存的環境會給出警告並改用普通儲存。
從原始碼構建
需要修改 SDK 或執行倉庫中的示例時:
bash
cd sdk/web && pnpm install --frozen-lockfile && pnpm build
cd ../..
make sdk-miniprogram-test
make sdk-miniprogram-example
cd sdk/miniprogram
pnpm pack --out /tmp/im-miniprogram.tgz在你的工程中安裝生成的 tgz,再“構建 npm”。倉庫示例有原生、分包、TypeScript 和 Taro 四種,見 Demo 執行指南。
下一步
- 快速整合、頁面與媒體:建立客戶端、登入和聊天頁。
- Demo 執行指南:原生與 Taro 示例。
- 版本與支援狀態:驗證範圍和已知限制。
