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.

npm install node-telegram-bot-api

var TelegramBot = require('node-telegram-bot-api'); var token = 'YOUR_TELEGRAM_BOT_TOKEN'; // Setup polling way var bot = new TelegramBot(token, {polling: true}); // Matches /echo [whatever] bot.onText(/\/echo (.+)/, function (msg, match) { var fromId = msg.from.id; var resp = match[1]; bot.sendMessage(fromId, resp); }); // Any kind of message bot.on('message', function (msg) { var chatId = msg.chat.id; // photo can be: a file path, a stream or a Telegram file_id var photo = 'cats.png'; bot.sendPhoto(chatId, photo, {caption: 'Lovely kittens'}); });

There are some other examples on examples.

Every time TelegramBot receives a message, it emits a message. Depending on which message was received, emits an event from this ones: text, audio, document, photo, sticker, video, voice, contact, location, new_chat_participant, left_chat_participant, new_chat_title, new_chat_photo, delete_chat_photo, group_chat_created. Its much better to listen a specific event rather than a message in order to stay safe from the content. TelegramBot emits inline_query when receives an Inline Query and chosen_inline_result when receives a ChosenInlineResult. Bot must be enabled on inline mode

Telegram only supports HTTPS connections to WebHooks, in order to set a WebHook a private key file and public certificate must be used. Since August 29, 2015 Telegram supports self signed ones, to generate them:

# Our private cert will be key.pem, keep in private this file. openssl genrsa -out key.pem 2048 # Our public certificate will be crt.pem openssl req -new -sha256 -key key.pem -out crt.pem

Once they are generated, the crt.pem can be provided to telegramBot.setWebHook(url, crt) as crt.

TelegramBot

Kind: global class
See: https://core.telegram.org/bots/api

• TelegramBot
  • new TelegramBot(token, [options])
  • .getMe() ⇒ Promise
  • .setWebHook(url, [cert])
  • .getUpdates([timeout], [limit], [offset]) ⇒ Promise
  • .sendMessage(chatId, text, [options]) ⇒ Promise
  • .answerInlineQuery(inlineQueryId, results, [options]) ⇒ Promise
  • .forwardMessage(chatId, fromChatId, messageId) ⇒ Promise
  • .sendPhoto(chatId, photo, [options]) ⇒ Promise
  • .sendAudio(chatId, audio, [options]) ⇒ Promise
  • .sendDocument(chatId, doc, [options]) ⇒ Promise
  • .sendSticker(chatId, sticker, [options]) ⇒ Promise
  • .sendVideo(chatId, video, [options]) ⇒ Promise
  • .sendVoice(chatId, voice, [options]) ⇒ Promise
  • .sendChatAction(chatId, action) ⇒ Promise
  • .getUserProfilePhotos(userId, [offset], [limit]) ⇒ Promise
  • .sendLocation(chatId, latitude, longitude, [options]) ⇒ Promise
  • .getFile(fileId) ⇒ Promise
  • .getFileLink(fileId) ⇒ Promise
  • .downloadFile(fileId, downloadDir) ⇒ Promise
  • .onText(regexp, callback)
  • .onReplyToMessage(chatId, messageId, callback)

Both request method to obtain messages are implemented. To use standard polling, set polling: true on options. Notice that webHook will need a SSL certificate. Emits message when a message arrives.

Returns basic information about the bot in form of a User object.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#getme

Specify an url to receive incoming updates via an outgoing webHook.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#setwebhook

Use this method to receive incoming updates using long polling

Kind: instance method of TelegramBot
Returns: Promise - Updates
See: https://core.telegram.org/bots/api#getupdates

Send text message.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendmessage

Send answers to an inline query.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#answerinlinequery

Forward messages of any kind.

Kind: instance method of TelegramBot

Send photo

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendphoto

Send audio

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendaudio

Send Document

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendDocument

Send .webp stickers.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendsticker

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendvideo

Send voice

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendvoice

Send chat action. typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendchataction

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#getuserprofilephotos

Send location. Use this method to send point on the map.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#sendlocation

Get file. Use this method to get basic info about a file and prepare it for downloading. Attention: link will be valid for 1 hour.

Kind: instance method of TelegramBot
See: https://core.telegram.org/bots/api#getfile

Get link for file. Use this method to get link for file for subsequent use. Attention: link will be valid for 1 hour.

This method is a sugar extension of the (getFile)[#getfilefileid] method, which returns just path to file on remote server (you will have to manually build full uri after that).

Kind: instance method of TelegramBot
Returns: Promise - promise Promise which will have fileURI in resolve callback
See: https://core.telegram.org/bots/api#getfile

Downloads file in the specified folder. This is just a sugar for (getFile)[#getfilefiled] method

Kind: instance method of TelegramBot
Returns: Promise - promise Promise, which will have filePath of downloaded file in resolve callback

Register a RegExp to test against an incomming text message.

Kind: instance method of TelegramBot

Register a reply to wait for a message response.

Kind: instance method of TelegramBot