chat-adapter-qq

chat-adapter-qq

基于 NapCat 的 Chat SDK QQ 适配器.

• 支持接入 QQ 群聊和私聊消息
• 支持发送文本消息, 撤回消息, 引用消息, 合并转发
• 支持发送图片, 视频, 音频, 文件等附件资源
• 支持渲染 QQ 消息内容到 markdown 格式 (包括图片, 引用消息, 合并转发消息等)
• 支持群聊消息贴表情和私聊输入状态
• 支持查询消息记录, 成员列表, 成员信息等元数据

安装

npm install chat chat-adapter-qq

快速开始

• 参考 NapCat 文档部署一个正向 WebSocket 服务端.

• 参考 node-napcat-ts 配置连接信息.

import { Chat } from 'chat';
import { createMemoryState } from '@chat-adapter/state-memory';
import { createQQAdapter } from 'chat-adapter-qq';

const bot = new Chat({
  userName: '',
  adapters: {
    qq: createQQAdapter({
      napcat: {
        protocol: 'wss',
        host: '<your napcat host>',
        port: 443,
        accessToken: '<your napcat access token>',
        // ↓ 自动重连 (可选)
        reconnection: {
          enable: true,
          attempts: 10,
          delay: 5000
        }
      }
    })
  },
  state: createMemoryState()
});

await bot.initialize();

bot.onNewMention(async (thread, message) => {
  bot.getLogger(thread.adapter.name).info('onNewMention', message);
  await thread.subscribe();
  await thread.post(`订阅频道: ${message.text}`);
});

bot.onSubscribedMessage(async (thread, message) => {
  bot.getLogger(thread.adapter.name).info('onSubscribedMessage', message);
  await thread.post(`收到消息: ${message.text}`);
});

功能示例

示例脚本见: examples/chat.ts.

1. 提及机器人后订阅 Thread

bot.onNewMention(async (thread, message) => {
  await thread.subscribe();
  await thread.post(`已开始监听当前会话: ${message.text}`);
});

2. 发送文本

bot.onSubscribedMessage(async (thread, message) => {
  await thread.post(`收到消息: ${message.text}`);
});

3. 发送引用消息和合并转发

bot.onSubscribedMessage(async (thread, message) => {
  await thread.post({
    reply: message.id,
    markdown: `@${message.author.userId} 收到`
  });

  await thread.post({
    forward: thread.recentMessages.slice(-3).map((item) => item.id),
    markdown: ''
  });
});

4. 发送图片 / 音视频 / 文件

import fs from 'node:fs';
import path from 'node:path';

const filename = 'assets/avatar.jpeg';

bot.onSubscribedMessage(async (thread, message) => {
  await thread.post({
    markdown: '本地文件上传',
    files: [
      {
        data: await fs.promises.readFile(filename),
        filename: path.basename(filename),
        mimeType: 'image/jpeg'
      }
    ]
  });
});

5. 读取解析后的消息内容

收到的 QQ 消息会被统一解析成 text、formatted 和 attachments.

QQ 适配器会处理文本, @提及, 图片, 文件, 视频, 音频, 引用消息, 消息合并转发等格式.

import { stringifyMarkdown } from 'chat';

bot.onSubscribedMessage(async (_thread, message) => {
  console.log('plain text:', message.text);
  console.log('markdown:', stringifyMarkdown(message.formatted));
  console.log('attachments:', message.attachments);
});

6. 读取消息中的图片等附件资源

收到消息后,可以直接读取 message.attachments.

bot.onSubscribedMessage(async (_thread, message) => {
  for (const attachment of message.attachments) {
    console.log(attachment.type, attachment.name, attachment.url, attachment.size);
  }
});

QQ 适配器额外提供了 refreshAttachment 方法, 用于在附件链接过期时可以重新获取资源.

const adapter = bot.getAdapter('qq');

bot.onSubscribedMessage(async (_thread, message) => {
  for (const attachment of message.attachments) {
    const refreshed = await adapter.refreshAttachment(attachment);
    console.log('old url:', attachment.url);
    console.log('new url:', refreshed.url);
  }
});

如果你有持久化消息需求, 应该完整保存 attachment 对象, 以调用 refreshAttachment 方法获取新的资源临时链接.

const adapter = bot.getAdapter('qq');

const attachment = {
  type: 'image',
  name: 'image.png',
  url: 'https://example.com/image.png',
  size: 12,
  qq: {
    kind: 'image',
    file: '...'
  }
};

const refreshed = await adapter.refreshAttachment(attachment);

7. 表情回应和输入状态

import { emoji } from 'chat';

const adapter = bot.getAdapter('qq');

bot.onSubscribedMessage(async (thread, message) => {
  await thread.startTyping('typing');

  await adapter.addReaction(thread.id, message.id, emoji.thumbs_up);

  await adapter.removeReaction(thread.id, message.id, '128077');
});

8. 查询历史消息

const adapter = bot.getAdapter('qq');

const latest = await adapter.fetchMessages('qq:group:30003', { limit: 20 });
console.log(latest.messages.map((item) => [item.id, item.text]));

if (latest.nextCursor) {
  const older = await adapter.fetchMessages('qq:group:30003', {
    limit: 20,
    cursor: latest.nextCursor
  });
  console.log(older.messages.map((item) => [item.id, item.text]));
}

9. 查询会话 / 成员 / 私聊

const adapter = bot.getAdapter('qq');

const threadInfo = await adapter.fetchThread('qq:group:30003');
const members = await adapter.fetchThreadMembers('qq:group:30003');
const member = await adapter.fetchThreadMember('qq:group:30003', '20002');
const dmThreadId = await adapter.openDM('20002');

console.log(threadInfo.channelName);
console.log(members.length);
console.log(member?.userName);
console.log(dmThreadId); // qq:private:20002

引用

• NapCatQQ: 现代化的基于 NTQQ 的 Bot 协议端实现.
• node-napcat-ts: 由 Typescript 编写的 NapcatQQ SDK.
• Chat SDK: A unified TypeScript SDK for building chat bots across Slack, Microsoft Teams, Google Chat, Discord, and more. Write your bot logic once, deploy everywhere.

开源协议

MIT License © 2026 XLor