telegraf.js

https://telegraf.js.org/
Admin
telegraf.js is a modern Telegram Bot API framework for Node.js, simplifying the development of...
Tokens:132,595
Snippets:916
Trust Score:8.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Basic Telegraf Bot Example

Source: https://telegraf.js.org/index.html

A fundamental example demonstrating how to create a Telegraf bot, handle basic commands like start and help, and respond to messages and stickers. It includes setup for graceful shutdown.

```javascript
const { Telegraf } = require('telegraf')
const { message } = require('telegraf/filters')

const bot = new Telegraf(process.env.BOT_TOKEN)
bot.start((ctx) => ctx.reply('Welcome'))
bot.help((ctx) => ctx.reply('Send me a sticker'))
bot.on(message('sticker'), (ctx) => ctx.reply('👍'))
bot.hears('hi', (ctx) => ctx.reply('Hey there'))
bot.launch()

// Enable graceful stop
process.once('SIGINT', () => bot.stop('SIGINT'))
process.once('SIGTERM', () => bot.stop('SIGTERM'))
```

--------------------------------

### Install Telegraf using npm

Source: https://telegraf.js.org/index.html

Command to install the Telegraf library using npm.

```bash
$ npm install telegraf
```

--------------------------------

### Start Webhook via launch Method

Source: https://telegraf.js.org/index.html

Launches the Telegraf bot using the launch method with webhook configuration. This is the preferred method for starting a webhook server. Ensure you provide the webhook domain, port, and optionally a path and secret token for security.

```javascript
import { Telegraf } from "telegraf";
import { message } from 'telegraf/filters';

const bot = new Telegraf(token);

bot.on(message("text"), ctx => ctx.reply("Hello"));

// Start webhook via launch method (preferred)
bot.launch({
  webhook: {
    // Public domain for webhook; e.g.: example.com
    domain: webhookDomain,

    // Port to listen on; e.g.: 8080
    port: port,

    // Optional path to listen for.
    // `bot.secretPathComponent()` will be used by default
    path: webhookPath,

    // Optional secret to be sent back in a header for security.
    // e.g.: `crypto.randomBytes(64).toString("hex")`
    secretToken: randomAlphaNumericString,
  },
});
```

--------------------------------

### Install Telegraf using yarn

Source: https://telegraf.js.org/index.html

Command to install the Telegraf library using yarn.

```bash
$ yarn add telegraf
```

--------------------------------

### Install Telegraf using pnpm

Source: https://telegraf.js.org/index.html

Command to install the Telegraf library using pnpm.

```bash
$ pnpm add telegraf
```

--------------------------------

### getFile

Source: https://telegraf.js.org/classes/Telegram.html

Get basic info about a file and prepare it for downloading.

```APIDOC
## getFile

### Description
Get basic info about a file and prepare it for downloading.

### Method
GET

### Endpoint
/getFile

### Parameters
#### Path Parameters
None

#### Query Parameters
* **fileId** (string) - Required - Id of file to get link to

### Request Example
```json
{
  "fileId": "AgADBAADGyc4MRy1m_p_x3_x_x"
}
```

### Response
#### Success Response (200)
* **File** - Basic information about the file.
```

--------------------------------

### Telegraf Bot with Command Handlers

Source: https://telegraf.js.org/index.html

An example showcasing how to define specific command handlers for a Telegraf bot, including a simple reply and a lambda-based reply. It also includes setup for graceful shutdown.

```javascript
const { Telegraf } = require('telegraf')

const bot = new Telegraf(process.env.BOT_TOKEN)
bot.command('oldschool', (ctx) => ctx.reply('Hello'))
bot.command('hipster', Telegraf.reply('λ'))
bot.launch()

// Enable graceful stop
process.once('SIGINT', () => bot.stop('SIGINT'))
process.once('SIGTERM', () => bot.stop('SIGTERM'))
```

--------------------------------

### getMe

Source: https://telegraf.js.org/classes/Telegram.html

Get basic information about the bot.

```APIDOC
## getMe

### Description
Get basic information about the bot.

### Method
GET

### Endpoint
/getMe

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
* **UserFromGetMe** - Basic information about the bot.
```

--------------------------------

### start

Source: https://telegraf.js.org/classes/Telegraf-1.html

Registers a middleware for handling the /start command. This method allows you to define custom logic that should be executed when a user initiates a chat with the bot using the /start command.

```APIDOC
## start

### Description
Registers a middleware for handling /start.

### Method
start

### Parameters
* `...fns` (NonemptyReadonlyArray<Middleware<Context<...>>>) - The middleware functions to register for handling the /start command.

### Returns
Telegraf<C>
```

--------------------------------

### Composer.start

Source: https://telegraf.js.org/classes/Composer.html

Registers middleware for handling the /start command.

```APIDOC
## Composer.start

### Description
Registers a middleware for handling the /start command.

### Method
`start(...fns)`

### Parameters
* **...fns** (NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number; }> & Omit<C, keyof Context<Update>> & StartContextExtn>>) - The middleware functions to apply.

### Returns
Composer<C>
```

--------------------------------

### launch (with config)

Source: https://telegraf.js.org/classes/Telegraf-1.html

Launches the bot with configuration options. Optionally accepts a callback function to be executed once the bot has launched.

```APIDOC
## launch

### Description
Launches the bot with configuration options. Optionally accepts a callback function to be executed once the bot has launched.

### Method
`launch(config, onLaunch?)`

### Parameters
* `config`: `LaunchOptions`
* `onLaunch` (Optional): `()` => `void`

### Returns
`Promise<void>`

### See
https://github.com/telegraf/telegraf/discussions/1344#discussioncomment-335700
```

