ContextQMD
Back to Astrbot

Connect QQ via QQ Official Bot (Websockets)

docs/en/platform/qqofficial/websockets.md

4.26.04.2 KB
Original Source

Connect QQ via QQ Official Bot (Websockets)

Supported Basic Message Types

Version v4.19.6.

Message TypeReceiveSendNotes
TextYesYes
ImageYesYes
VoiceYesYes
VideoYesYes
FileYesYes

Proactive message push: Supported.

Create a QQ Bot in AstrBot with One-click QR Setup (Recommended)

Setup Flow

  1. In AstrBot WebUI, click Bots in the left sidebar, then click + Create Bot.
  2. Select QQ Official Bot (WebSocket).
  3. Under Choose setup method, select One-click QR setup, click start, then scan the QR code with mobile QQ.
  4. After you confirm the QR binding, AstrBot automatically fills in AppID and AppSecret. Make sure Enable is checked, then click Save.
  5. Back on the QQ Open Platform page, click Scan QR Code to Chat next to your bot, then scan with your mobile QQ to start chatting.

Use in Group Chats

Add to a Group Chat

Open the created QQ bot profile page (mobile QQ -> Contacts -> Bots tab). You can find Add to group chat near the bottom. Currently, the bot can only be added to groups where you are the group owner.

Set Message Access Scope and Proactive Speaking

In mobile QQ group settings, open the bot settings page. We recommend setting Messages the bot can access to All group messages, and enabling Allow the bot to proactively speak in the group.

With this configuration, the bot can receive full group messages and proactively push messages to the group, such as scheduled task notifications and plugin notifications.

Manually Apply for a QQ Bot (Not Recommended)

Apply for a Bot

[!WARNING]

  1. QQ Official Bot currently requires an IP whitelist.
  2. It supports group chat, private chat, channel chat, and channel private chat.

Open QQ Official Bot and sign in.

Create a bot, fill in name/description/avatar, then submit for review. After security verification passes, creation is complete.

Open the created bot to enter its management page:

Allow Bot in Channel / Group / Private Chat

Open Sandbox Configuration to set a sandbox channel / QQ group / QQ private chat (up to 20 members).

Then configure QQ groups, private chat QQ accounts, and QQ channels as needed.

Get appid and secret

After adding the bot where you need it, open Development -> Development Settings, then copy appid and secret.

If you use AstrBot WebUI's One-click QR setup, you can skip this step. AstrBot fills in appid and secret automatically after QR binding succeeds.

Add IP Whitelist

Open Development -> Development Settings, find IP whitelist, and add your server IP.

[!TIP] If you do not know your server IP, run curl ifconfig.me or check ip138.com.

In NAT environments without a public IP, the observed IP may change depending on your carrier. Use proxy/tunnel if needed.

Configure in AstrBot

  1. Open AstrBot Dashboard.
  2. Click Bots in the left sidebar.
  3. Click + Create Bot.
  4. Select qq_official.

Recommended: use One-click QR setup.

  1. Under Choose setup method, select One-click QR setup.
  2. Click start, then scan and confirm the QR code with mobile QQ.
  3. Wait until the page shows binding success. AstrBot fills in appid and secret automatically.
  4. Adjust ID, Enable group/C2C message list, Enable guild direct message, and other options as needed, then click Save.

If QR setup is unavailable, choose Manual setup and fill in:

  • ID (id): any unique identifier.
  • Enable (enable): checked.
  • appid: from QQ Official Bot platform.
  • secret: from QQ Official Bot platform.
  • Enable group/C2C message list (enable_group_c2c): keep enabled if you need QQ message-list private chat.
  • Enable guild direct message (enable_guild_direct_message): keep enabled if you need guild direct messages.

Click Save.