QQ Bot

QQ Bot

Connect Hermes to QQ via the Official QQ Bot API (v2) — supporting private (C2C), group @-mentions, guild, and direct messages with voice transcription.

Overview

The QQ Bot adapter uses the Official QQ Bot API to:

• Receive messages via a persistent WebSocket connection to the QQ Gateway
• Send text and markdown replies via the REST API
• Download and process images, voice messages, and file attachments
• Transcribe voice messages using Tencent’s built-in ASR or a configurable STT provider

Prerequisites

1. QQ Bot Application — Register at q.qq.com:

   • Create a new application and note your App ID and App Secret
   • Enable the required intents: C2C messages, Group @-messages, Guild messages
   • Configure your bot in sandbox mode for testing, or publish for production

2. Dependencies — The adapter requires aiohttp and httpx:

   pip install aiohttp httpx

Configuration

Interactive setup

hermes gateway setup

Select QQ Bot from the platform list and follow the prompts.

Manual configuration

Set the required environment variables in ~/.hermes/.env:

QQ_APP_ID=your-app-id
QQ_CLIENT_SECRET=your-app-secret

Environment Variables

Variable	Description	Default
QQ_APP_ID	QQ Bot App ID (required)	—
QQ_CLIENT_SECRET	QQ Bot App Secret (required)	—
QQBOT_HOME_CHANNEL	OpenID for cron/notification delivery	—
QQBOT_HOME_CHANNEL_NAME	Display name for home channel	Home
QQ_ALLOWED_USERS	Comma-separated user OpenIDs for DM access	open (all users)
QQ_GROUP_ALLOWED_USERS	Comma-separated group OpenIDs for group access	—
QQ_ALLOW_ALL_USERS	Set to true to allow all DMs	false
QQ_PORTAL_HOST	Override the QQ portal host (set to sandbox.q.qq.com for sandbox routing)	q.qq.com
QQ_STT_API_KEY	API key for voice-to-text provider	—
QQ_STT_BASE_URL	Base URL for STT provider	https://open.bigmodel.cn/api/coding/paas/v4
QQ_STT_MODEL	STT model name	glm-asr

Advanced Configuration

For fine-grained control, add platform settings to ~/.hermes/config.yaml:

platforms:
  qq:
    enabled: true
    extra:
      app_id: "your-app-id"
      client_secret: "your-secret"
      markdown_support: true       # enable QQ markdown (msg_type 2). Config-only; no env-var equivalent.
      dm_policy: "open"          # open | allowlist | disabled
      allow_from:
        - "user_openid_1"
      group_policy: "open"       # open | allowlist | disabled
      group_allow_from:
        - "group_openid_1"
      stt:
        provider: "zai"          # zai (GLM-ASR), openai (Whisper), etc.
        baseUrl: "https://open.bigmodel.cn/api/coding/paas/v4"
        apiKey: "your-stt-key"
        model: "glm-asr"

Voice Messages (STT)

Voice transcription works in two stages:

1. QQ built-in ASR (free, always tried first) — QQ provides asr_refer_text in voice message attachments, which uses Tencent’s own speech recognition

2. Configured STT provider (fallback) — If QQ’s ASR doesn’t return text, the adapter calls an OpenAI-compatible STT API:

   • Zhipu/GLM (zai): Default provider, uses glm-asr model
   • OpenAI Whisper: Set QQ_STT_BASE_URL and QQ_STT_MODEL
   • Any OpenAI-compatible STT endpoint

Troubleshooting

Bot disconnects immediately (quick disconnect)

This usually means:

• Invalid App ID / Secret — Double-check your credentials at q.qq.com
• Missing permissions — Ensure the bot has the required intents enabled
• Sandbox-only bot — If the bot is in sandbox mode, it can only receive messages from QQ’s sandbox test channel

Voice messages not transcribed

1. Check if QQ’s built-in asr_refer_text is present in the attachment data
2. If using a custom STT provider, verify QQ_STT_API_KEY is set correctly
3. Check gateway logs for STT error messages

Messages not delivered

• Verify the bot’s intents are enabled at q.qq.com
• Check QQ_ALLOWED_USERS if DM access is restricted
• For group messages, ensure the bot is @mentioned (group policy may require allowlisting)
• Check QQBOT_HOME_CHANNEL for cron/notification delivery

Connection errors

• Ensure aiohttp and httpx are installed: pip install aiohttp httpx
• Check network connectivity to api.sgroup.qq.com and the WebSocket gateway
• Review gateway logs for detailed error messages and reconnect behavior