--------------------------------

### launch (no config)

Source: https://telegraf.js.org/classes/Telegraf-1.html

Launches the bot. Optionally accepts a callback function to be executed once the bot has launched.

```APIDOC
## launch

### Description
Launches the bot. Optionally accepts a callback function to be executed once the bot has launched.

### Method
`launch(onLaunch?)`

### Parameters
* `onLaunch` (Optional): `()` => `void`

### Returns
`Promise<void>`

### See
https://github.com/telegraf/telegraf/discussions/1344#discussioncomment-335700
```

--------------------------------

### help

Source: https://telegraf.js.org/classes/Scenes.Stage.html

Registers a middleware specifically for handling the /help command.

```APIDOC
## help

### Description
Registers a middleware for handling /help.

### Parameters
* **`Rest` ...fns**: NonemptyReadonlyArray<Middleware<Context<{
message: New & NonChannel & TextMessage;
update_id: number;
}> & Omit<C, keyof Context<Update>> & CommandContextExtn>>

### Returns
Stage<C, D>
```

--------------------------------

### help

Source: https://telegraf.js.org/classes/Scenes.WizardScene.html

Registers a middleware for handling the /help command. This method provides a convenient way to offer help information to users within the wizard flow.

```APIDOC
## help

### Description
Registers a middleware for handling /help command.

### Method
`help(...fns)`

### Parameters
#### Path Parameters
* **`Rest` ...fns** (NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number; }> & Omit<C, keyof Context<Update>> & CommandContextExtn>>) - Middleware functions to execute for the /help command.

### Returns
WizardScene<C>
```

--------------------------------

### getFileLink

Source: https://telegraf.js.org/classes/Telegram.html

Get download link to a file.

```APIDOC
## getFileLink

### Description
Get download link to a file.

### Method
GET

### Endpoint
/getFileLink

### Parameters
#### Path Parameters
None

#### Query Parameters
* **fileId** (string | File) - Required - The file ID or File object.

### Request Example
```json
{
  "fileId": "AgADBAADGyc4MRy1m_p_x3_x_x"
}
```

### Response
#### Success Response (200)
* **URL** - The download URL for the file.
```

--------------------------------

### help

Source: https://telegraf.js.org/classes/Telegraf-1.html

Registers a middleware for handling the /help command.

```APIDOC
## help

### Description
Registers a middleware for handling the /help command.

### Method
POST

### Endpoint
/help

### Parameters
#### Request Body
- **...fns** (Middleware) - Required - The middleware functions to handle the /help command.

### Returns
Telegraf<C>
```

--------------------------------

### getChatMembersCount

Source: https://telegraf.js.org/classes/Telegram.html

Get the number of members in a chat.

```APIDOC
## getChatMembersCount

### Description
Get the number of members in a chat.

### Method
GET

### Endpoint
/getChatMembersCount

### Parameters
#### Path Parameters
None

#### Query Parameters
* **chatId** (string | number) - Required - Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

### Request Example
```json
{
  "chatId": "@channelusername"
}
```

### Response
#### Success Response (200)
* **number** - The number of members in the chat.
```

--------------------------------

### getChatMember

Source: https://telegraf.js.org/classes/Telegram.html

Get information about a member of a chat.

```APIDOC
## getChatMember

### Description
Get information about a member of a chat.

### Method
GET

### Endpoint
/getChatMember

### Parameters
#### Path Parameters
None

#### Query Parameters
* **chatId** (string | number) - Required - Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
* **userId** (number) - Required - Unique identifier of the target user

### Request Example
```json
{
  "chatId": "@channelusername",
  "userId": 123456789
}
```

### Response
#### Success Response (200)
* **ChatMember** - Information about the chat member.
```

--------------------------------

### help

Source: https://telegraf.js.org/classes/Scenes.BaseScene.html

Registers a middleware for handling the /help command. It accepts a list of middleware functions.

```APIDOC
## help

### Description
Registers a middleware for handling the /help command. It accepts a list of middleware functions.

### Method
`help(...fns)`

### Parameters
* **`Rest` ...fns**: NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number; } & Omit<C, keyof Context<Update>> & CommandContextExtn>>

### Returns
BaseScene<C>
```

--------------------------------

### Telegraf Middleware Example with Timing

Source: https://telegraf.js.org/index.html

An example of a Telegraf middleware that measures the processing time for each incoming update. It uses `console.time` and `console.timeEnd` to log the duration. This middleware must call `await next()` to pass control to the next middleware in the chain.

```javascript
import { Telegraf } from 'telegraf';
import { message } from 'telegraf/filters';

const bot = new Telegraf(process.env.BOT_TOKEN);

bot.use(async (ctx, next) => {
  console.time(`Processing update ${ctx.update.update_id}`);
  await next() // runs next middleware
  // runs after next middleware finishes
  console.timeEnd(`Processing update ${ctx.update.update_id}`);
})

bot.on(message('text'), (ctx) => ctx.reply('Hello World'));
bot.launch();

// Enable graceful stop
process.once('SIGINT', () => bot.stop('SIGINT'));
process.once('SIGTERM', () => bot.stop('SIGTERM'));
```

--------------------------------

### WizardScene Constructor

Source: https://telegraf.js.org/classes/Scenes.WizardScene.html

Instantiates a new WizardScene. It can be created with either just an ID and steps, or with an ID, options, and steps.

