Class ViberRequest

constructor

• new ViberRequest(): ViberRequest

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

  Returns ViberRequest

token

initToken

• initToken(token: string): void

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

  Parameters

  • token: string

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

  Returns void

call

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

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

  Type Parameters

  • T extends IViberApi

  Parameters

  • method: string

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

  Returns Promise<null | T>

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

getUserDetails

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

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

  Parameters

  • id: string

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

  Returns Promise<null | IViberGetUserDetails>

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

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

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

sendMessage

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

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

  Parameters

  • receiver: string

    ID пользователя Viber
  • sender: string | IViberSender

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

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

    Текст сообщения
  • params: null | IViberParams = null

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

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

  Returns Promise<null | IViberApi>

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

setWebhook

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

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

  Parameters

  • url: string

    URL для получения событий
  • params: null | IViberWebhookParams = null

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

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

  Returns Promise<null | IViberApi>

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

richMedia

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

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

  Parameters

  • receiver: string

    ID пользователя Viber
  • richMedia: IViberButton[]

    Массив кнопок для отображения
  • params: null | IViberRichMediaParams = null

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

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

  Returns Promise<null | IViberApi>

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

sendFile

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

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

  Parameters

  • receiver: string

    ID пользователя Viber
  • file: string

    Путь к файлу или его содержимое
  • params: null | IViberParams = null

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

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

  Returns null | Promise<null | IViberApi>

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