node-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.

Installation:

npm install node-telegram-bot-api

Sample Usage:

var TelegramBot = require('node-telegram-bot-api');

// replace the value below with the Telegram token you receive from @BotFather
var token = 'YOUR_TELEGRAM_BOT_TOKEN';

// Create a bot that uses 'polling' to fetch new updates
var bot = new TelegramBot(token, { polling: true });

// Matches "/echo [whatever]"
bot.onText(/\/echo (.+)/, function (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

  var chatId = msg.chat.id;
  var 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', function (msg) {
  var 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.

---

Our 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

---

License Information

The MIT License (MIT)

Copyright (c) 2015 Yago

Changelog

[0.27.0][0.27.0] - 2017-02-10

Added:

1. Add constructor options:
   • (#243) options.polling.params (by @GochoMugo, requested-by @sidelux)
2. Add methods:
   • (#74) TelegramBot#removeReplyListener() (by @githugger)
3. (#283) Add proper error handling (by @GochoMugo)
4. (#272) Add health-check endpoint (by @mironov)
   • options.webHook.healthEndpoint
5. (#152) Add test for TelegramBot#sendDocument() using 'fileOpts' param (by @evolun)
6. Document options.webHook.host (by @GochoMugo)
7. (#264) Add Bot API version to README (by @kamikazechaser)
8. Add examples:
   • (#271) WebHook on Heroku (by @TheBeastOfCaerbannog)
   • (#274) WebHook on Zeit Now (by @Ferrari)

Changed:

1. (#147) Use String#indexOf(), instead of RegExp#test(), to find token in webhook request (by @AVVS)

Fixed:

• Fix bug:
  • (#275, #280) fix es6 syntax error on Node.js v4.x (by @crazyabdul)
  • (#276) promise.warning from request-promise (by @GochoMugo, reported-by @preco21)
  • (#281) fix handling error during polling (by @GochoMugo, reported-by @dimawebmaker)
  • (#284) fix error during deletion of already-set webhook, during polling (by @GochoMugo, reported-by @dcparga)

1. Fix links in documentation (by @Ni2c2k)

---