```APIDOC
## new WizardScene<C>(id, ...steps)

### Description
Creates a new WizardScene instance with the given ID and a sequence of middleware steps.

### Parameters
* **id** (string) - The unique identifier for this scene.
* **`Rest` ...steps** (Middleware<C>[]) - A variable number of middleware functions that define the steps of the wizard.

### Returns
WizardScene<C>
```

```APIDOC
## new WizardScene<C>(id, options, ...steps)

### Description
Creates a new WizardScene instance with the given ID, scene options, and a sequence of middleware steps.

### Parameters
* **id** (string) - The unique identifier for this scene.
* **options** (SceneOptions<C>) - Options for configuring the scene.
* **`Rest` ...steps** (Middleware<C>[]) - A variable number of middleware functions that define the steps of the wizard.

### Returns
WizardScene<C>
```

--------------------------------

### getMyCommands

Source: https://telegraf.js.org/classes/Telegram.html

Get the current list of the bot's commands.

```APIDOC
## getMyCommands

### Description
Get the current list of the bot's commands.

### Method
GET

### Endpoint
/getMyCommands

### Parameters
#### Path Parameters
None

#### Query Parameters
* **extra** ({}) - Optional - Additional parameters.

### Request Example
```json
{
  "extra": {}
}
```

### Response
#### Success Response (200)
* **BotCommand[]** - An array of BotCommand objects.
```

--------------------------------

### Composer.use

Source: https://telegraf.js.org/classes/Composer.html

Registers a general middleware.

```APIDOC
## Composer.use

### Description
Registers a middleware.

### Method
`use(...fns)`

### Parameters
* **...fns** (readonly Middleware<C>[]) - The middleware functions to apply.

### Returns
Composer<C>
```

--------------------------------

### getWebhookInfo

Source: https://telegraf.js.org/classes/Telegram.html

Retrieves information about the bot's webhook setup.

```APIDOC
## getWebhookInfo

### Description
Retrieves information about the bot's webhook setup.

### Method
GET (assumed, based on typical API patterns for retrieval)

### Endpoint
/getWebhookInfo

### Returns
Promise<WebhookInfo>
```

--------------------------------

### help

Source: https://telegraf.js.org/classes/Composer.html

Registers middleware for handling the /help command. It accepts a list of middleware functions to process help requests.

```APIDOC
## help

### Description
Registers a middleware for handling /help. It accepts a list of middleware functions to process help requests.

### Method
Not applicable (SDK method)

### Signature
`help(...fns): Composer<C>`

### Parameters
* **`Rest` ...fns**: NonemptyReadonlyArray<Middleware<Context<{
message: New & NonChannel & TextMessage;
update_id: number;
} & Omit<C, keyof Context<Update>> & CommandContextExtn>>

### Returns
Composer<C>
```

--------------------------------

### getMyDescription

Source: https://telegraf.js.org/classes/Telegram.html

Use this method to get the current bot description for the given user language.

```APIDOC
## getMyDescription

### Description
Use this method to get the current bot description for the given user language.

### Method
GET

### Endpoint
/getMyDescription

### Parameters
#### Path Parameters
None

#### Query Parameters
* **language_code** (string) - Optional - A two-letter ISO 639-1 language code.

### Request Example
```json
{
  "language_code": "en"
}
```

### Response
#### Success Response (200)
* **BotDescription** - The current bot description.
```

--------------------------------

### WizardContextWizard.back

Source: https://telegraf.js.org/classes/Scenes.WizardContextWizard.html

Navigates the wizard to the previous step.

```APIDOC
## back()

### Description
Navigates the wizard to the previous step.

### Returns
WizardContextWizard<C>
```

--------------------------------

### getStickerSet

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Use this method to get a sticker set. Deprecated, use Telegram.getStickerSet instead.

```APIDOC
## getStickerSet

### Description
Retrieves a sticker set by its name.

### Method
`getStickerSet(setName: string)`

### Parameters
#### Path Parameters
- **setName** (string) - Required - The name of the sticker set.

### Returns
`Promise<StickerSet>`

### Deprecated
Use `Telegram.getStickerSet` instead.

### See
https://core.telegram.org/bots/api#getstickerset
```

--------------------------------

### getChatAdministrators

Source: https://telegraf.js.org/classes/Telegram.html

Get a list of administrators in a chat. On success, returns an Array of ChatMember objects.

```APIDOC
## getChatAdministrators

### Description
Get a list of administrators in a chat. On success, returns an Array of ChatMember objects.

### Method
GET

### Endpoint
/getChatAdministrators

### Parameters
#### Path Parameters
None

#### Query Parameters
* **chatId** (string | number) - Required - Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

### Request Example
```json
{
  "chatId": "@channelusername"
}
```

### Response
#### Success Response (200)
* **(ChatMemberOwner | ChatMemberAdministrator)[]** - An array of administrator objects.
```

--------------------------------

### WizardContextWizard.next

Source: https://telegraf.js.org/classes/Scenes.WizardContextWizard.html

Navigates the wizard to the next step.

```APIDOC
## next()

### Description
Navigates the wizard to the next step.

### Returns
WizardContextWizard<C>
```

--------------------------------

### getChatMembersCount

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Use this method to get the number of members in a chat. Returns an integer on success.

```APIDOC
## getChatMembersCount

### Description
Retrieves the total number of members in the chat.

### Method
`getChatMembersCount(...args)`

### Returns
`Promise<number>`

### See
https://core.telegram.org/bots/api#getchatmembercount
```

