node-telegram-bot-api

Node.js Telegram Bot API

Node.js module to interact with official Telegram Bot API. A bot token is needed, to obtain one, talk to @botfather and create a new bot.

Install

npm install --save node-telegram-bot-api

Usage

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
• Examples
• Help Information
• API Reference (release / development)
• Contributing to the Project

Note: Development is done against the master branch. Code for the latest release resides on the release branch.

Community

We have a Telegram channel where we post updates on the Project. Head over and subscribe!

Some things built using this library, and might interest you:

• tgfancy: A Fancy, Higher-Level Wrapper for Telegram Bot API
• node-telegram-bot-api-middleware: Middleware for node-telegram-bot-api
• teleirc: A simple Telegram ↔ IRC gateway
• bot-brother: Node.js library to help you easily create telegram bots

License

The MIT License (MIT)

Copyright (c) 2017 Yago

Changelog

[0.27.1][0.27.1] - 2017-04-07

Added:

1. (#287) Add Express WebHook example (by @kamikazechaser)

Fixed:

1. (#291) Improve docs (by @preco21)
2. (#298) Fix running on Node v5 (by @jehy)
3. (#307) Fix badge links in README (by @JaakkoLipsanen)
4. Fix defaulting value of options.polling.params.timeout (by @GochoMugo)
5. Fix typos in Github issue template (by @GochoMugo, requested-by @GingerPlusPlus)

---