Skip to content

nspacestd/hubot-telegram

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hubot Telegram Adapter

Build Status

Hubot adapter for interfacting 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-telegram
  • Set the environment variables specified in Configuration
  • Run hubot bin/hubot -a telegram

Configuration

This adapter uses the following environment variables:

TELEGRAM_TOKEN (required)

The token that the BotFather gives you

TELEGRAM_WEBHOOK (optional)

You can specify a webhook URL which the adapter will register with Telegram. This URL will receive updates from Telegram. The adapter automatically registers an endpoint with Hubot at http://your-hobot-host/hubot/telegram/receive.

TELEGRAM_INTERVAL (optional)

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.

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: xxx, sticker: '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

Contributors

About

Hubot adapter for Telegram

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 51.3%
  • JavaScript 48.7%