--------------------------------

### BaseScene Methods

Source: https://telegraf.js.org/classes/Scenes.BaseScene.html

Lists the methods available on BaseScene instances for handling various user inputs and managing scene transitions.

```APIDOC
## Methods

### action
* **Signature**: `action(triggers, ...fns): BaseScene<C>`
* **Description**: Registers middleware for handling callback queries that match the provided triggers.
* **Parameters**:
  * **triggers**: Triggers<NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>> - The callback query triggers to match.
  * **...fns**: MatchedMiddleware<C, "callback_query"> - Middleware functions to execute.
* **Returns**: `BaseScene<C>`

### cashtag
* **Signature**: `cashtag(cashtag, ...fns): BaseScene<C>`
* **Description**: Registers middleware for handling messages containing cashtags.
* **Parameters**:
  * **cashtag**: MaybeArray<string> - The cashtag(s) to match.
  * **...fns**: MatchedMiddleware<C, "channel_post" | "message"> - Middleware functions to execute.
* **Returns**: `BaseScene<C>`

### command
* **Signature**: `command(command, ...fns): BaseScene<C>`
* **Description**: Registers middleware for handling specified commands.
* **Parameters**:
  * **command**: Triggers<NarrowedContext<C, { message: New & NonChannel & TextMessage; update_id: number; }>> - The command(s) to match.
  * **...fns**: NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number; }>> & Omit<C, keyof Context<Update>> & CommandContextExtn>> - Middleware functions to execute.
* **Returns**: `BaseScene<C>`

### drop
* **Signature**: `drop(predicate): BaseScene<C>`
* **Description**: Registers middleware for dropping updates that satisfy the given predicate.
* **Parameters**:
  * **predicate**: Function - A function that returns true if the update should be dropped.
* **Returns**: `BaseScene<C>`
```

--------------------------------

### token Accessor

Source: https://telegraf.js.org/classes/Telegraf-1.html

Gets the bot's token. This is a private accessor and should not be used directly.

```APIDOC
## get token

### Description
Gets the bot's token.

### Returns
string
```

--------------------------------

### getChatMember

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

```APIDOC
## getChatMember

### Description
Retrieves information about a specific chat member.

### Method
`getChatMember(...args: [userId: number])`

### Parameters
#### Path Parameters
- **userId** (number) - Required - The ID of the user to retrieve information for.

### Returns
`Promise<ChatMember>`

### See
https://core.telegram.org/bots/api#getchatmember
```

--------------------------------

### getChatAdministrators

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Use this method to get a list of administrators in a chat. Returns an array of ChatMember objects.

```APIDOC
## getChatAdministrators

### Description
Retrieves a list of administrators for the current chat.

### Method
`getChatAdministrators(...args)`

### Returns
`Promise<(ChatMemberOwner | ChatMemberAdministrator)[]>`

### See
https://core.telegram.org/bots/api#getchatadministrators
```

--------------------------------

### WizardContextWizard Constructor

Source: https://telegraf.js.org/classes/Scenes.WizardContextWizard.html

Initializes a new instance of the WizardContextWizard. It takes the context object and an array of middleware steps as arguments.

```APIDOC
## new WizardContextWizard<C>(ctx, steps)

### Description
Initializes a new instance of the WizardContextWizard.

### Parameters
* **ctx** (C) - The context object.
* **steps** (readonly Middleware<C>[]) - An array of middleware functions representing the wizard steps.

### Returns
WizardContextWizard<C>
```

--------------------------------

### inlineKeyboard(buttons, options)

Source: https://telegraf.js.org/functions/Markup.inlineKeyboard.html

Creates an inline keyboard with the specified buttons and optional building options.

```APIDOC
## inlineKeyboard(buttons, options)

### Description
Creates an inline keyboard with the specified buttons and optional building options.

### Parameters
#### buttons
- **buttons** (HideableIKBtn[]) - Required - An array of HideableIKBtn objects representing the buttons for the keyboard.
#### options
- **options** (Partial<KeyboardBuildingOptions<HideableIKBtn>>) - Optional - Configuration options for building the keyboard, such as text wrapping or column count.
```

--------------------------------

### WizardContextWizard.cursor

Source: https://telegraf.js.org/classes/Scenes.WizardContextWizard.html

Manages the current step index of the wizard. It can be used to get or set the current cursor.

```APIDOC
## cursor

### Description
Gets or sets the current step index of the wizard.

### Accessors
* **get cursor(): number** - Returns the current step index.
* **set cursor(cursor: number): void** - Sets the current step index.
```

--------------------------------

### BaseScene Constructor

Source: https://telegraf.js.org/classes/Scenes.BaseScene.html

Initializes a new BaseScene instance. It requires a unique ID and optionally accepts scene options.

```APIDOC
## new BaseScene<C>(id, options?)

### Description
Initializes a new BaseScene instance.

### Parameters
* **id**: string - The unique identifier for the scene.
* **options**: SceneOptions<C> (Optional) - Configuration options for the scene.
```

--------------------------------

### getMyDefaultAdministratorRights

Source: https://telegraf.js.org/classes/Telegram.html

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

```APIDOC
## getMyDefaultAdministratorRights

### Description
Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

### Method
GET

### Endpoint
/getMyDefaultAdministratorRights

### Parameters
#### Path Parameters
None

#### Query Parameters
* **forChannels** (boolean) - Optional - Pass true to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

### Request Example
```json
{
  "forChannels": true
}
```

### Response
#### Success Response (200)
* **ChatAdministratorRights** - The default administrator rights of the bot.
```

