Методы

Методы Telegram Mini Apps — это события, которые выполняют некоторые предопределенные действия. Они всегда вызываются Mini App.

В этом разделе содержится список доступных методов для вызова с их именами, описанием и параметрами. В случае, если Mini App не удовлетворяет минимальному требованию версии метода, ничего не произойдет. Собственное приложение просто не знает, какой метод следует вызывать, пока он не определен внутри.

`iframe_ready`

Уведомляет родительский iframe о готовности текущего фрейма. Этот метод используется только в веб-версии Telegram. В результате Mini App получит событие set_custom_style.

Поле

Тип

Описание

reload_supported

boolean

Необязательно. True, если текущее мини-приложение поддерживает собственную перезагрузку.

`iframe_will_reload`

Уведомляет родительский iframe о том, что текущий iframe будет перезагружен.

`web_app_add_to_home_screen`

Минимальная версия Telegram API: 8.0+

Предлагает пользователю добавить Mini App на домашний экран. Обратите внимание, что если устройство не может определить статус установки, событие может не быть получено, даже если значок был добавлен.

`web_app_biometry_get_info`

Минимальная версия Telegram API: 7.2+

Запрашивает текущие настройки биометрии.

`web_app_biometry_open_settings`

Минимальная версия Telegram API: 7.2+

Этот метод может быть вызван только в ответ на взаимодействие пользователя с интерфейсом мини-приложения (например, щелчок внутри мини-приложения или на главной кнопке).

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

`web_app_biometry_request_access`

Минимальная версия Telegram API: 7.2+

Запрашивает разрешение на использование биометрии.

Поле

Тип

Описание

reason

string

Необязательно. Текст, который будет отображаться пользователю во всплывающем окне, описывающий, почему боту необходим доступ к биометрии, 0-128 символов.

`web_app_biometry_request_auth`

Минимальная версия Telegram API: 7.2+

Аутентифицирует пользователя с использованием биометрии.

Поле

Тип

Описание

reason

string

Необязательно. Текст, который будет отображаться пользователю во всплывающем окне, описывающий, почему вы просите его пройти аутентификацию и какие действия вы предпримете на основе этой аутентификации, 0–128 символов.

`web_app_biometry_update_token`

Минимальная версия Telegram API: 7.2+

Обновляет биометрический токен в безопасном хранилище на устройстве. Чтобы удалить токен, передайте пустую строку.

Поле

Тип

Описание

token

string

Токен для хранения. Максимальная длина 1024 символа.

`web_app_check_home_screen`

Минимальная версия Telegram API: 8.0+

Отправляет запрос в собственное приложение Telegram, чтобы проверить, добавлено ли текущее мини-приложение на главный экран устройства.

`web_app_check_location`

Минимальная версия Telegram API: 8.0+

Запрашивает состояние доступности функциональности, связанной с местоположением.

`web_app_close`

Закрывает мини-приложение.

`web_app_close_scan_qr_popup`

Минимальная версия Telegram API: 6.4+

Закрывает QR-сканер. Приложение Telegram создает событие scan_qr_popup_closed.

`web_app_data_send`

Отправляет данные боту. При вызове этого метода боту отправляется служебное сообщение, содержащее данные длиной до 4096 байт. Затем Mini App будет закрыт.

Чтобы получить больше информации, взгляните на поле web_app_data в классе Message.

Поле

Тип

Описание

data

string

Данные для отправки боту. Не должны иметь размер более 4096 байт.

`web_app_exit_fullscreen`

Минимальная версия Telegram API: 8.0+

Запрашивает выход из полноэкранного режима для мини-приложения.

`web_app_expand`

Разворачивает мини-приложение.

`web_app_invoke_custom_method`

Минимальная версия Telegram API: 6.9+

Поле

Тип

Описание

req_id

string

Уникальный идентификатор текущего вызова.

method

string

Имя метода.

params

unknown

Параметры согласно method.

`web_app_open_invoice`

Минимальная версия Telegram API: 6.1+

Открывает счет-фактуру по указанному слагу. Подробнее о счетах-фактурах в этой документации.

Поле

Тип

Описание

slug

string

Уникальный идентификатор счета-фактуры.

`web_app_open_link`

Открывает ссылку в браузере по умолчанию. Мини-приложение не будет закрыто.

Поле

Тип

Описание

url

string

URL-адрес, который должен быть открыт приложением Telegram. Должен быть полным путем с протоколом https.

try_instant_view

boolean

[v6.4] Необязательно. Ссылка будет открыта в режиме мгновенного просмотра, если это возможно.

try_browser

boolean

[v7.6] Необязательно. Ссылка будет открыта в браузере, если это возможно.

`web_app_open_location_settings`

Минимальная версия Telegram API: 8.0+

Обратите внимание, что этот метод может быть вызван только в ответ на взаимодействие пользователя с интерфейсом мини-приложения (например, щелчок внутри мини-приложения или на главной кнопке).

Открывает настройки доступа к местоположению для ботов. Полезно, когда вам нужно запросить доступ к местоположению у пользователей, которые еще не предоставили его.

`web_app_open_popup`

Минимальная версия Telegram API: 6.2+

Открывает новое всплывающее окно. Когда пользователь закрывает всплывающее окно, Telegram создает событие popup_closed.

Поле

Тип

Описание

title

string

Текст, который будет отображаться в заголовке всплывающего окна, 0-64 символа.

message

string

Сообщение, которое будет отображаться в тексте всплывающего окна, от 1 до 256 символов.

buttons

PopupButton[]

Список кнопок, которые будут отображаться во всплывающем окне, 1-3 кнопки

PopupButton

Поле

Тип

Описание

string

Идентификатор кнопки, 0-64 символа.

type

PopupButtonType

Тип кнопки. "default", "destructive", "ok", "close", "cancel"

text

PopupButton[]

Текст, который будет отображаться на кнопке, 0-64 символа. Игнорируется, если type в ok, close или cancel.

PopupButtonType

Тип

Описание

default

Кнопка со стилем по умолчанию.

destructive

Кнопка со стилем, указывающим на деструктивное действие (например, «Удалить» и т. д.)

Кнопка с локализованным текстом «ОК»

Кнопка с локализованным текстом «Закрыть»

cancel

Кнопка с локализованным текстом «Отмена»

`web_app_open_scan_qr_popup`

Минимальная версия Telegram API: 6.4+

Открывает QR-сканер. Когда сканер был закрыт, приложение Telegram создает событие scan_qr_popup_closed. Когда сканер считывает QR, Telegram создает событие qr_text_received.

Поле

Тип

Описание

text

string

Необязательно. Текст, который будет отображаться в QR-сканере.

PreviousTelegram Bridge NextФункции

Last updated 11 days ago