Class TelegramRequest

Класс для взаимодействия с API Telegram Предоставляет методы для отправки сообщений, файлов и других типов контента

See

https://core.telegram.org/bots/api

Example

import { TelegramRequest } from 'umbot/plugins';

// Создание экземпляра (appContext обязателен)
const telegram = new TelegramRequest(appContext);
telegram.initToken('your-bot-token');

// Отправка простого сообщения
await telegram.sendMessage(12345, 'Привет!');

// Отправка форматированного сообщения
await telegram.sendMessage(12345,
  '*Жирный текст* и _курсив_\n' +
  '[Ссылка](http://localhost)\n' +
  '`code` и ```pre```',
 *   { parse_mode: 'MarkdownV2' }
);

// Отправка сообщения с клавиатурой
const keyboard = {
  keyboard: [[
    { text: 'Кнопка 1' },
    { text: 'Кнопка 2' }
  ]],
  resize_keyboard: true,
  one_time_keyboard: true
};

await telegram.sendMessage(12345, 'Выберите:', {
  reply_markup: JSON.stringify(keyboard)
});

// Отправка файлов
await telegram.sendPhoto(12345, 'photo.jpg', 'Описание фото');
await telegram.sendDocument(12345, 'document.pdf');
await telegram.sendAudio(12345, 'audio.mp3', {
  title: 'Название',
  performer: 'Исполнитель'
});

Index

Constructors

constructor

new TelegramRequest(appContext: AppContext): TelegramRequest
Создает экземпляр класса для работы с API Telegram Устанавливает токен из конфигурации приложения, если он доступен
Parameters
- appContext: AppContext
  Контекст приложения (обязателен)
Returns TelegramRequest
- Defined in plugins/platforms/API/TelegramRequest.ts:196

Properties

token

token: string | null

Токен доступа к Telegram API

Methods

`Protected`_getUrl

_getUrl(): string
Формирует URL для отправки запроса

Returns string
Полный URL для API запроса
- Defined in plugins/platforms/API/TelegramRequest.ts:220

answerCallbackQuery

answerCallbackQuery(
    callbackQueryId: string,
    text?: string,
    showAlert?: boolean,
    url?: string,
    cacheTime?: number,
): Promise<ITelegramResult | null>
Отвечает на callback-запрос от инлайн-кнопки.
Parameters
- callbackQueryId: string
  ID запроса из поля callback_query.id
- Optionaltext: string
  Текст уведомления (показывается всплывающим окном)
- OptionalshowAlert: boolean
  Показывать как alert (true) или всплывающее уведомление (false)
- Optionalurl: string
  URL для открытия после нажатия
- OptionalcacheTime: number
  Время кэширования ответа (сек)
Returns Promise<ITelegramResult | null>
Результат ответа на callback-запрос (подтверждение) или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:532

answerInlineQuery

answerInlineQuery(
inlineQueryId: string,
results: Record<string, unknown>[],
): Promise<ITelegramResult | null>
Отправляет результаты inline-запроса в Telegram.
Parameters
- inlineQueryId: string
  Идентификатор входящего inline-запроса
- results: Record<string, unknown>[]
  Элементы, которые пользователь увидит в inline-поиске
Returns Promise<ITelegramResult | null>
Ответ Telegram API или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:320

call

call(
method: string,
userId?: TTelegramChatId | null,
): Promise<ITelegramResult | null>
Отправляет запрос к Telegram API
Parameters
- method: string
  Название метода API
- userId: TTelegramChatId | null = null
  ID пользователя или чата
Returns Promise<ITelegramResult | null>
Результат выполнения метода или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:279

initToken

initToken(token: string | null): void
Инициализирует токен доступа к Telegram API
Parameters
- token: string | null
  Токен для доступа к API; допустим null — отключает заголовок Authorization
Returns void
- Defined in plugins/platforms/API/TelegramRequest.ts:211

sendAudio

