Telegraf Wire Tapper

Telegraf middleware for those who tired to read over9000 unread chat messages and prefer to listen it as a podcast.

Installation

$ npm install telegraf-wiretapper

Usage

Yandex SpeechKit cloud API

This middleware uses Yandex SpeechKit to synthesize messages. You should have Yandex cloud account to access API. Middleware configuration requires Yandex cloud folder id and access key. Please follow official documentation to setup it properly.

FFmpeg

Your bot host should have FFmpeg installed.

Session

The middleware usess Telegraf session object as a storage. You can choose any implementation to make it statefull.

Important: use chat id as a session key (see bot example below).

Bot example

import Telegraf, { ContextMessageUpdate } from 'telegraf';
import { WireTapper, Configuration } from 'telegraf-wiretapper';
import LocalSession from 'telegraf-session-local';

const botToken = process.env.BOT_TOKEN || 'your bot token';
const config: Configuration = {
  playCommand: 'play',
  yandexCloud: {
    accessKey: process.env.YANDEX_CLOUD_ACCESS_KEY || 'Yandex cloud access key',
    folderId: process.env.YANDEX_CLOUD_FOLDER_ID || 'Yandex cloud folder'
  }
};

const localSession = new LocalSession(
  {
    getSessionKey: (ctx: ContextMessageUpdate) => ctx.chat!.id
  }
)

const bot = new Telegraf(botToken);
const wireTapper = new WireTapper(config);

bot.use(
  localSession.middleware(),
  wireTapper.middleware()
);

bot.launch();

Docker example

Below is Dockerfile I used to run it:

FROM node
RUN apt-get update && apt-get install -y ffmpeg

WORKDIR /usr/src/app

COPY package*.json ./
RUN npm install
COPY . .
CMD [ "npm", "start" ]

then run it using command:

docker run <your bot image> -d --env BOT_TOKEN=<your bot token> --env YANDEX_CLOUD_FOLDER_ID=<id of Yandex cloud folder> --env YANDEX_CLOUD_ACCESS_KEY=<Yandex cloud access key>