node-telegram-bot-api
<h1 align="center">Node.js Telegram Bot API</h1> <div align="center"> Node.js module to interact with the official [Telegram Bot API](https://core.telegram.org/bots/api). [](https://core.telegram.org/bots/api) [](https://www.npmjs.org/package/node-telegram-bot-api) [](https://codecov.io/gh/yagop/node-telegram-bot-api) [](https://telegram.me/node_telegram_bot_api) [](https://t.me/+_IC8j_b1wSFlZTVk) [](https://telegram.me/Yago_Perez) </div> ## 📦 Install ```sh npm i node-telegram-bot-api ``` <br/> > ✍️ **Note:** If you use Typescript you can install this package that contains type definitions for this library >```sh >npm install --save-dev @types/node-telegram-bot-api >``` ## 🚀 Usage ```js const TelegramBot = require('node-telegram-bot-api'); // replace the value below with the Telegram token you receive from @BotFather const token = 'YOUR_TELEGRAM_BOT_TOKEN'; // Create a bot that uses 'polling' to fetch new updates const bot = new TelegramBot(token, {polling: true}); // Matches "/echo [whatever]" bot.onText(/\/echo (.+)/, (msg, match) => { // 'msg' is the received Message from Telegram // 'match' is the result of executing the regexp above on the text content // of the message const chatId = msg.chat.id; const resp = match[1]; // the captured "whatever" // send back the matched "whatever" to the chat bot.sendMessage(chatId, resp); }); // Listen for any kind of message. There are different kinds of // messages. bot.on('message', (msg) => { const chatId = msg.chat.id; // send a message to the chat acknowledging receipt of their message bot.sendMessage(chatId, 'Received your message'); }); ``` ## 📚 Documentation * [Usage][usage] * [Examples][examples] * [Tutorials][tutorials] * [Help Information][help] * API Reference: ([api-release](../master/doc/api.md) / [development][api-dev] / [experimental][api-experimental]) * [Contributing to the Project][contributing] * [Experimental Features][experimental] _**Note**: Development is done against the **development** branch. Code for the latest release resides on the **master** branch. Experimental features reside on the **experimental** branch._ ## 💭 Community We thank all the developers in the Open-Source community who continuously take their time and effort in advancing this project. See our [list of contributors][contributors]. We have a [Telegram channel][tg-channel] where we post updates on the Project. Head over and subscribe! We also have a [Telegram group][tg-group] to discuss issues related to this library. Some things built using this library that might interest you: * [tgfancy](https://github.com/GochoMugo/tgfancy): A fancy, higher-level wrapper for Telegram Bot API * [node-telegram-bot-api-middleware](https://github.com/idchlife/node-telegram-bot-api-middleware): Middleware for node-telegram-bot-api * [teleirc](https://github.com/FruitieX/teleirc): A simple Telegram ↔ IRC gateway * [bot-brother](https://github.com/SerjoPepper/bot-brother): Node.js library to help you easily create telegram bots * [redbot](https://github.com/guidone/node-red-contrib-chatbot): A Node-RED plugin to create telegram bots visually * [node-telegram-keyboard-wrapper](https://github.com/alexandercerutti/node-telegram-keyboard-wrapper): A wrapper to improve keyboards structures creation through a more easy-to-see way (supports Inline Keyboards, Reply Keyboard, Remove Keyboard and Force Reply) * [beetube-bot](https://github.com/kodjunkie/beetube-bot): A telegram bot for music, videos, movies, EDM tracks, torrent downloads, files and more. * [telegram-inline-calendar](https://github.com/VDS13/telegram-inline-calendar): Date and time picker and inline calendar for Node.js telegram bots. * [telegram-captcha](https://github.com/VDS13/telegram-captcha): Telegram bot to protect Telegram groups from automatic bots. * [@toptl/node-telegram-bot-api](https://github.com/top-tl/node-telegram-bot-api): Plugin for TOP.TL, the Telegram directory. Auto-tracks bot stats and enables vote checking. ## 👥 Contributors <p align="center"> <a href="https://github.com/yagop/node-telegram-bot-api/graphs/contributors"> <img src="https://contrib.rocks/image?repo=yagop/node-telegram-bot-api" /> </a> </p> ## License **The MIT License (MIT)** Copyright © 2019 Yago [usage]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/usage.md [examples]:https://github.com/yagop/node-telegram-bot-api/tree/master/examples [help]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/help.md [tutorials]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/tutorials.md [api-dev]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/api.md [api-release]:https://github.com/yagop/node-telegram-bot-api/tree/release/doc/api.md [api-experimental]:https://github.com/yagop/node-telegram-bot-api/tree/experimental/doc/api.md [contributing]:https://github.com/yagop/node-telegram-bot-api/tree/master/CONTRIBUTING.md [contributors]:https://github.com/yagop/node-telegram-bot-api/graphs/contributors [experimental]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/experimental.md [tg-channel]:https://telegram.me/node_telegram_bot_api [tg-group]:https://t.me/+UTbprHdcw0JdZdbL