--------------------------------

### enter

Source: https://telegraf.js.org/classes/Scenes.WizardScene.html

Registers middleware to be executed when entering the scene. This is typically used for initialization or setting up the scene's initial state.

```APIDOC
## enter

### Description
Registers middleware to be executed when entering the scene.

### Method
`enter(...fns)`

### Parameters
#### Path Parameters
* **`Rest` ...fns** (Middleware<C>[]) - Middleware functions to execute upon entering the scene.

### Returns
WizardScene<C>
```

--------------------------------

### getChat

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Gets information about a chat. This method is a wrapper around the Telegram Bot API's getChat method.

```APIDOC
## getChat

### Description
Gets information about a chat. This method returns basic information about the chat (chat type, title, all members count, etc.).

### Method
Not specified (likely a method call on a SceneContext object).

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Request Example
```json
getChat()
```

### Response
#### Success Response (200)
- **result** (ChatFromGetChat) - An object containing information about the chat.

#### Response Example
```json
{
  "id": 123456789,
  "type": "private",
  "first_name": "John",
  "username": "john_doe"
}
```
```

--------------------------------

### enter

Source: https://telegraf.js.org/classes/Scenes.Stage.html

Handles entering a specific scene, optionally setting an initial state and silent mode.

```APIDOC
## `Static` enter
  * enter<C>(...args): ((ctx) => Promise<unknown>)
  * #### Type Parameters
    * #### C extends Context<Update> & {   
scene: SceneContextScene<C, SceneSessionData>;   
}
#### Parameters
    * ##### `Rest` ...args: [sceneId: string, initialState: object, silent: boolean]
`Rest`
#### Returns ((ctx) => Promise<unknown>)
    *       * (ctx): Promise<unknown>
      * #### Parameters
        * ##### ctx: C
#### Returns Promise<unknown>
```

--------------------------------

### setPassportDataErrors

Source: https://telegraf.js.org/classes/Telegram.html

Informs the user that there are errors in the provided Telegram Passport data. This is used to guide the user in correcting their information.

```APIDOC
## setPassportDataErrors

### Description
Informs the user of errors in their Telegram Passport data.

### Method
POST

### Endpoint
/setPassportDataErrors

### Parameters
#### Request Body
- **userId** (number) - Required - The ID of the user whose data has errors.
- **errors** (readonly PassportElementError[]) - Required - An array of errors found in the Passport data.

### Request Example
```json
{
  "userId": 123456789,
  "errors": [
    {
      "source": "passport",
      "type": "invalid_element_error",
      "element_hash": "some_hash",
      "message": "The document is blurry."
    }
  ]
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - True if the operation was successful.

#### Response Example
```json
{
  "ok": true
}
```
```

--------------------------------

### enterMiddleware

Source: https://telegraf.js.org/classes/Scenes.BaseScene.html

Returns a middleware function that handles entering the scene.

```APIDOC
## enterMiddleware

### Description
Returns a middleware function that handles entering the scene.

### Method
`enterMiddleware()`

### Returns
MiddlewareFn<C>
```

--------------------------------

### getMyDefaultAdministratorRights

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Use this method to get the default administrator rights of the bot in the specified chat type. Returns ChatAdministratorRights on success.

```APIDOC
## getMyDefaultAdministratorRights

### Description
Retrieves the default administrator rights for the bot.

### Method
`getMyDefaultAdministratorRights(extra?: { forChannels?: boolean })`

### Parameters
#### Query Parameters
- **extra** (object) - Optional - Additional parameters.
  - **forChannels** (boolean) - Optional - Whether to get rights for channels.

### Returns
`Promise<ChatAdministratorRights>`

### See
https://core.telegram.org/bots/api#getmydefaultadministratorrights
```

--------------------------------

### getStickerSet

Source: https://telegraf.js.org/interfaces/Scenes.WizardContext.html

Retrieves information about a sticker set. This method is used to get details about a collection of stickers, including their associated emojis and files.

```APIDOC
## getStickerSet

### Description
Retrieves information about a sticker set. This method is used to get details about a collection of stickers, including their associated emojis and files.

### Method
getStickerSet

### Parameters
#### Path Parameters
- **setName** (string) - Required - The name of the sticker set.

### Returns
Promise<StickerSet>

### Deprecated
use Telegram.getStickerSet

### See
https://core.telegram.org/bots/api#getstickerset
```

--------------------------------

### getChatMembersCount

Source: https://telegraf.js.org/interfaces/Scenes.WizardContext.html

Retrieves the total number of members in a chat. This method provides a quick way to get the current size of a group or channel.

```APIDOC
## getChatMembersCount

### Description
Retrieves the total number of members in a chat. This method provides a quick way to get the current size of a group or channel.

### Method
getChatMembersCount

### Parameters
#### Path Parameters
- **...args** (Rest) - Placeholder for any arguments required by the underlying API call.

### Returns
Promise<number>

### See
https://core.telegram.org/bots/api#getchatmembercount
```

--------------------------------

### keyboard(buttons, options)

Source: https://telegraf.js.org/functions/Markup.keyboard.html

Creates a reply keyboard markup with the specified buttons and optional configuration. This version expects a 1D array of buttons and allows for custom options.

```APIDOC
## keyboard(buttons, options)

### Description
Creates a reply keyboard markup with the specified buttons and optional configuration. This version expects a 1D array of buttons and allows for custom options.

### Parameters
#### Path Parameters
* **buttons** (HideableKBtn[]) - Required - An array representing the keyboard buttons.
* **options** (Partial<KeyboardBuildingOptions<HideableKBtn>>) - Optional - Configuration options for building the keyboard.

### Returns
Markup<ReplyKeyboardMarkup>
```

--------------------------------

### Static Methods

Source: https://telegraf.js.org/classes/Scenes.WizardScene.html

This section details the static methods available on the WizardScene class, which are utility functions for creating specific middleware.

```APIDOC
## `Static` acl
  * acl<C>(userId, ...fns): MiddlewareFn<C>
  * Generates middleware responding only to specified users.
#### Type Parameters
    * #### C extends Context<Update>
#### Parameters
    * ##### userId: MaybeArray<number>
    * ##### `Rest` ...fns: NonemptyReadonlyArray<Middleware<C>>
`Rest`
#### Returns MiddlewareFn<C>

## `Static` action
  * action<C>(triggers, ...fns): MiddlewareFn<C>
  * Generates middleware for handling matching callback queries.
#### Type Parameters
    * #### C extends Context<Update>
#### Parameters
    * ##### triggers: Triggers<NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>>
    * ##### `Rest` ...fns: MatchedMiddleware<C, "callback_query">
`Rest`
#### Returns MiddlewareFn<C>

## `Static` admin
  * admin<C>(...fns): MiddlewareFn<C>
  * Generates middleware responding only to chat admins and chat creator.
#### Type Parameters
    * #### C extends Context<Update>
```

--------------------------------

### getChatMenuButton

Source: https://telegraf.js.org/interfaces/Scenes.SceneContext.html

Use this method to get the current value of the bot's menu button in the current private chat. Returns MenuButton on success.

```APIDOC
## getChatMenuButton

### Description
Retrieves the current menu button configuration for the bot in a private chat.

### Method
`getChatMenuButton()`

### Returns
`Promise<MenuButton>`

### See
https://core.telegram.org/bots/api#getchatmenubutton
```

--------------------------------

### pay(text, hide?)

Source: https://telegraf.js.org/functions/Markup.button.pay.html

Creates an inline keyboard button that initiates a payment flow. The button displays the provided text and can optionally be hidden.

```APIDOC
## pay(text, hide?)

### Description
Creates an inline keyboard button that initiates a payment flow. The button displays the provided text and can optionally be hidden.

### Method
N/A (SDK function)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
Returns an `InlineKeyboardButton.PayButton` object.

#### Response Example
N/A

### Parameters
* **text** (string) - The text to display on the button.
* **hide** (boolean) - Optional. If true, the button will be hidden. Defaults to false.
```

--------------------------------

### getChat

Source: https://telegraf.js.org/classes/Telegram.html

Get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.).

```APIDOC
## getChat

### Description
Get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.).

