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 (release / development)
• Examples (release / development)
• Help Information (release / development)
• 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.26.0][0.26.0] - 2017-01-20

Added:

1. Add TelegramBot constructor options:
   • options.https
   • options.baseApiUrl
   • options.filepath
2. Add methods:
   • TelegramBot#stopPolling()
   • TelegramBot#isPolling()
   • TelegramBot#openWebHook()
   • TelegramBot#closeWebHook()
   • TelegramBot#hasOpenWebHook()
   • TelegramBot#deleteWebHook()
   • TelegramBot#getWebHookInfo()

Changed:

1. Use POST requests by default
2. Ensure all relevant methods return Promises
3. Document auto-deletion of webhook during polling
4. Deprecate support for Node.js v0.12
5. Fix consistency of methods signatures
6. Rename TelegramBot#initPolling() to TelegramBot#startPolling()
   • Deprecate TelegramBot#initPolling()

Fixed:

1. Handle error during formatting formData
2. Fix ES6 syntax

Credits/Blames: Unless explicitly stated otherwise, above work was done by @GochoMugo

---