Telegram Bot Bootstrap

Bot

Telegram API

Methods

Properties

npm version Build Status Dependency Status

A bootstrap for Telegram bot with directly deployable sample bot and JS-wrapped API methods.

See the full API documentation of this project.

Installation

If you wish to use only the wrapped Telegram API, do either of

npm install telegram-bot-bootstrap
git clone https://github.com/kengz/telegram-bot-bootstrap.git

Either way you’ll get a module with the Telegram bot API wrapped in Node, and a bootstrapped, deploy-ready project.

If you haven’t already, get a bot from BotFather and remember your bot token!

Features

Usage: only the API

See the full API documentation of this project.

API.js contains the Telegram Bot API wrapped in Node. The methods will return a promise for easy chaining, and will take either a whole JSON, or multiple parameters for convenience. For the latter, everything will be serialized properly for you to send over a HTTP POST method.

If you wish to use just the API or test the bot methods, here’s an example

var bot = require('telegram-bot-bootstrap');

var Alice = new bot(token);

Alice.getUpdates().then(console.log)
// → you'll see an update message. Look for your user_id in "message.from.id"

// Once you get your id to message yourself, you may:
Alice.sendMessage(your-id, "Hello there")
// → you'll receive a message from Alice.
.then(console.log)
// → optional, will log the successful message sent over HTTP

Usage: Bootstrapped, Deployable Bot

We distinguish the bot from the API: bot.js extends API.js, and will be the deployed component.

This whole project is bootstrapped and deploy-ready: all the details of HTTP and server stuff taken care of for you. I deploy this git project onto my Heroku and voila, my bot is alive.

Setup

In addition to the token, you’ll need a webhookUrl. If you deploy your Node app to Heroku, then the webhookUrl is simply your Heroku site url. Set both of them in the .env file:

TIMES=2
PORT=8443
TOKEN=your-Telegram-bot-token
WEBHOOK=your-webhook-url

The sample available is an echo-bot. To make your bot do interesting stuff, head over to bot.js, under the handle method, start writing your own from below the Extend from here comment.

The bot inherits all the API methods, so you can simply call them for example by this.sendMessage.

Deployment

The server is deployed in index.js, and a bot is constructed to handle all HTTP POST calls from Telegram.

I use Heroku. This shall work for any other services too. Once I’m done setting up, I do:

git push heroku master

And done. Start talking to the bot.

API documentation

“Bot” Methods

handle(req, res)

# Ⓢ Ⓣ

Handles a Telegram Update object sent from the server. Extend this method for your bot.

Arguments

  1. req (Object): The incoming HTTP request.
  2. res (Object): The HTTP response in return.

Returns

(Promise): promise A promise returned from calling Telegram API method(s) for chaining.

Example

var bot1 = new bot('yourtokenhere');
...express server setup
app.route('/')
// robot API as middleware
.post(function(req, res) {
    bot1.handle(req, res)
})
// Then bot will handle the incoming Update from you, routed from Telegram!

“Telegram API” Methods

forwardMessage(first, from_chat_id, message_id)

# Ⓢ Ⓣ

Use this method to forward messages of any kind.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. from_chat_id (integer): Unique identifier for the chat where the original message was sent — User or GroupChat id.
  3. message_id (integer): Unique message identifier

Returns

(string): HTTPres On success, the sent Message is returned.

Example

forwardMessage(87654321, 12345678, 87654356)
// → Message is forwarded

getMe()

# Ⓢ Ⓣ

A simple method for testing your bot’s auth token. Requires no parameters.

Returns

(string): HTTPres Basic information about the bot in form of a User object.

getUpdates([first|offset], [limit], [timeout])

# Ⓢ Ⓣ

Use this method to receive incoming updates using long polling (wiki).

Arguments

  1. [first|offset] (JSON|integer): An optional JSON object with the parameters, or the offset integer
  2. [limit] (integer):
  3. [timeout] (integer):

Returns

(string): HTTPres An Array of Update objects is returned.

Example

getUpdates().then(console.log)
// → {"ok":true,"result":[{"update_id":1234567, "message":{"message_id":1,"from":{"id":87654321, ...}}]

getUserProfilePhotos(first, [offset], [limit])

# Ⓢ Ⓣ

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

Arguments

  1. first (JSON|integer): Your own JSON object, or user_id: Unique identifier of the target user.
  2. [offset] (integer): Sequential number of the first photo to be returned. By default, all photos are returned.
  3. [limit] (integer): Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.

Returns

(string): HTTPres Returns a UserProfilePhotos object.

sendAudio(first, audio, [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. audio (inputFile|string): Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.
  3. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  4. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

sendChatAction(first, action)

# Ⓢ Ⓣ

Use this method when you need to tell the user that something is happening on the bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id..
  2. action (string): Type of action to broadcast. Choose one, depending on what the user is about to receive: 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.

Returns

(string): HTTPres On success, the sent Message is returned.

sendDocument(first, document, [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. document (inputFile|string): File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.
  3. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  4. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

sendLocation(first, latitude, longitude, [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send point on the map.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. latitude (number): Latitude of location
  3. longitude (number): Longitude of location
  4. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  5. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

sendMessage(first, text, [disable_web_page_preview], [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send text messages.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. text (string): Text of the message to be sent.
  3. [disable_web_page_preview] (boolean): Disables link previews for links in this message.
  4. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  5. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

Example

sendMessage({chat_id: 87654321, text: 'hello world'})
sendMessage(87654321, 'hello world') // equivalent, cleaner
// → 'hello world' is sent to the user with the id.

sendMessage(87654321, 'hello world', { keyboard: [['one', 'two'], ['three'], ['four']] })
// → 'hello world' is sent, with custom reply keyboard

sendPhoto(first, photo, [caption], [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send photos.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. photo (inputFile|string): Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.
  3. [caption] (string):
  4. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  5. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

Example

sendMessage(87654321, fs.createReadStream('localpath/to/photo.jpg'))
// → The photo on local system is sent to the id.

sendSticker(first, sticker, [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send .webp stickers.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. sticker (inputFile|string): Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data.
  3. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  4. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

sendVideo(first, video, [reply_to_message_id], [reply_markup])

# Ⓢ Ⓣ

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Arguments

  1. first (JSON|integer): Your own JSON object, or chat_id: Unique identifier for the message recipient — User or GroupChat id.
  2. video (inputFile|string): Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data.
  3. [reply_to_message_id] (integer): If the message is a reply, ID of the original message.
  4. [reply_markup] (KeyboardMarkup): Additional interface options. A JSON object (don’t worry about serializing; it’s handled) for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

(string): HTTPres On success, the sent Message is returned.

setWebhook(url)

# Ⓢ Ⓣ

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts.

Arguments

  1. url (string): A JSON object with the parameters, or the HTTPS url to send updates to. Use an empty string to remove webhook integration.

Returns

(string): HTTPres An Array of Update objects is returned.

Methods

Properties