### Method
GET

### Endpoint
/getChat

### Parameters
#### Path Parameters
None

#### Query Parameters
* **chatId** (string | number) - Required - Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

### Request Example
```json
{
  "chatId": "@channelusername"
}
```

### Response
#### Success Response (200)
* **ChatFromGetChat** - Information about the chat.
```

--------------------------------

### enter

Source: https://telegraf.js.org/classes/Scenes.BaseScene.html

Registers middleware to be executed when entering the scene. It accepts a list of middleware functions.

```APIDOC
## enter

### Description
Registers middleware to be executed when entering the scene. It accepts a list of middleware functions.

### Method
`enter(...fns)`

### Parameters
* **`Rest` ...fns**: Middleware<C>[]

### Returns
BaseScene<C>
```

--------------------------------

### getChatMenuButton

Source: https://telegraf.js.org/classes/Context.html

Use this method to get the current value of the bot's menu button in the current private chat. Returns MenuButton on success.

```APIDOC
## getChatMenuButton

### Description
Use this method to get the current value of the bot's menu button in the current private chat. Returns MenuButton on success.

### Method
GET

### Endpoint
/getChatMenuButton

### Parameters

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **menuButton** (MenuButton) - Description of the menu button

#### Response Example
```json
{
  "example": "{...}"
}
```
```

--------------------------------

### getCustomEmojiStickers

Source: https://telegraf.js.org/classes/Telegram.html

Use this method to get a list of custom emoji stickers, which can be used as a forum topic icon by any user. Returns an Array of Sticker objects.

```APIDOC
## getCustomEmojiStickers

### Description
Use this method to get a list of custom emoji stickers, which can be used as a forum topic icon by any user. Returns an Array of Sticker objects.

### Method
GET

### Endpoint
/getCustomEmojiStickers

### Parameters
#### Path Parameters
None

#### Query Parameters
* **custom_emoji_ids** (string[]) - Required - A list of custom emoji IDs.

### Request Example
```json
{
  "custom_emoji_ids": ["5368497234567890000"]
}
```

### Response
#### Success Response (200)
* **Sticker[]** - An array of Sticker objects.
```

--------------------------------

### Stage Constructor

Source: https://telegraf.js.org/classes/Scenes.Stage.html

Initializes a new Stage instance. It can optionally take an array of scenes and configuration options.

```APIDOC
## constructor
  * `new Stage<C, D>(scenes?, options?): Stage<C, D>`
  * #### Type Parameters
    * #### C extends SessionContext<SceneSession<D>> & {   
scene: SceneContextScene<C, D>;   
}
    * #### D extends SceneSessionData = SceneSessionData
#### Parameters
    * ##### scenes: readonly BaseScene<C>[] = []
    * ##### `Optional` options: Partial<SceneContextSceneOptions<D>>
