umbot
    Preparing search index...

    Class VkAdapter

    Адаптер, обеспечивающий поддержку платформы VK. Позволяет разрабатывать чат-ботов для мессенджера ВК на TypeScript с использованием кросс-платформенного функционала: обработка текстовых запросов, работа с карточками и кнопками.

    Подключение адаптера не требует изменения существующей бизнес-логики: после интеграции все команды и обработчики, написанные для umbot, автоматически становятся доступны для VK. Единый интерфейс позволяет одновременно использовать одну бизнес-логику для нескольких платформ (Viber, VK, Алиса и др.) без дублирования кода.

    Этот адаптер автоматически обрабатывает входящие вебхуки от мессенджера VK, преобразует их в унифицированный формат фреймворка и формирует ответ, совместимый с требованиями платформы. Подключается одной строкой и не мешает работе других адаптеров (например, для Алисы или Маруси).

    Поддерживает:

    • текстовые запросы, callback-кнопки (message_event);
    • карточки, кнопки;

    Подключается как любой другой адаптер: bot.use(new VkAdapter(token)). Несколько адаптеров могут работать одновременно — система сама выберет подходящий на основе заголовков и структуры входящего запроса.

    // Простейший бот для VK, который отвечает на приветствие
    import { Bot } from 'umbot';
    import { VkAdapter } from 'umbot/plugins';

    const bot = new Bot()
        .use(new VkAdapter('YOUR_VK_TOKEN', { vk_confirmation_token: 'YOUR_CONFIRMATION_TOKEN' }))
        .addCommand('start', ['привет'], (_text, ctx) => {
            ctx.text = 'Привет! Я твой первый бот для ВК';
        });

    bot.start('localhost', 3000);
    • Bot
    • BotController
    • BasePlatform

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _platformOptions? _token? appContext? isVoice limit MAX_TIME_REQUEST platformName signatureName? supportedEvents WARNING_TIME_REQUEST

    Methods

    _initTTS _timeLimitLog createApi destroy getContent getLocalStorage getProcessingTime getQueryExample getRatingContext init isCorrectQuery isLocalStorage isPlatformOnQuery isSignatureCheckEnabled send setLocalStorage setQueryData soundProcessing updateTimeStart isVoice

    Constructors

    Properties

    Protected Optional_platformOptions

    _platformOptions?: IAdapterOptions

    Protected Optional_token

    _token?: string
    appContext?: AppContext<unknown, string | IVkRequestContent>

    Контекст приложения

    isVoice: boolean = false

    VK — чат-платформа (не голосовая).

    limit: number = 30

    Лимит запросов/сек для входящего rateLimiter (лимит VK Callback API).

    MAX_TIME_REQUEST: number = 2900

    Максимальное время обработки запроса в миллисекундах: при его превышении в лог записывается ошибка (ответ платформе при этом не модифицируется)

    platformName: string = T_VK

    Идентификатор платформы VK.

    signatureName?: string

    Имя поля в заголовке запроса, по которому можно проверить корректность полученного запроса от платформы.

    supportedEvents: readonly TEventType[] = ...

    Универсальные события VK (для валидации addEvent): текст и callback-кнопки.

    WARNING_TIME_REQUEST: number = 2000

    Порог предупреждения в миллисекундах: при его превышении в лог записывается warning

    Methods

    Protected_initTTS

    Protected_timeLimitLog

    • _timeLimitLog(controller: BotController): void

      При превышении допустимого времени обработки запроса логирует информацию. Вызывается вручную в конце getContent() голосовых адаптеров (Alisa, Marusia, SmartApp); адаптеры чат-платформ его не вызывают.

      • >= WARNING_TIME_REQUEST (по умолчанию 2000 мс) — warning в лог.
      • >= MAX_TIME_REQUEST (по умолчанию 2900 мс) — текст ошибки пишется в controller.platformOptions.error (не в лог).

      Пороги вынесены в protected поля — при необходимости переопределите в потомке.

      Parameters

      Returns void

    • Метод, который вызывается при уничтожении плагина. В данном методе можно добавить отписку, либо выполнить другие действия.

      Parameters

      • _bot: Bot

        Основной класс приложения

      Returns void | Promise<void>

    • Формирует и отправляет ответ VK: сообщения, callback-события (sendMessageEvent/show_snackbar), карточки, клавиатуру и звуки.

      Parameters

      • controller: BotController

        Контроллер приложения

      Returns Promise<string>

      Тело ответа для webhook ('ok')

    • Формирует пример webhook-запроса VK (событие message_new) для локального тестирования (BotTest).

      Parameters

      • query: string

        Текст команды пользователя

      • userId: string

        Идентификатор пользователя (from_id)

      • count: number

        Номер сообщения (id)

      Returns Record<string, unknown>

      Заготовка запроса в формате VK Callback API

    • Инициализирует адаптер: вызывает базовую инициализацию и переносит опции конструктора (токен, confirmation_token, secret_key, api_version) в конфигурацию платформы.

      Parameters

      • appContext: AppContext

        Контекст приложения (конфиги, токены, логгер)

      Returns void

    • Проверяет секретный ключ из тела запроса VK Callback API. Если в настройках группы VK включён «Secret key», он приходит в поле secret каждого callback-запроса. Метод сверяет его со значением secret_key, сохранённым в конфигурации. Включается автоматически при наличии secret_key в tokens.vk. Если проверка включена, поле обязательно для всех событий, включая confirmation.

      Parameters

      Returns boolean

      true, если секрет совпадает или проверка не включена; false при отсутствии или несовпадении

    • Проверяет, что входящий запрос принадлежит VK Callback API. Опознаёт запрос по полям type, group_id и object/secret.

      Parameters

      • query: IVkRequestContent

        Входящий webhook-запрос

      • Optional_headers: Record<string, unknown>

        Заголовки HTTP-запроса (не используются: подпись VK приходит в теле)

      Returns boolean

      true, если запрос относится к платформе VK

    • VK проверяет поле secret в теле запроса против tokens.vk.secret_key (задаётся через опцию vk_secret_key). Токен доступа из конструктора проверку подписи не включает.

      Returns boolean

    • Отправка текста пользователю Этот метод используется для активных рассылок — когда голосовой навык или чат-бот инициирует диалог первым (например, уведомление). В методе реализована механика преобразования текстового значения controllerOrText в контроллер, а также базовый механизм для отправки ответа.

      Переопределять данный метод не рекомендуется. Переопределить стоит только в том случае, если по каким-то технических условиям текущая реализация метода вам не подходит.

      Если платформа не поддерживает возможность начать диалог самостоятельно, то можно оставить метод пустым, либо вывести любую заглушку.

      Parameters

      • userId: string | number

        Ид пользователя, которому нужно отправить сообщение

      • controllerOrText: string | BotController<IUserData, IPlatformData>

        Контроллер приложения или текст. Если необходимо отправить просто текст, можно передать строку, в случае, если необходимо передать картинку звук и тд, то необходимо корректно заполнить контроллер.

      Returns boolean | TContent

      Результат getContent() — ответ в формате платформы (TContent), либо boolean для платформ без рассылки

      // Отправка простого текста
      adapter.send('user123', 'Привет!');

      // Отправка через контроллер (текст + кнопки/карточки)
      const controller = new BaseBotController(appContext);
      controller.text = 'Уведомление';
      adapter.send('user123', controller);

    • Разбирает событие VK Callback API (confirmation / message_new / message_event) и наполняет контроллер данными; прочие события помечаются skipAutoReply.

      Parameters

      Returns Promise<boolean>

      true, если запрос успешно разобран

    • Дополнительная обработка для звуков. В данном методе стоит реализовать логику, с помощью которой будут наложены дополнительные эффекты для озвучивания текста пользователю

      Parameters

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods