Методы
Методы Telegram Mini Apps — это события, которые выполняют некоторые предопределенные действия. Они всегда вызываются Mini App.
В этом разделе содержится список доступных методов для вызова с их именами, описанием и параметрами. В случае, если Mini App не удовлетворяет минимальному требованию версии метода, ничего не произойдет. Собственное приложение просто не знает, какой метод следует вызывать, пока он не определен внутри.
iframe_ready
iframe_readyУведомляет родительский iframe о готовности текущего фрейма. Этот метод используется только в веб-версии Telegram. В результате Mini App получит событие set_custom_style.
reload_supported
boolean
Необязательно. True, если текущее мини-приложение поддерживает собственную перезагрузку.
iframe_will_reload
iframe_will_reloadУведомляет родительский iframe о том, что текущий iframe будет перезагружен.
web_app_add_to_home_screen
web_app_add_to_home_screenПредлагает пользователю добавить Mini App на домашний экран. Обратите внимание, что если устройство не может определить статус установки, событие может не быть получено, даже если значок был добавлен.
web_app_biometry_get_info
web_app_biometry_get_infoЗапрашивает текущие настройки биометрии.
web_app_biometry_open_settings
web_app_biometry_open_settingsОткрывает настройки биометрического доступа для ботов. Полезно, когда нужно запросить биометрический доступ у пользователей, которые его еще не предоставили.
web_app_biometry_request_access
web_app_biometry_request_accessЗапрашивает разрешение на использование биометрии.
reason
string
Необязательно. Текст, который будет отображаться пользователю во всплывающем окне, описывающий, почему боту необходим доступ к биометрии, 0-128 символов.
web_app_biometry_request_auth
web_app_biometry_request_authАутентифицирует пользователя с использованием биометрии.
reason
string
Необязательно. Текст, который будет отображаться пользователю во всплывающем окне, описывающий, почему вы просите его пройти аутентификацию и какие действия вы предпримете на основе этой аутентификации, 0–128 символов.
web_app_biometry_update_token
web_app_biometry_update_tokenОбновляет биометрический токен в безопасном хранилище на устройстве. Чтобы удалить токен, передайте пустую строку.
token
string
Токен для хранения. Максимальная длина 1024 символа.
web_app_check_home_screen
web_app_check_home_screenОтправляет запрос в собственное приложение Telegram, чтобы проверить, добавлено ли текущее мини-приложение на главный экран устройства.
web_app_check_location
web_app_check_locationЗапрашивает состояние доступности функциональности, связанной с местоположением.
web_app_close
web_app_closeЗакрывает мини-приложение.
web_app_close_scan_qr_popup
web_app_close_scan_qr_popupЗакрывает QR-сканер. Приложение Telegram создает событие scan_qr_popup_closed.
web_app_data_send
web_app_data_sendОтправляет данные боту. При вызове этого метода боту отправляется служебное сообщение, содержащее данные длиной до 4096 байт. Затем Mini App будет закрыт.
data
string
Данные для отправки боту. Не должны иметь размер более 4096 байт.
web_app_exit_fullscreen
web_app_exit_fullscreenЗапрашивает выход из полноэкранного режима для мини-приложения.
web_app_expand
web_app_expandРазворачивает мини-приложение.
web_app_invoke_custom_method
web_app_invoke_custom_methodreq_id
string
Уникальный идентификатор текущего вызова.
method
string
Имя метода.
params
unknown
Параметры согласно method.
web_app_open_invoice
web_app_open_invoiceslug
string
Уникальный идентификатор счета-фактуры.
web_app_open_link
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
web_app_open_location_settingsОткрывает настройки доступа к местоположению для ботов. Полезно, когда вам нужно запросить доступ к местоположению у пользователей, которые еще не предоставили его.
web_app_open_link
web_app_open_linkОткрывает новое всплывающее окно. Когда пользователь закрывает всплывающее окно, Telegram создает событие popup_closed.
title
string
Текст, который будет отображаться в заголовке всплывающего окна, 0-64 символа.
message
string
Сообщение, которое будет отображаться в тексте всплывающего окна, от 1 до 256 символов.
buttons
PopupButton[]
Список кнопок, которые будут отображаться во всплывающем окне, 1-3 кнопки
PopupButton
id
string
Идентификатор кнопки, 0-64 символа.
type
PopupButtonType
Тип кнопки. "default", "destructive", "ok", "close", "cancel"
text
PopupButton[]
Текст, который будет отображаться на кнопке, 0-64 символа. Игнорируется, если type в ok, close или cancel.
PopupButtonType
default
Кнопка со стилем по умолчанию.
destructive
Кнопка со стилем, указывающим на деструктивное действие (например, «Удалить» и т. д.)
ok
Кнопка с локализованным текстом «ОК»
close
Кнопка с локализованным текстом «Закрыть»
cancel
Кнопка с локализованным текстом «Отмена»
Last updated