sendAudio(
    userId: TTelegramChatId,
    file: string,
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет аудиофайл
Parameters
- userId: TTelegramChatId
  ID чата или пользователя
- file: string
  Путь к локальному файлу, URL или file_id ранее загруженного файла (содержимое файла не поддерживается)
- params: ITelegramParams | null = null
  Дополнительные параметры:
  
  caption: подпись к аудио
  
  parse_mode: формат текста
  
  duration: длительность в секундах
  
  performer: исполнитель
  
  title: название
  
  disable_notification: отключить уведомление
  
  reply_to_message_id: ID сообщения для ответа
  
  reply_markup: клавиатура в JSON
Returns Promise<ITelegramResult | null>
Информация об отправленном аудио или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:638

sendDocument

sendDocument(
    userId: TTelegramChatId,
    file: string,
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет документ
Parameters
- userId: TTelegramChatId
  ID чата или пользователя
- file: string
  Путь к локальному файлу, URL или file_id ранее загруженного файла (содержимое файла не поддерживается)
- params: ITelegramParams | null = null
  Дополнительные параметры:
  
  caption: подпись к документу
  
  parse_mode: формат текста
  
  disable_notification: отключить уведомление
  
  reply_to_message_id: ID сообщения для ответа
  
  reply_markup: клавиатура в JSON
Returns Promise<ITelegramResult | null>
Информация об отправленном документе или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:605

sendMediaGroup

sendMediaGroup(
    userId: TTelegramChatId,
    media: ITelegramMedia[],
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет группу медиа

Принимает 2–10 элементов: вне диапазона — warn и null.
Parameters
- userId: TTelegramChatId
  ID чата или пользователя
- media: ITelegramMedia[]
  Массив объектов ITelegramMedia
- params: ITelegramParams | null = null
  Дополнительные параметры
Returns Promise<ITelegramResult | null>
Информация об отправленной группе медиа или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:734

sendMessage

sendMessage(
    chatId: TTelegramChatId,
    message: string,
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет текстовое сообщение
Parameters
- chatId: TTelegramChatId
  ID чата или пользователя
- message: string
  Текст сообщения
- params: ITelegramParams | null = null
  Дополнительные параметры:
  
  parse_mode: формат текста
  
  MarkdownV2: жирный, курсив, ссылка, код, pre
  
  HTML: жирный, курсив, ссылка, код,
  pre
  
  disable_web_page_preview: отключить предпросмотр ссылок
  
  disable_notification: отключить уведомление
  
  reply_to_message_id: ID сообщения для ответа
  
  reply_markup: клавиатура в JSON формате
  
  keyboard: обычная клавиатура
  
  inline_keyboard: встроенная клавиатура
  
  remove_keyboard: удалить клавиатуру
  
  force_reply: форсировать ответ
Returns Promise<ITelegramResult | null>
Информация об отправленном сообщении или null при ошибке
Example
```
// Простое сообщение
await telegram.sendMessage(12345, 'Привет!');

// Форматированное сообщение
await telegram.sendMessage(12345,
  '<b>Жирный</b> и <i>курсив</i>\n' +
  '<a href="http://localhost">Ссылка</a>\n' +
  '<code>code</code>',
  { parse_mode: 'HTML' }
);

// Сообщение с обычной клавиатурой
const keyboard = {
  keyboard: [[
    { text: 'Кнопка 1' },
    { text: 'Кнопка 2' }
  ]],
  resize_keyboard: true
};
await telegram.sendMessage(12345, 'Выберите:', {
  reply_markup: JSON.stringify(keyboard)
});

// Сообщение с inline-клавиатурой
const inlineKeyboard = {
  inline_keyboard: [[{
    text: 'Кнопка',
    callback_data: 'button_1'
  }]]
};
await telegram.sendMessage(12345, 'Нажмите:', {
  reply_markup: JSON.stringify(inlineKeyboard)
});
```
- Defined in plugins/platforms/API/TelegramRequest.ts:387

sendPhoto

sendPhoto(
    userId: TTelegramChatId,
    file: string,
    desc?: string | null,
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет фотографию
Parameters
- userId: TTelegramChatId
  ID чата или пользователя
- file: string
  Путь к локальному файлу, URL или file_id ранее загруженного файла (содержимое файла не поддерживается) Поддерживаемые форматы:
  
  JPEG, JPG, PNG, GIF, WEBP
  
  Максимальный размер: 10MB
  
  Сумма ширины и высоты не более 10000 пикселей
- desc: string | null = null
  Подпись к фотографии
- params: ITelegramParams | null = null
  Дополнительные параметры:
  
  caption: подпись к фото (0-1024 символа)
  
  parse_mode: формат текста
  
  disable_notification: отключить уведомление
  
  reply_to_message_id: ID сообщения для ответа
  
  reply_markup: клавиатура в JSON
Returns Promise<ITelegramResult | null>
Информация об отправленной фотографии или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:566

sendPoll

sendPoll(
    chatId: TTelegramChatId,
    question: string,
    options: string[],
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет опрос
Parameters
- chatId: TTelegramChatId
  ID чата или пользователя
- question: string
  Текст вопроса
- options: string[]
  Массив вариантов ответов (1-12 вариантов)
- params: ITelegramParams | null = null
  Дополнительные параметры:
  
  is_anonymous: анонимный опрос (по умолчанию true)
  
  type: тип опроса
  
  'regular': обычный опрос (по умолчанию)
  
  'quiz': викторина с одним правильным ответом
  
  allows_multiple_answers: разрешить несколько ответов (только для regular)
  
  correct_option_ids: индексы правильных ответов (0-based, только для quiz). Устаревшее correct_option_id поддерживается и автоматически приводится к массиву.
  
  explanation: пояснение правильного ответа (только для quiz)
  
  explanation_parse_mode: формат пояснения (HTML/Markdown)
  
  open_period: время в секундах, когда опрос активен
  
  close_date: дата закрытия опроса (Unix timestamp)
  
  is_closed: закрыть опрос сразу
Returns Promise<ITelegramResult | null>
Информация об отправленном опросе или null при ошибке
Example
```
// Викторина
await telegram.sendPoll(12345,
  'Столица России?',
  ['Санкт-Петербург', 'Москва', 'Новосибирск'],
  {
    type: 'quiz',
    correct_option_ids: [1], // Москва
    explanation: 'Москва - столица России с 1918 года',
    explanation_parse_mode: 'HTML'
  }
);
```
- Defined in plugins/platforms/API/TelegramRequest.ts:456

sendVideo

sendVideo(
    userId: TTelegramChatId,
    file: string,
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет видео
Parameters
- userId: TTelegramChatId
  ID чата или пользователя
- file: string
  Путь к локальному файлу, URL или file_id ранее загруженного файла (содержимое файла не поддерживается)
- params: ITelegramParams | null = null
  Дополнительные параметры:
  
  caption: подпись к видео
  
  parse_mode: формат текста
  
  duration: длительность в секундах
  
  width: ширина
  
  height: высота
  
  disable_notification: отключить уведомление
  
  reply_to_message_id: ID сообщения для ответа
  
  reply_markup: клавиатура в JSON
Returns Promise<ITelegramResult | null>
Информация об отправленном видео или null при ошибке
- Defined in plugins/platforms/API/TelegramRequest.ts:706

sendVoice

sendVoice(
    userId: TTelegramChatId,
    file: string,
    params?: ITelegramParams | null,
): Promise<ITelegramResult | null>
Отправляет голосовое сообщение.

По Bot API голосовое сообщение — это OGG/Opus (а также MP3/M4A); именно в OGG/Opus синтезирует речь Yandex SpeechKit. sendAudio для такого файла не подходит: он принимает только MP3/M4A (музыкальный плеер).
Parameters
- userId: TTelegramChatId
  ID чата или пользователя
- file: string
  Путь к локальному файлу, URL или file_id ранее загруженного голосового
- params: ITelegramParams | null = null
  Дополнительные параметры (caption, duration, reply_markup и т.д.)
Returns Promise<ITelegramResult | null>
Информация об отправленном сообщении или null при ошибке
Example
```
await telegram.sendVoice(chatId, './tts.ogg');
```
- Defined in plugins/platforms/API/TelegramRequest.ts:673

Class TelegramRequest

See

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TelegramRequest

Properties

token

Methods

Protected_getUrl

Returns string

answerCallbackQuery

Parameters

Returns Promise<ITelegramResult | null>

answerInlineQuery

Parameters

Returns Promise<ITelegramResult | null>

call

Parameters

Returns Promise<ITelegramResult | null>

initToken

Parameters

Returns void

sendAudio

Parameters

Returns Promise<ITelegramResult | null>

sendDocument

Parameters

Returns Promise<ITelegramResult | null>

sendMediaGroup

Parameters

Returns Promise<ITelegramResult | null>

sendMessage

Parameters

Returns Promise<ITelegramResult | null>

Example

sendPhoto

Parameters

Returns Promise<ITelegramResult | null>

sendPoll

Parameters

Returns Promise<ITelegramResult | null>

Example

sendVideo

Parameters

Returns Promise<ITelegramResult | null>

sendVoice

Parameters

Returns Promise<ITelegramResult | null>

Example

Settings

On This Page

`Protected`_getUrl