`Optional`
#### Returns Stage<C, D>
```

--------------------------------

### getForumTopicIconStickers

Source: https://telegraf.js.org/classes/Telegram.html

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

```APIDOC
## getForumTopicIconStickers

### Description
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

### Method
GET

### Endpoint
/getForumTopicIconStickers

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
* **Sticker[]** - An array of Sticker objects.
```

--------------------------------

### LaunchOptions Interface

Source: https://telegraf.js.org/interfaces/Telegraf.LaunchOptions.html

Defines the configuration options for launching a Telegraf bot, including settings for update types, pending updates, and webhook behavior.

```APIDOC
## Interface LaunchOptions

### Properties

*   **allowedUpdates?** (UpdateType[]) - Optional - List the types of updates you want your bot to receive.
*   **dropPendingUpdates?** (boolean) - Optional - If true, pending updates will be dropped.
*   **webhook?** (object) - Optional - Configuration options for when the bot is run via webhooks.
    *   **cb?** (RequestListener<IncomingMessage, ServerResponse>) - Optional - Callback for handling incoming requests.
    *   **certificate?** (InputFile) - Optional - Public key certificate for webhook verification. See self-signed guide for details.
    *   **domain** (string) - Required - Public domain for the webhook.
    *   **hookPath?** (string) - Optional - Webhook URL path. Will be automatically generated if not specified. Deprecated: Pass `path` instead.
    *   **host?** (string) - Optional - Host for webhook requests.
    *   **ipAddress?** (string) - Optional - The fixed IP address to use for sending webhook requests instead of the IP address resolved through DNS.
    *   **maxConnections?** (number) - Optional - Maximum allowed simultaneous HTTPS connections to the webhook for update delivery (1-100). Defaults to 40.
    *   **path?** (string) - Optional - Webhook URL path. Will be automatically generated if not specified.
    *   **port?** (number) - Optional - Port for webhook requests.
    *   **secretToken?** (string) - Optional - A secret token to be sent in the `X-Telegram-Bot-Api-Secret-Token` header for webhook requests. 1-256 characters. Only `A-Z`, `a-z`, `0-9`, `_`, and `-` are allowed.
    *   **tlsOptions?** (TlsOptions) - Optional - TLS server options. Omit to use http.
```

--------------------------------

### getChatMenuButton

Source: https://telegraf.js.org/classes/Telegram.html

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

```APIDOC
## getChatMenuButton

### Description
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

### Method
GET

### Endpoint
/getChatMenuButton

### Parameters
#### Path Parameters
None

#### Query Parameters
* **chatId** (number) - Optional - Unique identifier for the target private chat. If not specified, default bot's menu button will be returned.

### Request Example
```json
{
  "chatId": 123456789
}
```

### Response
#### Success Response (200)
* **MenuButton** - The bot's menu button.
```

--------------------------------

### action

Source: https://telegraf.js.org/classes/Telegraf-1.html

Registers middleware for handling matching callback queries.

```APIDOC
## action

### Description
Registers middleware for handling matching callback queries.

### Method
POST

### Endpoint
/action

### Parameters
#### Request Body
- **triggers** (Triggers) - Required - The triggers for the callback query.
- **...fns** (MatcheMiddleware) - Required - The middleware functions to handle the callback query.

### Returns
Telegraf<C>
```

--------------------------------

### Composer.action

Source: https://telegraf.js.org/classes/Composer.html

Generates middleware for handling matching callback queries.

```APIDOC
## Composer.action

### Description
Generates middleware for handling matching callback queries.

### Method
`action<C>(triggers, ...fns)`

### Type Parameters
* **C** extends Context<Update>

### Parameters
* **triggers** (Triggers<NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>>) - The callback query data to match.
* **...fns** (MatchedMiddleware<C, "callback_query">) - The middleware functions to apply.

### Returns
MiddlewareFn<C>
```

--------------------------------

### removeKeyboard

Source: https://telegraf.js.org/functions/Markup.removeKeyboard.html

Removes the custom reply keyboard that was previously sent to the chat. Use this to send a message without a reply keyboard. For example, when you want to hide the keyboard for a certain reason.

```APIDOC
## removeKeyboard

### Description
Removes the custom reply keyboard that was previously sent to the chat. Use this to send a message without a reply keyboard. For example, when you want to hide the keyboard for a certain reason.

### Method
N/A (SDK function)

### Endpoint
N/A (SDK function)

### Returns
Markup<ReplyKeyboardRemove>
```

--------------------------------

### Create Webhook with Existing HTTP Server

Source: https://telegraf.js.org/index.html

Attaches Telegraf to an existing Node.js HTTP server using `createWebhook`. This is useful when you need more control over the server setup or are integrating with an existing application. It supports both HTTP and HTTPS servers.

```javascript
import { createServer } from "http";

createServer(await bot.createWebhook({ domain: "example.com" })).listen(3000);
```

```javascript
import { createServer } from "https";

createServer(tlsOptions, await bot.createWebhook({ domain: "example.com" })).listen(8443);
```

--------------------------------

### Markup.resize

Source: https://telegraf.js.org/classes/Types.Markup.html

Configures the keyboard to resize dynamically based on the content. This method is applicable to ReplyKeyboardMarkup.

```APIDOC
## resize(value?: boolean): Markup<ReplyKeyboardMarkup>

### Description
Sets the resize keyboard option for the reply markup.

### Parameters
* **value**: boolean = true - If true, the keyboard will resize.

