node-telegram-bot-api

环境要求

• 现代版本的 Node.js（Bun、Deno 亦可，README 声明均支持）
• 已安装 npm 包管理器
• 一个可用的 Telegram Bot Token，用于设置 BOT_TOKEN 环境变量
• 能正常访问 Telegram API 的网络环境

安装与启动步骤

1. 1检查运行环境

   确认已安装可用的现代版 Node.js；README 声明库也支持 Bun、Deno 等运行时。

   node -v

   复制

2. 2安装依赖

   在项目目录执行 README 给出的安装命令，把库本体装进项目。

   npm install node-telegram-bot-api

   复制

3. 3配置机器人令牌

   把 Bot Token 写入环境变量 BOT_TOKEN，因为示例代码从 process.env.BOT_TOKEN 读取。

   export BOT_TOKEN=123456789:AAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

   复制

4. 4编写入口代码

   把 README 的 Usage 示例保存为 bot.ts，包含命令、正则、消息和按钮回调。

   cat > bot.ts << 'EOF'
   import { Bot, InlineKeyboardBuilder } from "node-telegram-bot-api";
   import { run } from "node-telegram-bot-api/node"; // managed runner: wires Ctrl-C to bot.stop()
   
   const bot = new Bot(process.env.BOT_TOKEN!);
   
   // commands, regex and update types are all middleware - registration order wins
   bot.command("start", (ctx) => ctx.reply("Hi! Send me anything."));
   bot.hears(/echo (.+)/, (ctx) => ctx.reply(ctx.match![1]!));
   
   bot.on("message", (ctx) =>
     ctx.reply("Pick one:", {
       reply_markup: new InlineKeyboardBuilder()
         .text("", "up")
         .text("", "down")
         .build(),
     }),
   );
   
   // 点按 inline 按钮会以 callback_query 回来
   bot.on("callback_query", async (ctx) => {
     await ctx.answerCallbackQuery({ text: `You tapped ${ctx.callbackQuery!.data}` });
   });
   
   await run(bot);
   EOF

   复制

5. 5启动机器人

   用 Bun 运行入口文件；日志出现后机器人开始工作，Ctrl-C 即可停止。

   bun bot.ts

   复制

关键配置

如何确认成功

启动后终端无报错，在 Telegram 中给机器人发送 /start，能收到 “Hi! Send me anything.” 回复。

常见问题

注意事项

• v2 与 v1 完全不兼容，升级前务必先读 CHANGELOG 迁移指南。
• 命令、正则和 update 类型都按中间件处理，注册顺序决定执行顺序。
• BOT_TOKEN 请放在环境变量中，不要硬编码进源码。
• README 声明可运行于 Bun、现代 Node.js、Deno、Cloudflare Workers 和 Vercel Functions，具体服务器端用法请参考官方文档。