mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-17 09:50:31 +08:00
fc33b3eb68
* docs: transfer AstrBotDevs/AstrBot-docs to AstrBotDevs/AstrBot * refactor: reorder imports and improve type hints in sync_docs_to_wiki.py and upload_doc_images_to_r2.py * feat: add GitHub Actions workflow to sync wiki with documentation Co-authored-by: Soulter <37870767+Soulter@users.noreply.github.com> Co-authored-by: anka-afk <110004162+anka-afk@users.noreply.github.com> Co-authored-by: zouyonghe <62183434+zouyonghe@users.noreply.github.com> Co-authored-by: shuiping233 <49360196+shuiping233@users.noreply.github.com> Co-authored-by: LIghtJUNction <106986785+LIghtJUNction@users.noreply.github.com> Co-authored-by: Sjshi763 <179909421+Sjshi763@users.noreply.github.com> Co-authored-by: xiewoc <70128845+xiewoc@users.noreply.github.com> Co-authored-by: QingFeng-awa <151742581+QingFeng-awa@users.noreply.github.com> Co-authored-by: PaloMiku <96452465+PaloMiku@users.noreply.github.com> Co-authored-by: shangxueink <138397030+shangxueink@users.noreply.github.com> Co-authored-by: IGCrystal-A <244300990+IGCrystal-A@users.noreply.github.com> Co-authored-by: RC-CHN <67079377+RC-CHN@users.noreply.github.com> Co-authored-by: MC090610 <113341105+MC090610@users.noreply.github.com> Co-authored-by: Waterwzy <196913419+Waterwzy@users.noreply.github.com> Co-authored-by: Lanhuace-Wan <186303160+Lanhuace-Wan@users.noreply.github.com> Co-authored-by: LiAlH4qwq <61769640+LiAlH4qwq@users.noreply.github.com> Co-authored-by: HSOS6 <209910899+HSOS6@users.noreply.github.com> Co-authored-by: th-dd <162813557+th-dd@users.noreply.github.com> Co-authored-by: miaoxutao123 <81676466+miaoxutao123@users.noreply.github.com> Co-authored-by: nuomicici <143102889+nuomicici@users.noreply.github.com> Co-authored-by: nasyt233 <210103278+nasyt233@users.noreply.github.com> Co-authored-by: jlugjb <7426462+jlugjb@users.noreply.github.com> Co-authored-by: Raven95676 <176760093+Raven95676@users.noreply.github.com> Co-authored-by: Futureppo <180109455+Futureppo@users.noreply.github.com> Co-authored-by: MliKiowa <61873808+MliKiowa@users.noreply.github.com> Co-authored-by: Fridemn <150212937+Fridemn@users.noreply.github.com> Co-authored-by: BakaCookie520 <138355736+BakaCookie520@users.noreply.github.com> Co-authored-by: YumeYuka <125112916+YumeYuka@users.noreply.github.com> Co-authored-by: xming521 <32786500+xming521@users.noreply.github.com> Co-authored-by: ywh555hhh <121592812+ywh555hhh@users.noreply.github.com> Co-authored-by: stevessr <89645372+stevessr@users.noreply.github.com> Co-authored-by: roeseth <41995115+roeseth@users.noreply.github.com> Co-authored-by: ikun-1145141 <265925499+ikun-1145141@users.noreply.github.com> Co-authored-by: evpeople <54983536+evpeople@users.noreply.github.com> Co-authored-by: Yue-bin <60509781+Yue-bin@users.noreply.github.com> Co-authored-by: W1ndys <109416673+W1ndys@users.noreply.github.com> Co-authored-by: TheFurina <218887821+TheFurina@users.noreply.github.com> Co-authored-by: Seayon <12275933+Seayon@users.noreply.github.com> Co-authored-by: OnlyblackTea <38585636+OnlyblackTea@users.noreply.github.com> Co-authored-by: ocetars <74854972+ocetars@users.noreply.github.com> Co-authored-by: railgun19457 <117180744+railgun19457@users.noreply.github.com> Co-authored-by: JunieXD <107397009+JunieXD@users.noreply.github.com> Co-authored-by: advent259141 <197440256+advent259141@users.noreply.github.com> Co-authored-by: Doge2077 <91442300+Doge2077@users.noreply.github.com> Co-authored-by: Bocity <23430545+Bocity@users.noreply.github.com> Co-authored-by: Aurora-xk <192227833+Aurora-xk@users.noreply.github.com>
79 lines
2.8 KiB
Markdown
79 lines
2.8 KiB
Markdown
# Connect AstrBot to WeChat Official Account Platform
|
|
|
|
AstrBot supports WeChat Official Account integration (version >= v3.5.8). After setup, you can chat with AstrBot directly in the WeChat Official Account chat interface.
|
|
|
|
## Before You Start
|
|
|
|
1. Open AstrBot Dashboard.
|
|
2. Click `Bots` in the left sidebar.
|
|
3. Click `+ Create Bot`.
|
|
4. Select `weixin_official_account`.
|
|
|
|
A configuration dialog will appear. Keep it open and continue.
|
|
|
|
## Create / Sign In to WeChat Official Account Platform
|
|
|
|
Open [WeChat Official Account Platform](https://mp.weixin.qq.com/).
|
|
|
|
- If you already have an account, sign in.
|
|
- If not, register a new account and choose `Official Account`.
|
|
|
|
> [!NOTE]
|
|
> A newly registered account may require 1-2 days for review before it can be used.
|
|
|
|
## Configure Callback Service
|
|
|
|
Open `Settings & Development` -> `Development Interface Management`.
|
|
|
|
|
|
|
|
Copy AppID and AppSecret from WeChat platform to AstrBot fields `appid` and `secret`.
|
|
|
|
Open IP whitelist and add your public IP(s), one per line if multiple.
|
|
|
|
In server configuration, click modify.
|
|
|
|
- `Token`: create any string with length 3-32, and fill the same value in AstrBot `token`.
|
|
- `EncodingAESKey`: click random generate and fill AstrBot `encoding_aes_key`.
|
|
|
|
Keep `Unified Webhook Mode (unified_webhook_mode)` enabled (recommended), then save AstrBot config and wait for restart.
|
|
|
|
For `URL`:
|
|
|
|
- If unified mode is enabled, use the unique callback URL generated by AstrBot (from logs or bot card).
|
|
- If unified mode is disabled, use `http://<your-domain>/callback/command`.
|
|
|
|
|
|
|
|
> [!NOTE]
|
|
> WeChat Official Account callback supports only ports 80 or 443. You usually need a domain and reverse proxy:
|
|
> - Unified mode enabled: forward to AstrBot port `6185`
|
|
> - Unified mode disabled: forward to adapter port `6194`
|
|
|
|
Set message encryption mode to `Security Mode`.
|
|
|
|
Wait a moment and click `Submit`. If configuration is correct, you will see success.
|
|
|
|
## Test
|
|
|
|
In WeChat Official Account platform, open account profile and find your QR code.
|
|
|
|
Scan it with WeChat, send `help`, and check whether AstrBot replies.
|
|
|
|
If it replies, integration is successful.
|
|
|
|
> [!NOTE]
|
|
> If console shows `ip xxxxx not in whitelist`, your public IP is not in WeChat whitelist yet. Add it and wait a few minutes for WeChat to refresh.
|
|
|
|
## Reverse Proxy (Custom API Base)
|
|
|
|
AstrBot supports custom endpoint via `api_base_url` for environments without stable public IP.
|
|
|
|
## Voice Input
|
|
|
|
Install `ffmpeg` for voice input support.
|
|
|
|
- Linux: `apt install ffmpeg`
|
|
- Windows: download from [FFmpeg website](https://ffmpeg.org/download.html)
|
|
- macOS: `brew install ffmpeg`
|