Skip to content

Main NavigationGuide

Guide

Getting Started

Sending and Receiving Messages

Filter Queries and bot.on()

Long Polling vs. Webhooks

Advanced

Middleware Redux

Scaling Up I: Large Codebase

Scaling Up II: High Load

Scaling Up III: Reliability

Scaling Up IV: Flood Limits

Bot API Transformers

Telegram Business

Deployment Checklist

Introduction

How to Write a Plugin

Built-in

Sessions and Storing Data

Inline and Custom Keyboards

Official

Conversations (conversations)

Interactive Menus (menu)

Stateless Question (stateless-question)

Concurrency (runner)

Hydration (hydrate)

Retry API Requests (auto-retry)

Flood Control (transformer-throttler)

Rate Limit Users (ratelimiter)

Internationalization (i18n)

Internationalization (fluent)

Router (router)

Parse Mode (parse-mode)

Chat Members (chat-members)

Third-party

Useful Middleware

[Submit your PR!]

Examples

Example Bots Repository

grammY

Community Chat (English)

Community Chat (Russian)

Comparison to Other Frameworks

Telegram

Introduction for Developers

Bot API Reference

Example Updates

Tools

VS Code Extension

Overview

Tutorials

Virtual Private Server (VPS)

Supabase Edge Functions

Cloudflare Workers (Deno)

Cloudflare Workers (Node.js)

Firebase Functions

Zeabur (Node.js)

Appearance

On this page

Table of Contents for current page

BotDescription

^{ref / types / BotDescription}

This object represents the bot’s description.

Properties

description

ts

description: string;

The bot’s description