Class ViberRequest

constructor

• new ViberRequest(appContext: AppContext): ViberRequest

  Создает экземпляр класса для работы с API Viber Устанавливает токен из конфигурации приложения, если он доступен

  Parameters

  • appContext: AppContext

    Контекст приложения (обязателен)

  Returns ViberRequest

apiVersion

token

buildWelcomeMessage

• buildWelcomeMessage(
      sender: string | IViberSender | null,
      text: string,
      params?: IViberParams | null,
  ): Record<string, unknown> | null

  Собирает тело приветственного сообщения (welcome message) для ответа на событие conversation_started — без отправки через REST API.

  conversation_started приходит до подписки пользователя, и send_message для неподписанного пользователя Viber отклоняет. Единственный документированный канал приветствия — JSON в теле HTTP-ответа на этот webhook: те же параметры, что у send_message, receiver не обязателен. Лимиты (sender 28 символов, текст 7000, тело 30 КБ, min_api_version) применяются те же, что при отправке.

  Parameters

  • sender: string | IViberSender | null

    Отправитель (имя/объект); если не задан — из конфигурации

  • text: string

    Текст сообщения

  • params: IViberParams | null = null

    Дополнительные параметры (клавиатура, tracking_data и т.д.)

  Returns Record<string, unknown> | null

  Тело ответа webhook либо null, если sender не задан или тело превышает 30 КБ

  Example

  const body = new ViberRequest(appContext).buildWelcomeMessage(null, 'Добро пожаловать!');
  // вернуть body в ответ на webhook conversation_started
  Copy

call

• call<T extends IViberApi>(method: string): Promise<T | null>

  Отправляет запрос к Viber API

  Исходящее тело больше 30 КБ — warn, запрос не отправляется, возвращает null.

  Type Parameters

  • T extends IViberApi

  Parameters

  • method: string

    Название метода API

  Returns Promise<T | null>

  Результат выполнения метода или null при ошибке

getUserDetails

• getUserDetails(id: string): Promise<IViberGetUserDetails | null>

  Получает информацию о пользователе Viber Запрос можно отправлять не более 2 раз в течение 12 часов для каждого пользователя

  Parameters

  • id: string

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

  Returns Promise<IViberGetUserDetails | null>

  Информация о пользователе или null при ошибке

  Возвращаемые данные:

  • id: уникальный идентификатор
  • name: имя пользователя
  • avatar: URL аватара
  • country: код страны
  • language: язык устройства
  • primary_device_os: ОС устройства
  • api_version: версия API
  • viber_version: версия Viber
  • mcc: код страны
  • mnc: код сети
  • device_type: тип устройства

initToken

• initToken(token: string): void

  Инициализирует токен доступа к Viber API

  Parameters

  • token: string

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

  Returns void

richMedia

• richMedia(
      receiver: string,
      richMedia: IViberButton[],
      params?: IViberRichMediaParams | null,
      sender?: string | IViberSender,
  ): Promise<IViberApi | null>

  Отправляет карточку с кнопками

  Parameters

  • receiver: string

    ID пользователя Viber

  • richMedia: IViberButton[]

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

  • params: IViberRichMediaParams | null = null

    Дополнительные параметры:

    • tracking_data: данные для отслеживания
    • min_api_version: минимальная версия API
    • alt_text: альтернативный текст
  • Optionalsender: string | IViberSender

    Отправитель. Если не задан, используется sender из конфигурации

  Returns Promise<IViberApi | null>

  Результат отправки или null при ошибке

sendFile

• sendFile(
      receiver: string,
      file: string,
      params?: IViberParams | null,
      sender?: string | IViberSender,
  ): Promise<IViberApi | null> | null

  Отправляет файл

  Валидации: size 1 байт–50 МБ, file_name ≤256, обязательное расширение в имени URL.

  Parameters

  • receiver: string

    ID пользователя Viber

  • file: string

    URL файла (поддерживаются только http/https-ссылки; локальные пути и содержимое не принимаются)

  • params: IViberParams | null = null

    Дополнительные параметры:

    • tracking_data: данные для отслеживания
    • min_api_version: минимальная версия API
    • file_name: имя файла
    • size: размер файла
  • Optionalsender: string | IViberSender

    Отправитель. Если не задан, используется sender из конфигурации

  Returns Promise<IViberApi | null> | null

  Результат отправки или null при ошибке

sendMessage

• sendMessage(
      receiver: string,
      sender: string | IViberSender,
      text: string,
      params?: IViberParams | null,
  ): Promise<IViberApi | null>

  Отправляет сообщение пользователю Сообщение можно отправить только после того, как пользователь подпишется на бота

  text обрезается до 7000 символов (Text.resize с warn).

  Parameters

  • receiver: string

    ID пользователя Viber

  • sender: string | IViberSender

    Информация об отправителе:

    • name: имя (до 28 символов)
    • avatar: URL аватара (до 100 Кб, 720x720)
  • text: string

    Текст сообщения

  • params: IViberParams | null = null

    Дополнительные параметры:

    • type: тип сообщения (text, picture, video, file, location, contact, sticker, url)
    • tracking_data: данные для отслеживания
    • min_api_version: минимальная версия API
    • media: URL контента
    • thumbnail: URL превью
    • size: размер файла
    • duration: длительность видео/аудио
    • file_name: имя файла
    • contact: контактная информация
    • location: координаты
    • sticker_id: ID стикера

  Returns Promise<IViberApi | null>

  Результат отправки или null при ошибке

setWebhook

• setWebhook(
      url: string,
      params?: IViberWebhookParams | null,
  ): Promise<IViberApi | null>

  Устанавливает webhook для получения событий

  При пустом url отправляется url: '' — снятие вебхука.

  Parameters

  • url: string

    URL для получения событий

  • params: IViberWebhookParams | null = null

    Дополнительные параметры:

    • event_types: типы событий
    • send_name: отправлять имя
    • send_photo: отправлять фото

  Returns Promise<IViberApi | null>

  Результат установки или null при ошибке