Class MaxRequest

constructor

• new MaxRequest(appContext: AppContext): MaxRequest

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

  Parameters

  • appContext: AppContext

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

  Returns MaxRequest

isAttachContent

token

answerCallback

• answerCallback(
      callbackId: string,
      text: string,
      params?: IMaxParams | null,
      dialogId?: string | number,
  ): Promise<IMaxAppApi | null>

  Отправляет результат обработки нажатия callback-кнопки MAX.

  Parameters

  • callbackId: string

    Идентификатор callback из входящего webhook

  • text: string

    Текст сообщения, отображаемого после нажатия

  • params: IMaxParams | null = null

    Клавиатура и вложения для сообщения

  • OptionaldialogId: string | number

    Идентификатор диалога для соблюдения лимита двух callback-ответов в секунду

  Returns Promise<IMaxAppApi | null>

  Ответ MAX API или null, если запрос не выполнен

  Example

  await api.answerCallback('callback-id', 'Заказ добавлен в корзину');
  Copy

call

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

  Выполняет вызов метода MAX API

  Type Parameters

  • T extends IMaxAppApi

  Parameters

  • method: string

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

  Returns Promise<T | null>

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

initToken

• initToken(token: string): void

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

  Parameters

  • token: string

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

  Returns void

messagesSend

• messagesSend(
      peerId: string | number,
      message: string,
      params?: IMaxParams | null,
      recipientType?: "user" | "chat",
  ): Promise<IMaxSendMessage | null>

  Отправляет сообщение пользователю или в чат

  Отправка идёт через очередь (waitForMaxMessageTurn): не чаще 1 сообщения в 500 мс на диалог.

  Parameters

  • peerId: string | number

    Идентификатор получателя (user_id или chat_id)

  • message: string

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

  • params: IMaxParams | null = null

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

  • recipientType: "user" | "chat" = 'user'

    'user' | 'chat' = 'user' — адресат: user_id или chat_id в query

  Returns Promise<IMaxSendMessage | null>

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

subscriptions

• subscriptions(
      url: string,
      params?: { secret?: string; update_types?: string[] } | null,
  ): Promise<IMaxAppApi | null>

  Регистрирует событие для получения уведомлений о новых сообщениях в MAX

  При невалидных аргументах (не-HTTPS URL, явный порт, secret вне [A-Za-z0-9_-]{5,256}) — warn и Promise.resolve(null) без вызова API.

  Parameters

  • url: string

    URL для получения уведомлений

  • params: { secret?: string; update_types?: string[] } | null = null

    Секрет webhook и список получаемых типов обновлений

  Returns Promise<IMaxAppApi | null>

  Ответ MAX API или null при ошибке

upload

• upload(file: string, type: TMaxUploadFile): Promise<IMaxUploadFile | null>

  Загружает файл на сервера Max

  Parameters

  • file: string

    Путь к файлу или его содержимое

  • type: TMaxUploadFile

    Тип загружаемого файла

  Returns Promise<IMaxUploadFile | null>

  Информация о загруженном файле или null при ошибке