# hubot-adapter-telegram

> Hubot adapter for Telegram

Latest version **0.2.0** (published 2016-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install hubot-adapter-telegram
pnpm add hubot-adapter-telegram
yarn add hubot-adapter-telegram
bun add hubot-adapter-telegram
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-06-12 |
| First published | 2016-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Vitaly Aminev |
| Maintainers | avvs |
| Keywords | hubot, adapter, telegram, telegram hubot, hubot telegram |

## Links

- npm: https://www.npmjs.com/package/hubot-adapter-telegram
- Repository: https://github.com/makeomatic/hubot-telegram
- Issues: https://github.com/makeomatic/hubot-telegram/issues
- npm.io page: https://npm.io/package/hubot-adapter-telegram

## Dependencies (2)

- [bluebird](https://npm.io/package/bluebird.md) ^3.4.0
- [node-telegram-bot-api](https://npm.io/package/node-telegram-bot-api.md) ^0.23.3

## Recent versions

- 0.2.0 (latest) — 2016-06-12
- 0.1.8 — 2016-06-12
- 0.1.7 — 2016-06-11
- 0.1.6 — 2016-06-07
- 0.1.4 — 2016-06-07
- 0.1.3 — 2016-06-07
- 0.1.2 — 2016-06-06
- 0.1.1 — 2016-06-06
- 0.1.0 — 2016-06-06

## README

# Hubot Telegram Adapter

[Hubot](https://hubot.github.com/docs/) adapter for interfacing with the [Telegram Bot API](https://core.telegram.org/bots/api)

## Installation & Usage

First of read the docs on how to create a new [Telegram Bot](https://core.telegram.org/bots#botfather). 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](https://core.telegram.org/bots#botfather) gives you | | yes |
| TELEGRAM_WEBHOOK | You can specify a [webhook](https://core.telegram.org/bots/api#setwebhook) 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](https://core.telegram.org/bots/api#setwebhook). | 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:

``` nodejs

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.

``` nodejs

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](https://github.com/avvs)
* Luke Simone - [https://github.com/lukefx](https://github.com/lukefx)
* Chris Brand - [https://github.com/arcturial](https://github.com/arcturial)

---
_Source: https://npm.io/package/hubot-adapter-telegram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
