umbot - v2.0.8
    Preparing search index...

    Interface IAppParam

    IAppParam Параметры приложения для различных платформ

    Содержит токены и настройки для работы с различными платформами, а также тексты приветствия и помощи.

    const params: IAppParam = {
      welcome_text: 'Привет! Чем могу помочь?',
      help_text: 'Список доступных команд: ...',
      intents: [
        {
          name: 'greeting',
          slots: ['привет', 'здравствуй'],
          is_pattern: false
        }
      ]
    };
    interface IAppParam {
        viber_token?: null | string;
        viber_sender?: null | string;
        viber_api_version?: null | number;
        telegram_token?: null | string;
        vk_api_version?: null | string;
        vk_confirmation_token?: null | string;
        vk_token?: null | string;
        marusia_token?: null | string;
        yandex_token?: null | string;
        yandex_speech_kit_token?: null | string;
        y_isAuthUser?: boolean;
        app_id?: null | string;
        user_id?: null | string | number;
        welcome_text?: string | string[];
        help_text?: string | string[];
        intents: null | IAppIntent[];
        utm_text?: null | string;
    }
    Index

    Properties

    viber_token? viber_sender? viber_api_version? telegram_token? vk_api_version? vk_confirmation_token? vk_token? marusia_token? yandex_token? yandex_speech_kit_token? y_isAuthUser? app_id? user_id? welcome_text? help_text? intents utm_text?

    Properties

    viber_token?: null | string

    Токен Viber для API

    Используется для авторизации запросов к Viber API. Получается в личном кабинете разработчика Viber.

    viber_sender?: null | string

    Имя отправителя в Viber

    Имя, которое будет отображаться в сообщениях от бота. Должно быть предварительно зарегистрировано в Viber.

    viber_api_version?: null | number

    Версия Viber API

    Определяет версию API для работы с Viber. Рекомендуется использовать последнюю стабильную версию.

    telegram_token?: null | string

    Токен Telegram для API

    Используется для авторизации запросов к Telegram Bot API. Получается у BotFather при создании бота.

    vk_api_version?: null | string

    Версия VK API

    Определяет версию API для работы с ВКонтакте. По умолчанию используется v5.103

    vk_confirmation_token?: null | string

    Токен подтверждения для VK

    Используется для подтверждения вебхуков в VK. Генерируется при создании группы и настройке Callback API.

    vk_token?: null | string

    Токен VK для API

    Используется для авторизации запросов к VK API. Получается при создании Standalone-приложения в VK.

    marusia_token?: null | string

    Токен Маруси для загрузки медиа

    Используется для загрузки медиафайлов в Маруси. Получается в личном кабинете разработчика Маруси.

    yandex_token?: null | string

    Токен Яндекс.Алисы для API

    Используется для авторизации запросов к API Яндекс.Алисы. Получается в личном кабинете разработчика Яндекс.Алисы.

    yandex_speech_kit_token?: null | string

    Токен Yandex SpeechKit

    Используется для преобразования текста в речь. Получается в личном кабинете Yandex Cloud.

    y_isAuthUser?: boolean

    Флаг использования ID авторизованного пользователя Яндекса

    Актуально только для Алисы.

    app_id?: null | string

    Идентификатор приложения

    Заполняется автоматически.

    user_id?: null | string | number

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

    Заполняется автоматически.

    Optionalwelcome_text

    welcome_text?: string | string[]

    Текст приветствия

    Может быть строкой или массивом вариантов.

    Optionalhelp_text

    help_text?: string | string[]

    Текст помощи

    Может быть строкой или массивом вариантов.

    intents: null | IAppIntent[]

    Массив интентов (команд) приложения

    При использовании регулярных выражений в slots:

    • Убедитесь, что выражение безопасно и не может вызвать ReDoS
    • Используйте ограниченные квантификаторы (например, {1,5} вместо *)
    • Избегайте сложных вложенных групп
    • Тестируйте выражения на различных входных данных
    intents: [
      {
        name: 'greeting',
        slots: [
          '\\b{_value_}\\b',      // Точное совпадение слова
          '\\b{_value_}[^\\s]+\\b', // Начало слова (например, "привет" найдет "приветствие")
          '(\\b{_value_}(|[^\\s]+)\\b)', // Точное совпадение или начало слова
          '\\b(\\d{3})\\b',       // Числа от 100 до 999
          '{_value_} \\d {_value_}', // Шаблон с числом между словами
          '{_value_}'             // Любое вхождение слова
        ],
        is_pattern: true
      }
    ]

    Где {value} - это плейсхолдер, который будет заменен на конкретное значение при обработке команды. Например, если {value} = "привет", то регулярное выражение '\b{value}\b' будет искать точное совпадение слова "привет".

    Optionalutm_text

    utm_text?: null | string

    UTM-метка для ссылок

    utm_source=Yandex_Alisa&utm_medium=cpc&utm_campaign=phone

    Settings

    Member Visibility

    On This Page

    Properties