e75d51ca8f
Feature: Please see the updated API reference for more information on this new option. Side-effects: * `options.timeout` is deprecated! References: * "Feature request": https://github.com/yagop/node-telegram-bot-api/issues/243
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