hubot-adapter-telegram

Hubot Telegram Adapter

Hubot adapter for interfacing with the Telegram Bot API

Installation & Usage

First of read the docs on how to create a new Telegram Bot. Once you have a bot created, follow these steps:

• npm install --save hubot-adapter-telegram
• Set the environment variables specified in Configuration
• Run hubot bin/hubot -a adapter-telegram

Configuration

This adapter uses the following environment variables:

Env variable	Description	Default	Required
TELEGRAM_TOKEN	The token that the BotFather gives you		yes
TELEGRAM_WEBHOOK	You can specify a webhook URL. The adapter will register TELEGRAM_WEBHOOK/TELEGRAM_TOKEN with Telegram and listen there.		no
TELEGRAM_INTERVAL	You can specify the interval (in milliseconds) in which the adapter will poll Telegram for updates. This option only applies if you are not using a webhook.	2000	no
TELEGRAM_WEBHOOK_PORT	creates webserver on this port when webhook is enabled	8443	no
TELEGRAM_WEBHOOK_CERT	if passed with TELEGRAM_WEBHOOK_KEY creates https server		no
TELEGRAM_WEBHOOK_KEY	if passed with TELEGRAM_WEBHOOK_CERT creates https server		no
TELEGRAM_WEBHOOK_CA	if passed with TELEGRAM_WEBHOOK posts this as public key to telegram allowing for self-signed certificates		no

Telegram Specific Functionality (ie. Stickers, Images)

If you want to create a script that relies on specific Telegram functionality that is not available to Hubot normall, you can do so by emitting the telegram:invoke event in your script:

 
module.exports = function (robot) {
    robot.hear(/send sticker/i, function (res) {
        # https://core.telegram.org/bots/api#sendsticker
        robot.emit('telegram:invoke', 'sendSticker', chat_id, 'sticker_id', function (error, response) {
            console.log(error);
            console.log(response);
        });
    });
};
 

Note: An example script of how to use this is located in the example/ folder

If you want to supplement your message delivery with extra features such as markdown syntax or keyboard replies, you can specify these settings on the res.envelope variable in your plugin.

 
robot.respond(/(.*)/i, function (res) {
    res.envelope.telegram = { reply_markup: { keyboard: [["test"]] }}
 
    res.reply("Select the option from the keyboard specified.");
};
 

Note: Markdown will automatically be parsed if the supported markdown characters are included. You can override this by specifying the parse_mode value in the envelope.telegram key.

Contributors

• Vitaly Aminev - https://github.com/avvs
• Luke Simone - https://github.com/lukefx
• Chris Brand - https://github.com/arcturial