Wechaty 是一款針對聊天機器人製造商的對話式 RPA(機器人流程自動化)SDK(軟體開發套件)。它設計精良,具有易於使用的 API。它支援Linux、OSX、Win32、Docker等所有作業系統,以及微信、WeCom、Whatsapp、Lark、Gitter等多種IM(即時通訊服務)。
作為開發人員,您可以使用 Wechaty 輕鬆建立您的機器人,有效管理訊息發送和接收、房間創建和發送邀請、聯繫朋友,並在用戶和您的機器人之間愉快地添加人工智慧。
如果您是微信的初學者,這個專案是您的最佳起點。您可以透過幾個步驟在 Cloud IDE 上運行它,也可以在電腦上的本機設定上運行它,如以下部分所述。
如果您遇到困難或有任何疑問,歡迎您在我們的 Discord 社群中尋求協助:https://discord.gg/7q8NBZbQzt。
注意:Wechaty目前有效版本是v1.x,與大多數v0.x模組不相容。
[email protected]
- 要使用Wechaty v0.x,請造訪Wechaty入門v0.x分支。ding
訊息時,會回覆dong
訊息。以上是使用微信、WhatsApp 和 WeCom 部署 ding-dong-bot 的簡短流程。
開始使用 Wechaty 最快的方法是使用基於雲端的 IDE 來執行 Wechaty 入門專案。您可以使用 Gitpod 或 Google Cloud Shell。
如果您是初學者,那麼我們推薦 Gitpod。
Gitpod 是一個線上開源平台,用於自動化和可立即編碼的開發環境。您可以點擊下面的按鈕在 gitpod 上存取微信入門叮咚 BOT 專案的完整設定。如果您以前從未使用過 gitpod,則需要使用 gitHub 帳號登入。
您可以透過我們的部落格了解有關 Gitpod ❤️ Wechaty 的更多資訊:無需離開瀏覽器即可開始使用:Wechaty ❤️ Gitpod,@huan,2021 年 2 月 6 日
Google Cloud Shell 是一個線上開發和操作環境,可透過瀏覽器在任何地方存取。您可以透過點擊下面的按鈕在 Google Cloud Shell 上執行此專案。
透過 open-in-cloud-shell 生成
打開 Google Cloud Shell 編輯器後,右側面板中應該有一個打開的教程,您可以按照該教程來了解有關 Wechaty 的更多資訊。
透過我們的部落格了解有關在 Google Cloud Shell 上運行此專案的更多資訊:微信 Google Cloud Shell 教程,@huan,2021 年 2 月 20 日
為了在本機電腦上運行此項目,您需要:
在您的電腦上安裝 Node.js v16+。您可以在終端機上執行命令node -v
來檢查是否安裝了Node.js
如果你有它,你應該可以看到終端機上列印的版本,例如v16.13.0
。您的版本可能與v16.13.0
不同。如果未安裝或您的版本低於16,您需要透過以下連結安裝最新版本:
其他平台的 Node.js 可以在 https://nodejs.org/en/download/package-manager/ 找到
如果您想使用 Web 以外的 RPA 協議,請擁有微信 Puppet 服務 TOKEN
您需要將此儲存庫克隆到本機計算機,然後透過執行以下命令切換到wechaty-getting-started
目錄。
git clone https://github.com/wechaty/getting-started.git
cd getting-started
您需要透過執行以下命令來安裝依賴項。
npm install
在Linux中可以使用export
來設定環境變量,在Windows中可以使用set
。如果執行此命令時遇到錯誤,請查看步驟 4 中的故障排除提示。
export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts
set WECHATY_LOG=verbose
set WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts
你已經準備好了!
如果您在執行上述步驟時遇到問題,請嘗試以下選項。也歡迎您在我們的 gitter 聊天室提問。
如果您使用的是 Windows,您可能還需要 windows-build-tool:
npm install windows-build-tools
在我們的入門範例中,當未設定WECHATY_PUPPET
時,叮咚 BOT 使用 wechaty-puppet-wechat4u,這只是為了新手方便。
預設情況下,Wechaty 將使用 Puppet 服務登入您的機器人。您可以使用其他 Puppet Provider,例如 Whatsapp Web 協定(wechaty-puppet-whatsapp)。
如果您想將 Wechaty Puppet Provider 用於不同的協議,則需要透過設定WECHATY_PUPPET
環境變數來指定 Puppet 服務提供者名稱(與其 NPM 名稱相同)。
感謝我們社區的巨大貢獻,現在有很多Wechaty Puppet可供Wechaty使用。他們幫助我們使用 Web、Pad、Mac 和 Windows 等協定。
協定 | 國家公共管理 |
---|---|
傀儡服務 | wechaty-puppet-service |
Whatsapp 網頁 | wechaty-puppet-whatsapp |
微信網頁版 | wechaty-puppet-wechat |
微信平板 | wechaty-puppet-padlocal |
請訪問我們的網站,以了解有關微信傀儡服務提供者的更多信息
例如,如果您想使用padlocal
puppet,則應在執行npm start
之前設定WECHATY_PUPPET=wechaty-puppet-padlocal
。您還需要wechaty-puppet-padlocal
的 TOKEN,您需要將其設定為WECHATY_PUPPET_PADLOCAL_TOKEN
環境變數。您可以從這裡申請PadLocal TOKEN。下面的程式碼片段說明了上面在 Linux/MacOS 和 Windows 上所描述的內容。
export WECHATY_PUPPET=wechaty-puppet-padlocal
export WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start
set WECHATY_PUPPET=wechaty-puppet-padlocal
set WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start
從此部落格文章了解有關在 Windows 上安裝 Wechaty 的更多資訊。
以上是10分鐘的影片教學。它使用的是 0.14 版或更舊版本的 Wechaty,因此它也已經過時了。如果您是微信新手,這是一個很好的開始方式。
注意:在嘗試更多範例之前,請確保您已經嘗試過此儲存庫中的 wechaty 入門專案。
https://github.com/wechaty/docker-wechaty-getting-started
https://github.com/wechaty/heroku-wechaty-getting-started
https://wechaty.github.io
2017年後註冊的微信帳號將無法透過Web API登入。了解更多請訪問 wechaty/wechaty#872
解決方案:您可以使用Web API以外的Wechaty支援協議,例如pad。了解更多請訪問 wechaty/wechaty#1296
Puppet
是什麼微信中的 Puppet 一詞是用來實作協定插件的抽象類別。外掛是幫助微信控制微信的元件,這就是我們稱之為傀儡的原因。
外掛程式名為PuppetXXX
,例如 PuppetWeChat 使用 google puppeteer 透過 chrome 瀏覽器控制微信 Web API,PuppetPadchat 使用 WebSocket 協定連接協定伺服器來控制 iPad 微信程式。欲了解更多詳細信息,您可以訪問 wiki 中的 Puppet。
透過 Wechaty Puppet 的文檔了解有關 Wechaty Puppet 的更多信息
新增CQRS微信範例。
分支:v1.11:發布微信v1.11。
使用 Google Cloud Shell 進行快速設定!
使用 Gitpod 進行快速設定!
初始版本
@wechaty/貢獻者