### Returns
Makes Markup<ReplyKeyboardMarkup>
```

--------------------------------

### WizardContextWizard.step

Source: https://telegraf.js.org/classes/Scenes.WizardContextWizard.html

Retrieves the middleware function for the current step.

```APIDOC
## step

### Description
Gets the middleware function for the current step.

### Accessors
* **get step(): undefined | Middleware<C>** - Returns the middleware function for the current step, or undefined if no step is set.
```

--------------------------------

### WizardScene Methods

Source: https://telegraf.js.org/classes/Scenes.WizardScene.html

This section details the various methods available on the WizardScene class for filtering and handling different types of updates and commands.

```APIDOC
## phone
  * phone(number, ...fns): WizardScene<C>
  * #### Parameters
    * ##### number: Triggers<C>
    * ##### `Rest` ...fns: MatchedMiddleware<C, "channel_post" | "message">
`Rest`
#### Returns WizardScene<C>

## reaction
  * reaction(reaction, ...fns): WizardScene<C>
  * #### Parameters
    * ##### reaction: MaybeArray<ReactionAddedOrRemoved>
    * ##### `Rest` ...fns: NonemptyReadonlyArray<Middleware<Context<MessageReactionUpdate> & Omit<C, keyof Context<Update>> & {   
match: ReactionAddedOrRemoved;
},
MessageReactionUpdate>>
`Rest`
#### Returns WizardScene<C>

## settings
  * settings(...fns): WizardScene<C>
  * Registers a middleware for handling /settings
#### Parameters
    * ##### `Rest` ...fns: NonemptyReadonlyArray<Middleware<Context<{   
message: New & NonChannel & TextMessage;
update_id: number;
}> & Omit<C, keyof Context<Update>> & CommandContextExtn>>
`Rest`
#### Returns WizardScene<C>

## spoiler
  * spoiler(text, ...fns): WizardScene<C>
  * #### Parameters
    * ##### text: Triggers<C>
    * ##### `Rest` ...fns: MatchedMiddleware<C, "channel_post" | "message">
`Rest`
#### Returns WizardScene<C>

## start
  * start(...fns): WizardScene<C>
  * Registers a middleware for handling /start
#### Parameters
    * ##### `Rest` ...fns: NonemptyReadonlyArray<Middleware<Context<{   
message: New & NonChannel & TextMessage;
update_id: number;
}> & Omit<C, keyof Context<Update>> & StartContextExtn>>
`Rest`
#### Returns WizardScene<C>

## textLink
  * textLink(link, ...fns): WizardScene<C>
  * #### Parameters
    * ##### link: Triggers<C>
    * ##### `Rest` ...fns: MatchedMiddleware<C, "channel_post" | "message">
`Rest`
#### Returns WizardScene<C>

## textMention
  * textMention(mention, ...fns): WizardScene<C>
  * #### Parameters
    * ##### mention: Triggers<C>
    * ##### `Rest` ...fns: MatchedMiddleware<C, "channel_post" | "message">
`Rest`
#### Returns WizardScene<C>

## url
  * url(url, ...fns): WizardScene<C>
  * #### Parameters
    * ##### url: Triggers<C>
    * ##### `Rest` ...fns: MatchedMiddleware<C, "channel_post" | "message">
`Rest`
#### Returns WizardScene<C>

## use
  * use(...fns): WizardScene<C>
  * Registers a middleware.
#### Parameters
    * ##### `Rest` ...fns: readonly Middleware<C>[]
`Rest`
#### Returns WizardScene<C>
```

--------------------------------

### Static Methods

Source: https://telegraf.js.org/classes/Scenes.BaseScene.html

This section details static methods available on the BaseScene class, which are utility functions for creating specific types of middleware.

```APIDOC
## `Static` acl

### Description
Generates middleware responding only to specified users.

### Type Parameters
* **C extends Context<Update>

### Parameters
* **userId**: MaybeArray<number>
* **`Rest` ...fns**: NonemptyReadonlyArray<Middleware<C>>

### Returns
MiddlewareFn<C>
```

```APIDOC
## `Static` action

### Description
Generates middleware for handling matching callback queries.

### Type Parameters
* **C extends Context<Update>

### Parameters
* **triggers**: Triggers<NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>>
* **`Rest` ...fns**: MatchedMiddleware<C, "callback_query">

### Returns
MiddlewareFn<C>
```

```APIDOC
## `Static` admin

### Description
Generates middleware responding only to chat admins and chat creator.

### Type Parameters
* **C extends Context<Update>

### Parameters
* **`Rest` ...fns**: NonemptyReadonlyArray<Middleware<C>>
```

--------------------------------

### FmtString Constructor

Source: https://telegraf.js.org/classes/Format.FmtString.html

Initializes a new instance of the FmtString class.

```APIDOC
## new FmtString<Brand>(text, entities?)

### Description
Initializes a new instance of the FmtString class.

### Parameters
#### Parameters
- **text**: string - The text content.
- **entities**: MessageEntity[] - Optional. An array of message entities.

#### Returns
FmtString<Brand> - The new FmtString instance.
```

--------------------------------

### Composer.settings

Source: https://telegraf.js.org/classes/Composer.html

Registers middleware for handling the /settings command.

```APIDOC
## Composer.settings

### Description
Registers a middleware for handling the /settings command.

### Method
`settings(...fns)`

### Parameters
* **...fns** (NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number; }> & Omit<C, keyof Context<Update>> & CommandContextExtn>>) - The middleware functions to apply.

### Returns
Composer<C>
```
Tokens:
Raw