Все методы

Все методы слоя 223, сгруппированные по темам — всего 757. Однострочные описания взяты из индекса API; ошибки, которые метод может вернуть, лежат на его собственной странице и собраны из исходников нашего сервера.

Принятие условий использования

МетодОписание
help.getTermsOfServiceUpdate Проверить, не обновились ли условия использования Ansible.
help.acceptTermsOfService Принять новые условия использования.

Спам и нарушения правил

МетодОписание
account.reportPeer Пожаловаться на собеседника или чат за нарушение условий использования.
account.reportProfilePhoto Пожаловаться на фотографию профиля.
channels.reportSpam Пожаловаться на сообщения участника супергруппы как на спам. Нужны права администратора.
messages.report Пожаловаться на сообщение в чате за нарушение условий использования.
messages.reportSpam Пожаловаться на новый входящий чат как на спам — если настройки чата это позволяют.
messages.reportEncryptedSpam Пожаловаться на секретный чат как на спам.

Получение конфигурации

МетодОписание
help.getAppConfig Получить конфигурацию приложения — настройки, которыми сервер управляет поведением клиента.
help.getAppUpdate Узнать, доступно ли обновление для текущего приложения.
help.getConfig Получить текущую конфигурацию, включая список дата-центров.
help.getInviteText Получить локализованный текст приглашения.
help.getNearestDc Узнать ближайший к пользователю дата-центр.
help.getSupport Получить аккаунт поддержки для функции «задать вопрос».
help.getSupportName Получить локализованное имя аккаунта поддержки.
help.getCountriesList Список стран: название, код ISO, локализованное название, телефонные коды и форматы номеров.
help.dismissSuggestion Скрыть подсказку, чтобы сервер её больше не предлагал.

Вход по QR-коду

МетодОписание
auth.exportLoginToken Сгенерировать токен входа для авторизации по QR-коду. Токен кодируется в base64url и показывается как диплинк в QR-коде.
auth.acceptLoginToken Принять токен входа по QR-коду и авторизовать приложение, которое его показало. Возвращает сведения о новой сессии.
auth.importLoginToken Войти по перенаправленному токену — он выдаётся, когда при входе по QR-коду дата-центры не совпали.

Разное

МетодОписание
help.saveAppLog Отправить логи приложения на сервер.
initConnection Инициализировать соединение: сообщить серверу об устройстве, версии приложения и языке.
invokeAfterMsg Выполнить запрос после успешного завершения одного из предыдущих.
invokeAfterMsgs Выполнить запрос после успешного завершения нескольких предыдущих.
invokeWithLayer Выполнить запрос в указанном слое схемы.
invokeWithoutUpdates Выполнить запрос, не подписывая соединение на апдейты. Для файловых запросов это поведение включено по умолчанию.
invokeWithGooglePlayIntegrity Только для официальных клиентов: выполнить запрос с токеном Google Play Integrity.
invokeWithApnsSecret Только для официальных клиентов: выполнить запрос с проверкой Apple Push.
invokeWithReCaptcha Только для официальных клиентов: повторить вызов, потребовавший проверки reCAPTCHA.

Регистрация и авторизация

МетодОписание
auth.bindTempAuthKey Привязать временный ключ авторизации к постоянному — механизм совершенной прямой секретности.
auth.cancelCode Отменить код подтверждения входа.
account.sendVerifyEmailCode Отправить код подтверждения на почту.
account.verifyEmail Подтвердить адрес электронной почты.
auth.resetLoginEmail Сбросить почту, на которую приходит код входа.
auth.checkPassword Войти в аккаунт, защищённый паролем двухфакторной защиты.
account.resetPassword Начать сброс пароля двухфакторной защиты. Доступно только вошедшему пользователю.
auth.checkRecoveryPassword Проверить код восстановления пароля до того, как передавать его в auth.recoverPassword.
auth.dropTempAuthKeys Удалить все временные ключи авторизации, кроме перечисленных.
auth.exportAuthorization Получить данные для переноса авторизации в другой дата-центр.
auth.importAuthorization Войти по ключу, полученному из домашнего дата-центра пользователя.
auth.importBotAuthorization Войти как бот.
account.changeAuthorizationSettings Изменить настройки конкретной сессии.
account.setAuthorizationTTL Задать срок жизни текущей сессии.
auth.logOut Выйти из аккаунта.
auth.recoverPassword Сбросить пароль двухфакторной защиты по коду восстановления.
auth.requestPasswordRecovery Запросить код восстановления пароля. Работает только если к аккаунту привязана почта.
auth.resendCode Отправить код входа другим способом. Каким именно — определяет ответ предыдущего вызова.
auth.resetAuthorizations Завершить все сессии пользователя, кроме текущей. После этого устройство нужно зарегистрировать заново через account.registerDevice.
auth.sendCode Отправить код подтверждения для входа.
auth.reportMissingCode Только для официальных приложений: сообщить, что код в SMS не пришёл.
auth.signIn Войти с подтверждённым номером телефона.
auth.signUp Зарегистрировать подтверждённый номер телефона в системе.
auth.requestFirebaseSms Запросить SMS-код через Firebase.
auth.importWebTokenAuthorization Войти, импортировав веб-токен авторизации.
account.invalidateSignInCodes Аннулировать перечисленные коды входа.
auth.checkPaidAuth Проверить статус оплаты платной авторизации.

Задания на отправку SMS

МетодОписание
smsjobs.isEligibleToJoin Проверить, можем ли мы обрабатывать задания на отправку SMS. Только для официальных клиентов.
smsjobs.join Включить обработку заданий на отправку SMS. Только для официальных клиентов.
smsjobs.leave Выключить обработку заданий на отправку SMS. Только для официальных клиентов.
smsjobs.updateSettings Изменить настройки обработки SMS-заданий. Только для официальных клиентов.
smsjobs.getStatus Получить статус обработки SMS-заданий. Только для официальных клиентов.
smsjobs.getSmsJob Получить сведения о задании на отправку SMS. Только для официальных клиентов.
smsjobs.finishJob Завершить задание на отправку SMS. Только для официальных клиентов.

TSF (только для внутреннего использования)

МетодОписание
help.editUserInfo Внутренний метод.
help.getUserInfo Внутренний метод: получение служебной информации сотрудниками.

Коды подтверждения через шлюз

МетодОписание
messages.reportMessagesDelivery Сообщить серверу, что сообщения доставлены клиенту — используется для сообщений с кодами подтверждения.

Подписка

МетодОписание
help.getPremiumPromo Получить рекламные материалы подписки.
payments.assignAppStoreTransaction Сообщить серверу о покупке через App Store. Только для официальных приложений.
payments.assignPlayMarketTransaction Сообщить серверу о покупке через Play Store. Только для официальных приложений.
payments.canPurchaseStore Проверить, возможна ли покупка. Вызывается до покупки в сторе, только для официальных приложений.

Двухфакторная защита

МетодОписание
account.confirmPasswordEmail Подтвердить почту как способ восстановления пароля двухфакторной защиты.
account.resendPasswordEmail Переотправить код подтверждения почты для восстановления пароля.
account.cancelPasswordEmail Отменить код подтверждения почты для восстановления пароля.
account.getPassword Получить параметры двухфакторной защиты паролем.
account.getPasswordSettings Получить закрытые данные, связанные с паролем: почта восстановления, паспортные данные и прочее.
account.updatePasswordSettings Задать новый пароль двухфакторной защиты.
account.declinePasswordReset Отменить начатый сброс пароля двухфакторной защиты.

Сквозное шифрование в конференциях

МетодОписание
phone.createConferenceCall Создать конференцию и при желании сразу к ней присоединиться.
phone.deleteConferenceCallParticipants Убрать участников из конференции. Должен быть выставлен ровно один из флагов only_left и kick.
phone.sendConferenceCallBroadcast Отправить проверочное сообщение в служебную подцепочку конференции.
phone.sendGroupCallEncryptedMessage Отправить всем участникам конференции сообщение или реакцию, зашифрованные сквозным шифрованием. Только для конференций.
phone.inviteConferenceCallParticipant Пригласить пользователя в конференцию.
phone.declineConferenceCallInvite Отклонить приглашение в конференцию.
phone.getGroupCallChainBlocks Получить блоки из подцепочки конференции. Если блоков вернулось ровно limit, метод нужно вызвать снова сразу после обработки.

Коллекционные объекты Fragment

МетодОписание
fragment.getCollectibleInfo Получить сведения о коллекционном объекте Fragment.

GIF-анимации

МетодОписание
messages.getSavedGifs Получить сохранённые GIF-анимации.
messages.saveGif Добавить GIF в список сохранённых.

Главные мини-приложения и их каталог

МетодОписание
bots.getPopularAppBots Получить популярные главные мини-приложения для вкладки приложений в глобальном поиске.
bots.addPreviewMedia Добавить превью главного мини-приложения. Только владельцу бота с настроенным главным мини-приложением.
bots.editPreviewMedia Изменить превью главного мини-приложения. Только владельцу бота.
bots.deletePreviewMedia Удалить превью главного мини-приложения. Только владельцу бота.
bots.reorderPreviewMedias Изменить порядок превью главного мини-приложения. Только владельцу бота.
bots.getPreviewInfo Получить сведения о превью главного мини-приложения. Метод рассчитан на владельца бота: для остальных он ведёт себя как bots.getPreviewMedias.
bots.getPreviewMedias Получить превью главного мини-приложения.
messages.requestMainWebView Открыть главное мини-приложение.

Мини-приложения ботов

МетодОписание
messages.requestWebView Открыть мини-приложение бота, передав ему сведения о пользователе после подтверждения. Пока окно открыто, каждые 60 секунд нужно вызывать messages.prolongWebView.
messages.prolongWebView Сообщить серверу, что пользователь всё ещё работает с мини-приложением. Если метод вернул QUERY_ID_INVALID, окно нужно закрыть.
messages.requestSimpleWebView Открыть мини-приложение бота.
messages.sendWebViewResultMessage Завершить работу с мини-приложением и отправить в чат сообщение от имени пользователя.
messages.sendWebViewData Передать боту данные из открытой мини-аппликации, привязанной к клавиатуре ответа.
messages.requestAppWebView Открыть мини-приложение бота по прямому диплинку, передав ему сведения о пользователе после подтверждения. Пока окно открыто, каждые 60 секунд нужно вызывать messages.prolongWebView.
messages.getBotApp Получить сведения о мини-приложении, открываемом по прямой ссылке.
bots.canSendMessage Проверить, может ли указанный бот писать нам.
bots.allowSendMessage Разрешить указанному боту писать нам.
bots.invokeWebViewCustomMethod Отправить произвольный запрос из мини-приложения боту. Ответ возвращается событием custom_method_invoked.
bots.checkDownloadFileParams Проверить, может ли мини-приложение запросить скачивание конкретного файла.

Вход через OAuth

МетодОписание
messages.requestUrlAuth Получить сведения о запросе на бесшовный вход через Ansible.
messages.acceptUrlAuth Подтвердить запрос на бесшовный вход через Ansible.
account.getWebAuthorizations Получить список авторизаций через виджет входа на сайтах.
account.resetWebAuthorization Завершить одну активную веб-сессию входа через Ansible.
account.resetWebAuthorizations Завершить все активные веб-сессии входа через Ansible.
messages.declineUrlAuth Отклонить входящий запрос OAuth-авторизации, сообщив серверу об отказе пользователя.
messages.checkUrlAuthMatchCode Сверить код, выбранный пользователем, с кодом на странице входа. Часть потока OAuth-авторизации.

Служебные объявления, прокси-каналы и рекомендации

МетодОписание
help.hidePromoData Скрыть служебное объявление или сведения о прокси.
help.getPromoData Получить подсказки, служебные объявления и рекомендованные каналы.

Ссылки на чат для бизнес-аккаунтов

МетодОписание
account.createBusinessChatLink Создать диплинк на чат для бизнес-аккаунта.
account.editBusinessChatLink Изменить диплинк на чат для бизнес-аккаунта.
account.deleteBusinessChatLink Удалить диплинк на чат для бизнес-аккаунта.
account.getBusinessChatLinks Получить список созданных диплинков на чат.
account.resolveBusinessChatLink Разрешить диплинк на чат бизнес-аккаунта.

Боты, подключённые к бизнес-аккаунту

МетодОписание
account.updateConnectedBot Подключить бизнес-бота к аккаунту или изменить настройки подключения.
account.getConnectedBots Получить список подключённых бизнес-ботов.
account.toggleConnectedBotPaused Приостановить или возобновить работу бизнес-ботов в конкретном чате.
account.disablePeerConnectedBot Навсегда отключить конкретный чат от всех бизнес-ботов. Вернуть его можно только переподключив бота целиком.
account.getBotBusinessConnection Боту: получить сведения о бизнес-подключении по его идентификатору. Нужно, когда бот получает сообщения от подключения, о котором ещё ничего не знает.
invokeWithBusinessConnection Выполнить запрос от имени бизнес-подключения бота.

Приветствия и автоответы бизнес-аккаунта

МетодОписание
account.updateBusinessGreetingMessage Задать приветственные сообщения бизнес-аккаунта.
account.updateBusinessAwayMessage Задать автоответы бизнес-аккаунта на время отсутствия.

Часы работы бизнес-аккаунта

МетодОписание
account.updateBusinessWorkHours Задать часы работы бизнес-аккаунта. Вызов без поля business_work_hours убирает их полностью.

Быстрые ответы бизнес-аккаунта

МетодОписание
messages.getQuickReplies Получить сведения обо всех быстрых ответах.
messages.reorderQuickReplies Изменить порядок быстрых ответов. Другим сессиям уйдёт апдейт updateQuickReplies.
messages.checkQuickReplyShortcut Проверить, не достигнуты ли лимиты, до того как предлагать пользователю добавить сообщение в быстрый ответ.
messages.editQuickReplyShortcut Переименовать быстрый ответ. Другим сессиям уйдёт апдейт updateQuickReplies.
messages.deleteQuickReplyShortcut Полностью удалить быстрый ответ. Другим сессиям уйдёт апдейт updateDeleteQuickReply.
messages.getQuickReplyMessages Получить сообщения быстрого ответа — все или часть.
messages.sendQuickReplyMessages Отправить быстрый ответ.
messages.deleteQuickReplyMessages Удалить одно или несколько сообщений из быстрого ответа.

Подарки и коллекционные подарки

МетодОписание
payments.getStarGifts Получить список доступных подарков.
payments.saveStarGift Показать полученный подарок в профиле или убрать его оттуда.
payments.convertStarGift Обменять полученный подарок на внутреннюю валюту. Подарок при этом уничтожается безвозвратно, а начисленная сумма может быть меньше цены покупки.
payments.getStarGiftUpgradePreview Посмотреть, какие свойства подарок может случайно получить при превращении в коллекционный.
payments.upgradeStarGift Превратить подарок в коллекционный. Работает, только если улучшение уже оплачено отправителем.
payments.transferStarGift Передать коллекционный подарок другому пользователю или каналу. Работает, только если передача бесплатна.
payments.getUniqueStarGift Получить сведения о коллекционном подарке по адресу из ссылки.
payments.getSavedStarGifts Получить все подарки, которыми владеет собеседник или канал. Метод возвращает и закреплённые в профиле, и остальные — в зависимости от флагов.
payments.getSavedStarGift Получить сведения о конкретных подарках, принадлежащих нам. Метод возвращает и закреплённые в профиле, и остальные.
payments.getStarGiftWithdrawalUrl Перевести коллекционный подарок в NFT на блокчейне TON.
payments.toggleChatStarGiftNotifications Включить или выключить уведомления о подарках, приходящих каналу. Только для администраторов с правом публикации.
payments.toggleStarGiftsPinnedToTop Закрепить полученный подарок наверху профиля пользователя или канала.
payments.getResaleStarGifts Получить коллекционные подарки заданного типа, выставленные на перепродажу. Флаги сортировки по цене и по номеру взаимоисключающие; без них сортировка по времени последнего изменения цены.
payments.updateStarGiftPrice Выставить принадлежащий нам коллекционный подарок на продажу или изменить его цену.
payments.getUniqueStarGiftValueInfo Получить сведения об оценочной стоимости коллекционного подарка.
payments.checkCanSendGift Проверить, можно ли отправить указанный подарок.
payments.resolveStarGiftOffer Принять или отклонить полученное предложение о покупке коллекционного подарка.
payments.sendStarGiftOffer Отправить предложение о покупке коллекционного подарка.
payments.getStarGiftUpgradeAttributes Получить полный список коллекционных свойств, которые может получить подарок этого типа. В ответе могут быть модели с флагом crafted — они предназначены для сборки и в обычном предпросмотре улучшения не показываются.
payments.getCraftStarGifts Получить принадлежащие нам коллекционные подарки заданного типа, пригодные для сборки.
payments.craftStarGift Собрать новый коллекционный подарок из одного-четырёх своих подарков того же базового типа. Все они должны быть пригодны для сборки и не находиться на блокчейне TON.

Подписки за внутреннюю валюту

МетодОписание
payments.getStarsSubscriptions Получить список активных, истёкших и отменённых подписок за внутреннюю валюту.
payments.changeStarsSubscription Включить или отключить подписку за внутреннюю валюту.
payments.fulfillStarsSubscription Вернуться в закрытый канал, привязанный к активной подписке.
payments.botCancelStarsSubscription Отменить подписку на бота.

Внутренняя валюта

МетодОписание
payments.getStarsTopupOptions Получить список вариантов пополнения внутренней валюты.
payments.getStarsStatus Узнать баланс внутренней валюты: свой, бота или канала.
payments.getStarsTransactions Получить операции с внутренней валютой. Флаги входящих и исходящих взаимоисключающие; без них возвращаются и те и другие.
payments.sendStarsForm Оплатить внутренней валютой.
payments.refundStarsCharge Вернуть платёж во внутренней валюте.
payments.getStarsRevenueStats Получить статистику доходов во внутренней валюте.
payments.getStarsRevenueWithdrawalUrl Вывести средства с баланса канала или бота.
payments.getStarsRevenueAdsAccountUrl Получить ссылку на рекламный кабинет, оплачиваемый внутренней валютой указанного канала или бота.
payments.getStarsTransactionsByID Получить сведения об операциях с внутренней валютой по их идентификаторам.
payments.getStarsGiftOptions Получить список вариантов подарка внутренней валюты.

Звонки

МетодОписание
phone.acceptCall Принять входящий звонок.
phone.confirmCall Завершить обмен ключами сквозного шифрования для звонка.
phone.discardCall Отклонить входящий звонок или завершить текущий.
phone.getCallConfig Устарело: получить конфигурацию звонка для старой голосовой библиотеки.
phone.receivedCall Сообщить серверу, что пользователь занят разговором. Входящие звонки будут отклоняться автоматически до конца текущего.
phone.requestCall Начать звонок.
phone.saveCallDebug Отправить на сервер отладочные данные о звонке.
phone.sendSignalingData Передать сигнальные данные текущего звонка.
phone.setCallRating Оценить качество звонка. Возвращает сведения об отправленном сообщении с оценкой.
phone.saveCallLog Устарело: отправить журнал звонка из старой голосовой библиотеки.
messages.deletePhoneCallHistory Удалить всю историю звонков.

Цвета оформления профиля

МетодОписание
help.getPeerColors Получить набор цветовых палитр для оформления сообщений.
help.getPeerProfileColors Получить набор цветовых палитр для фона страницы профиля.
account.updateColor Изменить цвет оформления и фоновое эмодзи своего профиля.
channels.updateColor Изменить цвет оформления и фоновое эмодзи канала.
account.getDefaultBackgroundEmojis Получить подборку эмодзи, подходящих для узора цветового оформления.

Партнёрские программы

МетодОписание
payments.getConnectedStarRefBots Получить все партнёрские подключения, созданные для указанного профиля.
payments.getConnectedStarRefBot Получить сведения о конкретном партнёрском подключении к боту.
payments.getSuggestedStarRefBots Получить подборку мини-приложений с доступными партнёрскими программами. Сортировки по доходу и по дате взаимоисключающие; без них сортировка по прибыльности.
payments.connectStarRefBot Присоединиться к партнёрской программе бота.
payments.editConnectedStarRefBot Выйти из партнёрской программы бота.
bots.updateStarRefProgram Создать, изменить или удалить партнёрскую программу своего бота.

Анимированные кубики

МетодОписание
messages.getEmojiGameInfo Получить сведения об игре с кубиками.

Бусты каналов

МетодОписание
premium.getBoostsList Получить сведения о бустах, применённых к каналу или супергруппе. Только для администраторов.
premium.getMyBoosts Узнать, какие каналы мы бустим и сколько слотов буста осталось.
premium.applyBoost Применить один или несколько бустов к каналу.
premium.getBoostsStatus Узнать текущее количество бустов канала или супергруппы.
premium.getUserBoosts Получить список бустов, применённых к каналу конкретным пользователем. Только для администраторов.
channels.setBoostsToUnblockRestrictions Разрешить участникам, набравшим нужное число бустов, обходить медленный режим и другие ограничения группы. Только для администраторов с правом блокировки.

Значки верификации от ботов

МетодОписание
bots.setCustomVerification Подтвердить пользователя или чат от имени организации.
bots.getBotRecommendations Получить список похожих ботов, подобранных по пересечению аудиторий.

Рекомендации каналов

МетодОписание
channels.getChannelRecommendations Получить список похожих публичных каналов, подобранных по пересечению аудиторий.

Каналы, супергруппы и геогруппы

МетодОписание
channels.createChannel Создать канал или супергруппу.
channels.getInactiveChannels Получить список неактивных каналов и супергрупп.
channels.deleteChannel Удалить канал или супергруппу.
channels.deleteHistory Удалить историю супергруппы.
channels.deleteMessages Удалить сообщения в канале или супергруппе.
channels.deleteParticipantHistory Удалить все сообщения конкретного участника супергруппы.
channels.editAdmin Изменить права администратора у участника канала или супергруппы.
channels.editBanned Заблокировать, разблокировать или исключить участника канала или супергруппы.
channels.editLocation Изменить местоположение геогруппы.
channels.editPhoto Сменить фотографию канала или супергруппы.
channels.editTitle Изменить название канала или супергруппы.
channels.exportMessageLink Получить ссылку на сообщение в канале или супергруппе и данные для встраивания.
channels.getAdminLog Получить журнал действий администраторов канала или супергруппы.
channels.getAdminedPublicChannels Получить каналы и супергруппы, где мы администратор. Обычно вызывается, когда пользователь упёрся в лимит собственных публичных каналов.
channels.getChannels Получить сведения о каналах и супергруппах.
channels.getFullChannel Получить полные сведения о супергруппе, гигагруппе или канале.
channels.getGroupsForDiscussion Получить группы, пригодные для обсуждений. Обычные группы придётся сначала превратить в супергруппы.
channels.getMessages Получить сообщения канала или супергруппы.
channels.getParticipant Получить сведения об участнике канала или супергруппы.
channels.getParticipants Получить участников канала или супергруппы.
channels.inviteToChannel Пригласить пользователей в канал или супергруппу.
channels.joinChannel Вступить в канал или супергруппу.
channels.leaveChannel Выйти из канала или супергруппы.
channels.readHistory Отметить историю канала или супергруппы прочитанной.
channels.readMessageContents Отметить содержимое сообщений просмотренным. Отправляет апдейт updateChannelReadMessagesContents.
channels.setDiscussionGroup Привязать группу к каналу как группу обсуждений.
channels.setStickers Привязать набор стикеров к супергруппе.
channels.togglePreHistoryHidden Показать или скрыть историю сообщений для новых участников.
channels.toggleSignatures Включить или выключить подписи авторов в канале.
channels.toggleSlowMode Включить медленный режим: участник сможет отправлять не чаще одного сообщения за указанное число секунд.
channels.toggleParticipantsHidden Скрыть или показать список участников супергруппы. Доступно, только если участников не меньше установленного минимума.

Приглашения и заявки на вступление

МетодОписание
messages.exportChatInvite Создать пригласительную ссылку на чат.
messages.getExportedChatInvite Получить сведения о пригласительной ссылке.
messages.getExportedChatInvites Получить сведения о пригласительных ссылках чата.
messages.editExportedChatInvite Изменить пригласительную ссылку.
messages.deleteRevokedExportedChatInvites Удалить все отозванные пригласительные ссылки.
messages.deleteExportedChatInvite Удалить пригласительную ссылку.
messages.getAdminsWithInvites Получить сведения о ссылках, созданных администраторами.
messages.getChatInviteImporters Получить список тех, кто вступил по конкретной пригласительной ссылке.
messages.checkChatInvite Проверить пригласительную ссылку и получить основные сведения о чате.
messages.importChatInvite Вступить в закрытый чат, супергруппу или канал по пригласительной ссылке.
messages.hideChatJoinRequest Одобрить или отклонить заявку на вступление в чат.
messages.hideAllChatJoinRequests Одобрить или отклонить все заявки на вступление в чат.
channels.toggleJoinToSend Задать, обязаны ли участники вступать в группу обсуждений, чтобы комментировать посты.
channels.toggleJoinRequest Задать, нужно ли одобрение администратора для вступления в группу.

Чаты, супергруппы и каналы

МетодОписание
messages.getMessageReadParticipants Узнать, кто прочитал сообщение. Работает в группах меньше установленного порога, и отметки хранятся ограниченное время.
messages.addChatUser Добавить пользователя в чат и отправить об этом служебное сообщение.
messages.createChat Создать чат.
messages.deleteChatUser Удалить пользователя из чата и отправить об этом служебное сообщение.
messages.editChatAbout Изменить описание группы, супергруппы или канала.
messages.editChatAdmin Назначить участника администратором обычной группы.
messages.editChatDefaultBannedRights Изменить права участников по умолчанию для группы, супергруппы или канала.
messages.editChatPhoto Сменить фотографию чата и отправить об этом служебное сообщение.
messages.editChatTitle Изменить название чата и отправить об этом служебное сообщение.
messages.getChats Получить основные сведения о чатах по их идентификаторам.
messages.deleteChat Удалить чат.
messages.getCommonChats Получить общие чаты с пользователем.
messages.getFullChat Получить полные сведения об обычной группе.
messages.migrateChat Превратить обычную группу в супергруппу.
channels.convertToGigagroup Превратить супергруппу в гигагруппу.
channels.setEmojiStickers Задать набор своих эмодзи для супергруппы. Доступно после достижения нужного уровня бустов.
messages.editChatCreator Передать владение группой, супергруппой или каналом другому пользователю.
messages.getFutureChatCreatorAfterLeave Только владельцу: узнать, кто станет новым владельцем, если мы выйдем из группы.

Облачные темы оформления

МетодОписание
account.updateTheme Изменить тему оформления.
account.uploadTheme Загрузить файл темы оформления.
account.getThemes Получить установленные темы оформления.
account.createTheme Создать тему оформления.
account.installTheme Установить тему оформления.
account.saveTheme Сохранить тему оформления.
account.getTheme Получить сведения о теме оформления.
account.getChatThemes Получить все доступные темы оформления чата.
account.getUniqueGiftChatThemes Получить темы оформления чата, связанные с принадлежащими нам коллекционными подарками.
messages.setChatTheme Сменить тему оформления конкретного чата.

Аукционы коллекционных подарков

МетодОписание
payments.getStarGiftAuctionState Получить состояние аукциона коллекционных подарков и подписаться на его обновления.
payments.getStarGiftAuctionAcquiredGifts Получить подарки, выигранные нами на аукционах.
payments.getStarGiftActiveAuctions Получить все идущие аукционы, в которых мы делали ставку — включая те, где ставку перебили и вернули.

Защита содержимого от копирования

МетодОписание
messages.toggleNoForwards Включить или выключить защиту содержимого от пересылки в канале, группе или личном чате.

Свои анимированные эмодзи

МетодОписание
messages.getCustomEmojiDocuments Получить свои анимированные эмодзи. Возвращает документы в формате анимации вместе с исходным эмодзи в атрибуте.
messages.getEmojiStickers Получить установленные наборы своих эмодзи.
messages.getFeaturedEmojiStickers Получить рекомендованные наборы своих эмодзи.
messages.searchCustomEmoji Найти свои эмодзи, связанные с обычным эмодзи.
account.getDefaultProfilePhotoEmojis Получить подборку эмодзи, пригодных в качестве фотографии профиля.
account.getDefaultGroupPhotoEmojis Получить подборку эмодзи, пригодных в качестве фотографии группы.

Диплинки

МетодОписание
messages.startBot Начать разговор с ботом, передав ему параметр из диплинка.
help.getDeepLinkInfo Получить сведения о диплинке, который клиент не умеет обрабатывать.
help.getRecentMeUrls Получить недавно использованные короткие ссылки.

Черновики

МетодОписание
messages.clearAllDrafts Удалить все черновики.
messages.getAllDrafts Получить все черновики — приходят апдейтами updateDraftMessage по каждому чату.
messages.saveDraft Сохранить черновик сообщения для чата.

Категории эмодзи

МетодОписание
messages.getEmojiStickerGroups Получить категории эмодзи для выбора стикера.
messages.getEmojiGroups Получить категории эмодзи.
messages.getEmojiStatusGroups Получить категории эмодзи для выбора эмодзи-статуса.
messages.getEmojiProfilePhotoGroups Получить категории эмодзи для выбора фотографии профиля.

Ключевые слова эмодзи

МетодОписание
messages.getEmojiKeywords Получить локализованные ключевые слова эмодзи.
messages.getEmojiKeywordsDifference Получить изменения в ключевых словах эмодзи.
messages.getEmojiKeywordsLanguages Получить список языков, для которых нужно забрать ключевые слова эмодзи.
messages.getEmojiURL Получить ссылку для входа на платформу переводов, чтобы предложить новые ключевые слова эмодзи. Ссылка живёт 30 секунд.

Эмодзи-статусы

МетодОписание
account.updateEmojiStatus Установить эмодзи-статус.
channels.updateEmojiStatus Установить эмодзи-статус канала или супергруппы.
account.getDefaultEmojiStatuses Получить подборку эмодзи-статусов по умолчанию.
account.getCollectibleEmojiStatuses Получить эмодзи-статусы, связанные с принадлежащими нам коллекционными подарками.
account.getChannelDefaultEmojiStatuses Получить подборку эмодзи-статусов по умолчанию для каналов.
account.getChannelRestrictedStatusEmojis Получить список своих эмодзи, которые нельзя ставить статусом канала.
account.getRecentEmojiStatuses Получить недавно использованные эмодзи-статусы.
account.clearRecentEmojiStatuses Очистить список недавно использованных эмодзи-статусов.
bots.updateUserEmojiStatus Боту: изменить эмодзи-статус пользователя.
bots.toggleUserEmojiStatusPermission Разрешить или запретить боту менять наш эмодзи-статус.

Проверка фактов

МетодОписание
messages.editFactCheck Создать или изменить проверку факта у сообщения. Доступно только независимым проверяющим.
messages.deleteFactCheck Удалить проверку факта у сообщения. Доступно только независимым проверяющим.
messages.getFactCheck Получить одну или несколько проверок фактов.

Файлы

МетодОписание
help.getCdnConfig Получить конфигурацию для скачивания файлов через CDN.
upload.getCdnFile Скачать файл через CDN.
upload.getCdnFileHashes Получить хеши SHA-256 для проверки файлов, скачанных через CDN.
upload.reuploadCdnFile Запросить повторную заливку файла в дата-центр CDN.
upload.getFile Получить файл целиком или его часть.
upload.getFileHashes Получить хеши SHA-256 для проверки скачанных файлов.
upload.getWebFile Получить внешний файл через прокси на нашей стороне. Запрос нужно слать в дата-центр, указанный в конфигурации.
upload.saveBigFilePart Загрузить часть большого файла — больше 10 МБ.
upload.saveFilePart Загрузить часть файла.
messages.uploadEncryptedFile Загрузить зашифрованный файл и привязать его к секретному чату, не отправляя в чат.
messages.uploadMedia Загрузить файл и привязать его к чату, не отправляя в чат.
messages.getDocumentByHash Получить документ по его хешу SHA-256. В основном используется для GIF-анимаций.

Метки папок

МетодОписание
messages.toggleDialogFilterTags Включить или выключить метки папок.

Папки

МетодОписание
messages.updateDialogFiltersOrder Изменить порядок папок.
messages.getDialogFilters Получить папки.
messages.getSuggestedDialogFilters Получить предлагаемые папки.
messages.updateDialogFilter Изменить папку.
folders.editPeerFolders Изменить состав чатов в системной папке.
chatlists.exportChatlistInvite Создать диплинк на папку чатов.
chatlists.deleteExportedInvite Удалить диплинк на папку чатов.
chatlists.editExportedInvite Изменить диплинк на папку чатов.
chatlists.getExportedInvites Получить все диплинки, созданные для папки.
chatlists.checkChatlistInvite Получить сведения о диплинке на папку чатов.
chatlists.joinChatlistInvite Импортировать папку по диплинку, вступив во все или в часть её чатов.
chatlists.getChatlistUpdates Получить новые чаты, добавленные в импортированную папку. Вызывать не чаще, чем разрешает конфигурация.
chatlists.joinChatlistUpdates Вступить в каналы и супергруппы, недавно добавленные в импортированную папку.
chatlists.hideChatlistUpdates Отклонить чаты, недавно добавленные в импортированную папку.
chatlists.getLeaveChatlistSuggestions Получить чаты импортированной папки, которые предлагается покинуть вместе с ней.
chatlists.leaveChatlist Удалить папку, импортированную по диплинку.

Форумы

МетодОписание
channels.toggleForum Включить или выключить режим форума в супергруппе.
channels.toggleViewForumAsMessages Показывать сообщения всех тем форума как обычную группу.
messages.getForumTopics Получить темы форума.
messages.getForumTopicsByID Получить темы форума по их идентификаторам.
messages.editForumTopic Изменить тему форума.
messages.updatePinnedForumTopic Закрепить или открепить тему форума.
messages.reorderPinnedForumTopics Изменить порядок закреплённых тем форума.
messages.createForumTopic Создать тему форума.
messages.deleteTopicHistory Удалить историю сообщений темы форума.

Имена пользователей с Fragment

МетодОписание
account.reorderUsernames Изменить порядок имён пользователя у текущего аккаунта.
account.toggleUsername Включить или отключить купленное имя пользователя, привязанное к аккаунту.
bots.reorderUsernames Изменить порядок имён пользователя у своего бота.
bots.toggleUsername Включить или отключить купленное имя пользователя у своего бота.
channels.reorderUsernames Изменить порядок активных имён канала.
channels.toggleUsername Включить или отключить купленное имя пользователя у своего канала или супергруппы.
channels.deactivateAllUsernames Отключить все купленные имена канала или супергруппы.

Игры

МетодОписание
messages.getGameHighScores Получить таблицу рекордов игры.
messages.getInlineGameHighScores Получить таблицу рекордов игры, отправленной инлайн-ботом.
messages.setGameScore Только для ботов: записать счёт пользователя в игре, отправленной обычным сообщением.
messages.setInlineGameScore Только для ботов: записать счёт пользователя в игре, отправленной инлайн-сообщением.

Подарочные коды

МетодОписание
payments.checkGiftCode Получить сведения о подарочном коде подписки.
payments.applyGiftCode Активировать подарочный код подписки.

Коллекции подарков

МетодОписание
payments.createStarGiftCollection Создать коллекцию подарков.
payments.updateStarGiftCollection Добавить или убрать подарки в коллекции либо переименовать её.
payments.reorderStarGiftCollections Изменить порядок коллекций подарков в профиле.
payments.deleteStarGiftCollection Удалить коллекцию подарков.
payments.getStarGiftCollections Получить все коллекции подарков указанного профиля.

Розыгрыши и подарки

МетодОписание
payments.getPremiumGiftCodeOptions Получить варианты розыгрышей и подарочных кодов подписки.
payments.getGiveawayInfo Получить сведения о розыгрыше подписки.
payments.launchPrepaidGiveaway Запустить предоплаченный розыгрыш.
payments.getStarsGiveawayOptions Получить варианты розыгрышей внутренней валюты.

Групповые звонки

МетодОписание
phone.exportGroupCallInvite Получить пригласительную ссылку на публичный видеочат или трансляцию. Ссылку с правом самому включать микрофон могут выдавать только администраторы звонка.
phone.getGroupCallJoinAs Получить список профилей, от имени которых можно войти в видеочат или трансляцию.
phone.editGroupCallParticipant Изменить параметры участника видеочата, трансляции или конференции. Поднятие руки поддерживается только в видеочатах и трансляциях.
phone.toggleGroupCallRecord Начать или остановить запись видеочата или трансляции. Записанные потоки уходят в «Избранное».
phone.editGroupCallTitle Изменить название видеочата или трансляции. Не применяется к прямым эфирам в историях и к конференциям.
phone.getGroupParticipants Получить участников группового звонка.
phone.checkGroupCall Проверить, какие из указанных источников сервер всё ещё считает подключёнными к звонку.
phone.createGroupCall Создать видеочат или трансляцию.
phone.toggleGroupCallStartSubscription Подписаться на запланированный групповой звонок или отписаться от него.
phone.leaveGroupCall Выйти из группового звонка, не завершая его для остальных.
phone.toggleGroupCallSettings Изменить настройки группового звонка. Набор настроек зависит от типа звонка.
phone.inviteToGroupCall Пригласить пользователей в видеочат или трансляцию. Не применяется к прямым эфирам в историях и к конференциям.
phone.getGroupCall Получить сведения о групповом звонке и его участниках.
phone.joinGroupCall Войти в групповой звонок любого типа. Для конференций дополнительно нужен обмен ключами сквозного шифрования.
phone.leaveGroupCallPresentation Прекратить демонстрацию экрана в видеочате, трансляции или конференции.
phone.discardGroupCall Завершить групповой звонок для всех участников.
phone.joinGroupCallPresentation Начать демонстрацию экрана в видеочате, трансляции или конференции.
phone.startScheduledGroupCall Начать запланированный групповой звонок.
phone.saveDefaultGroupCallJoinAs Задать профиль, от имени которого мы по умолчанию входим в видеочат конкретного чата.
phone.getGroupCallStreamChannels Получить доступные потоки и текущую метку воспроизведения трансляции в режиме RTMP.
phone.getGroupCallStreamRtmpUrl Получить адрес и ключ RTMP для внешнего вещателя трансляции.
phone.sendGroupCallMessage Отправить сообщение всем участникам видеочата, трансляции или прямого эфира.
phone.deleteGroupCallMessages Удалить сообщения из наложения сообщений видеочата, трансляции или прямого эфира.
phone.deleteGroupCallParticipantMessages Администратору: удалить все сообщения конкретного участника из наложения сообщений звонка.
phone.saveDefaultSendAs Задать профиль, от имени которого по умолчанию идут комментарии и реакции в прямом эфире.

Метки участников и администраторов

МетодОписание
messages.editChatParticipantRank Изменить метку участника группы.

Мгновенный просмотр статей

МетодОписание
messages.getWebPage Получить страницу мгновенного просмотра.
messages.getWebPagePreview Получить предпросмотр веб-страницы.

Прямые эфиры в историях

МетодОписание
stories.startLive Начать прямой эфир в историях, при желании в режиме RTMP.
phone.getGroupCallStars Получить сумму донатов прямого эфира и список крупнейших донатеров.

Эффекты сообщений

МетодОписание
messages.getAvailableEffects Получить полный список доступных анимированных эффектов сообщений.

Реакции на сообщения

МетодОписание
messages.setDefaultReaction Изменить реакцию по умолчанию для быстрого меню. Значение синхронизируется между устройствами.
messages.getMessagesReactions Получить реакции на сообщения.
messages.sendReaction Поставить реакцию на сообщение. Реакция уходит от профиля, заданного через messages.saveDefaultSendAs.
messages.getAvailableReactions Получить доступные реакции на сообщения.
messages.getUnreadReactions Получить непросмотренные реакции на наши сообщения.
messages.readReactions Отметить реакции просмотренными.
messages.setChatAvailableReactions Изменить набор реакций, доступных в группе, супергруппе или канале.
messages.getMessageReactionsList Получить список реакций на сообщение вместе с их авторами.
messages.reportReaction Пожаловаться на реакцию.
messages.getTopReactions Получить популярные реакции.
messages.getRecentReactions Получить недавно использованные реакции.
messages.clearRecentReactions Очистить список недавно использованных реакций.
messages.sendPaidReaction Отправить платные реакции, переведя внутреннюю валюту на баланс канала.
messages.togglePaidReactionPrivacy Изменить видимость уже отправленных платных реакций на сообщении.
messages.getPaidReactionPrivacy Получить текущую настройку видимости платных реакций по умолчанию.

Перевод сообщений

МетодОписание
messages.translateText Перевести текст. Разметка текста сохраняется только для подписчиков.
messages.togglePeerTranslations Показать или скрыть панель перевода в конкретном чате.
channels.toggleAutotranslation Включить или выключить автоперевод в канале для всех читателей.

Платные вложения

МетодОписание
messages.getExtendedMedia Получить обновлённые сведения о платных вложениях. Возвращает набор апдейтов updateMessageExtendedMedia.

Платные сообщения

МетодОписание
account.getPaidMessagesRevenue Узнать, сколько внутренней валюты мы получили от указанного пользователя за платные сообщения.
account.toggleNoPaidMessagesException Разрешить конкретному пользователю писать нам без оплаты, когда платные сообщения включены.
channels.updatePaidMessagesPrice Включить или выключить платные сообщения в супергруппе либо моно-форуме. Тем же методом включаются личные сообщения канала.

Passkeys

МетодОписание
auth.initPasskeyLogin Начать вход по passkey на неавторизованном соединении.
auth.finishPasskeyLogin Завершить вход по passkey. Запрос должен уйти в домашний дата-центр пользователя.
account.initPasskeyRegistration Начать регистрацию passkey для текущего аккаунта.
account.registerPasskey Завершить регистрацию passkey для текущего аккаунта.
account.getPasskeys Получить список passkey, которыми можно войти в текущий аккаунт.
account.deletePasskey Удалить passkey текущего аккаунта.

Заготовленные инлайн-сообщения

МетодОписание
messages.savePreparedInlineMessage Сохранить заготовленное инлайн-сообщение, чтобы пользователь мини-приложения мог им поделиться.
messages.getPreparedInlineMessage Получить заготовленное мини-приложением инлайн-сообщение.

Уведомления о реакциях

МетодОписание
account.getReactionsNotifySettings Получить настройки уведомлений о реакциях.
account.setReactionsNotifySettings Изменить настройки уведомлений о реакциях.

Избранное и моно-форумы

МетодОписание
messages.getSavedDialogs Получить список разделов «Избранного» или тем моно-форума.
messages.getSavedHistory Получить сообщения «Избранного», пересланные от конкретного собеседника, либо сообщения темы моно-форума.
messages.deleteSavedHistory Удалить сообщения темы моно-форума либо пересланные в «Избранное» от конкретного собеседника.
messages.getPinnedSavedDialogs Получить закреплённые разделы «Избранного».
messages.toggleSavedDialogPin Закрепить или открепить раздел «Избранного».
messages.reorderPinnedSavedDialogs Изменить порядок закреплённых разделов «Избранного».
messages.getSavedDialogsByID Получить сведения о конкретных разделах «Избранного» или темах моно-форума.
messages.readSavedHistory Отметить сообщения темы моно-форума прочитанными.
channels.getMessageAuthor Только администраторам-людям в моно-форуме: узнать настоящего отправителя сообщения, отправленного другим администратором от имени форума.

Метки в избранном

МетодОписание
messages.getSavedReactionTags Получить все метки «Избранного», созданные пользователем.
messages.updateSavedReactionTag Изменить подпись метки «Избранного».
messages.getDefaultTagReactions Получить рекомендованный набор реакций для меток «Избранного».

Секретные чаты

МетодОписание
messages.setEncryptedTyping Отправить в секретный чат признак «печатает».
messages.readEncryptedHistory Отметить историю секретного чата прочитанной.
messages.acceptEncryption Подтвердить создание секретного чата.
messages.discardEncryption Отменить запрос на создание секретного чата или удалить сведения о нём.
messages.requestEncryption Отправить пользователю запрос на создание секретного чата.
messages.sendEncrypted Отправить текстовое сообщение в секретный чат.
messages.sendEncryptedFile Отправить сообщение с вложением в секретный чат.
messages.sendEncryptedService Отправить служебное сообщение в секретный чат.
messages.getDhConfig Получить параметры для обмена ключами Диффи — Хеллмана. Может также вернуть случайную последовательность байт нужной длины.
messages.receivedQueue Подтвердить получение сообщений секретного чата и снять по ним пуш-уведомления. Возвращает random_id тех сообщений, чьи уведомления отменены.

Рекламные сообщения

МетодОписание
channels.restrictSponsoredMessages Отключить рекламу в канале для всех читателей. Доступно после достижения нужного уровня бустов.
account.toggleSponsoredMessages Отключить или снова включить рекламу для аккаунта с подпиской.
messages.viewSponsoredMessage Отметить рекламное сообщение просмотренным.
messages.clickSponsoredMessage Сообщить серверу, что пользователь взаимодействовал с рекламным сообщением.
messages.reportSponsoredMessage Пожаловаться на рекламное сообщение.
messages.getSponsoredMessages Получить рекламные сообщения для собеседника или канала.
contacts.getSponsoredPeers Получить рекламные результаты поиска по запросу.

Статистика

МетодОписание
stats.loadAsyncGraph Загрузить график статистики канала асинхронно.
stats.getBroadcastStats Получить статистику канала.
stats.getMessagePublicForwards Получить список сообщений, показывающий, в какие публичные каналы было переслано сообщение.
stats.getMegagroupStats Получить статистику супергруппы.
stats.getMessageStats Получить статистику сообщения.
stats.getStoryStats Получить статистику истории.
stats.getStoryPublicForwards Получить пересылки истории в публичные чаты и репосты публичными каналами.

Стикеры

МетодОписание
messages.getOldFeaturedStickers Получить ранее рекомендованные наборы стикеров.
messages.toggleStickerSets Применить изменения сразу к нескольким наборам стикеров.
stickers.suggestShortName Предложить короткое имя для набора стикеров по его названию.
stickers.replaceSticker Заменить стикер в наборе.
stickers.checkShortName Проверить, свободно ли короткое имя.
stickers.setStickerSetThumb Задать обложку набора стикеров.
stickers.addStickerToSet Добавить стикер в набор. Набор должен быть создан текущим пользователем или ботом.
stickers.changeStickerPosition Изменить положение стикера в наборе. Набор должен быть создан текущим пользователем или ботом.
stickers.createStickerSet Создать набор стикеров.
stickers.changeSticker Изменить ключевые слова, эмодзи или координаты маски у стикера.
stickers.renameStickerSet Переименовать набор стикеров.
stickers.deleteStickerSet Удалить свой набор стикеров.
messages.getMyStickers Получить все наборы стикеров, созданные текущим пользователем.
stickers.removeStickerFromSet Убрать стикер из набора. Набор должен быть создан текущим пользователем или ботом.
messages.clearRecentStickers Очистить список недавних стикеров.
messages.faveSticker Добавить стикер в избранные или убрать оттуда.
messages.getAllStickers Получить все установленные наборы стикеров.
messages.getArchivedStickers Получить архивированные наборы стикеров.
messages.getAttachedStickers Получить стикеры, прикреплённые к фотографии или видео.
messages.getFavedStickers Получить избранные стикеры.
messages.getFeaturedStickers Получить рекомендованные наборы стикеров.
messages.getMaskStickers Получить установленные наборы масок.
messages.getRecentStickers Получить недавние стикеры.
messages.getStickerSet Получить сведения о наборе стикеров.
messages.getStickers Получить стикеры по эмодзи.
messages.saveRecentSticker Добавить стикер в список недавних или убрать оттуда.
messages.installStickerSet Установить набор стикеров.
messages.readFeaturedStickers Отметить новые рекомендованные наборы просмотренными.
messages.reorderStickerSets Изменить порядок установленных наборов стикеров.
messages.searchStickerSets Найти наборы стикеров.
messages.searchStickers Найти стикеры по смыслу запроса.
messages.searchEmojiStickerSets Найти наборы своих эмодзи.
messages.uninstallStickerSet Удалить набор стикеров.

Истории

МетодОписание
stories.searchPosts Найти истории по хештегу или по метке места. В запросе должно быть задано что-то одно из двух.
stories.canSendStory Проверить, можем ли мы публиковать истории от имени указанного профиля.
stories.sendStory Опубликовать историю.
stories.editStory Изменить опубликованную историю.
stories.deleteStories Удалить опубликованные истории.
stories.togglePinnedToTop Закрепить истории наверху профиля.
stories.togglePinned Закрепить или открепить истории.
stories.getAllStories Получить список активных историй — при желании вместе со скрытыми.
stories.getPinnedStories Получить истории, закреплённые в профиле.
stories.getStoriesArchive Получить архив историй профиля, которым мы управляем.
stories.getStoriesByID Получить полные сведения об историях по их идентификаторам.
stories.toggleAllStoriesHidden Скрыть активные истории профиля, чтобы они не показывались в ленте историй.
stories.readStories Отметить истории прочитанными до указанного идентификатора. Всем сессиям уйдёт апдейт updateReadStories.
stories.incrementStoryViews Увеличить счётчик просмотров историй.
stories.getStoryViewsList Получить список тех, кто посмотрел нашу историю.
stories.getStoryReactionsList Получить реакции и взаимодействия с историей канала вместе с их авторами. Только для администраторов канала.
stories.getStoriesViews Получить просмотры, пересылки, реакции и недавних зрителей историй.
stories.exportStoryLink Создать диплинк на историю.
stories.report Пожаловаться на историю.
stories.activateStealthMode Включить режим скрытого просмотра историй. Возвращает апдейт updateStoriesStealthMode.
stories.getPeerStories Получить полный список активных историй профиля.
stories.getAllReadPeerStories Получить последнюю прочитанную историю по каждому профилю. Приходит набором апдейтов updateReadStories.
stories.getPeerMaxIDs Получить краткие сводки активных историй по набору профилей.
stories.getChatsToSend Получить каналы, в которых пользователь может публиковать истории.
stories.togglePeerStoriesHidden Скрыть активные истории пользователя, чтобы они не показывались в ленте историй.
stories.sendReaction Поставить реакцию на историю.
stories.createAlbum Создать альбом историй.
stories.updateAlbum Переименовать альбом историй либо добавить, удалить или переупорядочить истории в нём.
stories.reorderAlbums Изменить порядок альбомов историй в профиле.
stories.deleteAlbum Удалить альбом историй.
stories.getAlbums Получить альбомы историй профиля.
stories.getAlbumStories Получить истории из альбома.

Предложенные посты

МетодОписание
messages.toggleSuggestedPostApproval Одобрить или отклонить предложенный пост.

Паспорт

МетодОписание
account.sendVerifyPhoneCode Отправить код подтверждения номера для паспорта.
account.verifyPhone Подтвердить номер телефона для паспорта.
account.acceptAuthorization Отправить форму паспортной авторизации, передав данные сервису.
account.getAuthorizationForm Получить форму паспортной авторизации для передачи данных сервису.
account.getAuthorizations Получить список активных сессий.
account.deleteSecureValue Удалить сохранённые паспортные документы.
account.getAllSecureValues Получить все сохранённые паспортные документы.
account.getSecureValue Получить сохранённый паспортный документ.
account.saveSecureValue Сохранить паспортный документ в защищённом виде.
help.getPassportConfig Получить конфигурацию паспорта.
users.setSecureValueErrors Сообщить пользователю об ошибках в присланных паспортных данных. Пока ошибки не исправлены, повторно прислать данные он не сможет.

Временные ссылки на профиль

МетодОписание
contacts.exportContactToken Создать временную ссылку на свой профиль.
contacts.importContactToken Получить сведения о пользователе по временной ссылке на профиль.

Списки задач

МетодОписание
messages.toggleTodoCompleted Отметить пункты списка задач выполненными или невыполненными.
messages.appendTodoList Добавить пункты в список задач.

Апдейты

МетодОписание
updates.getChannelDifference Получить разницу между текущим состоянием апдейтов канала и переданным.
updates.getDifference Получить новые апдейты.
updates.getState Получить текущее состояние апдейтов.

Профили пользователей и каналов

МетодОписание
channels.setMainProfileTab Сменить главную вкладку профиля канала.
account.setMainProfileTab Сменить главную вкладку своего профиля.
photos.deletePhotos Удалить фотографии профиля. Возвращает идентификаторы успешно удалённых.
photos.getUserPhotos Получить фотографии профиля пользователя.
photos.updateProfilePhoto Сделать ранее загруженную фотографию фотографией профиля.
photos.uploadProfilePhoto Загрузить новую фотографию профиля. Флаги файла, видео и эмодзи-разметки взаимоисключающие.
photos.uploadContactProfilePhoto Загрузить свою фотографию для контакта или предложить контакту новую фотографию профиля. Флаги файла, видео и эмодзи-разметки взаимоисключающие.
account.updateProfile Изменить профиль пользователя.
account.updateBirthday Изменить дату рождения.
contacts.updateContactNote Изменить личную заметку о контакте.
contacts.getBirthdays Получить контакты, у которых день рождения сегодня, вчера или завтра. Клиенту стоит вызывать метод раз в 6–8 часов.
account.updatePersonalChannel Привязать личный канал к профилю или убрать его. Изменение отправляет апдейт updateUser.
account.updateStatus Обновить статус присутствия в сети.
users.getSavedMusic Получить композиции, закреплённые в профиле пользователя.
users.getSavedMusicByID Проверить, закреплены ли ещё указанные композиции в профиле, и обновить ссылки на их файлы.
account.saveMusic Добавить композицию в профиль или убрать её оттуда.
account.getSavedMusicIds Получить идентификаторы всех композиций, добавленных в профиль.
users.suggestBirthday Предложить другому пользователю указать дату рождения.

Расшифровка голосовых сообщений

МетодОписание
messages.transcribeAudio Расшифровать голосовое сообщение в текст.
messages.rateTranscribedAudio Оценить качество расшифровки голосового сообщения.

Обои

МетодОписание
account.getMultiWallPapers Получить сведения о нескольких обоях сразу.
account.getWallPaper Получить сведения об обоях.
account.getWallPapers Получить список доступных обоев.
account.installWallPaper Установить обои.
account.resetWallPapers Удалить все установленные обои и вернуться к набору по умолчанию.
account.saveWallPaper Сохранить обои или убрать их из сохранённых.
account.uploadWallPaper Загрузить свои обои.
messages.setChatWallPaper Установить свои обои в конкретном личном чате.

Запрос ботом прав администратора

МетодОписание
bots.setBotBroadcastDefaultAdminRights Задать права администратора, которые по умолчанию предлагаются при добавлении бота в канал.
bots.setBotGroupDefaultAdminRights Задать права администратора, которые по умолчанию предлагаются при добавлении бота в группу.

Инлайн-запросы и кнопки обратного вызова

МетодОписание
messages.getInlineBotResults Отправить инлайн-запрос боту.
messages.setInlineBotResults Только для ботов: ответить на инлайн-запрос.
messages.sendInlineBotResult Отправить результат, полученный через messages.getInlineBotResults.
messages.getBotCallbackAnswer Нажать инлайн-кнопку и получить ответ бота.
messages.setBotCallbackAnswer Только для ботов: ответить на нажатие кнопки пользователем.
messages.editInlineBotMessage Изменить инлайн-сообщение бота.
messages.sendBotRequestedPeer Отправить боту выбранные собеседники или чаты, запрошенные кнопкой выбора.

Боты

МетодОписание
bots.resetBotCommands Очистить список команд бота для указанной области и языка.
bots.getBotCommands Получить список команд бота для указанной области и языка.
bots.setBotCommands Задать список команд бота.
bots.setBotInfo Задать локализованные имя, краткое и полное описание бота — либо своего аккаунта, если вызывает бот.
bots.getBotInfo Получить локализованные имя, краткое и полное описание бота — либо своего аккаунта, если вызывает бот.
bots.getAdminedBots Получить список ботов, которыми владеет текущий пользователь.

Боты (внутреннее использование Bot API)

МетодОписание
bots.answerWebhookJSONQuery Только для ботов: ответить на произвольный запрос.
bots.sendCustomRequest Только для ботов: отправить произвольный запрос.
help.setBotUpdatesStatus Только для ботов: сообщить серверу о количестве необработанных апдейтов, если они давно не разбирались.

Контакты и частые собеседники

МетодОписание
account.getContactSignUpNotification Узнать, приходят ли уведомления о регистрации контактов.
account.setContactSignUpNotification Включить или выключить уведомления о регистрации контактов.
contacts.acceptContact Добавить пользователя в контакты по кнопке в панели действий чата.
contacts.addContact Добавить существующего пользователя Ansible в контакты. Чтобы добавить по номеру телефона, есть contacts.importContacts.
contacts.block Добавить собеседника или канал в чёрный список.
contacts.deleteByPhones Удалить контакты по номерам телефонов.
contacts.deleteContacts Удалить несколько контактов из списка.
contacts.getBlocked Получить чёрный список.
contacts.getContactIDs Получить идентификаторы всех контактов. Для контактов без аккаунта или скрывших его возвращается 0.
contacts.getContacts Получить список контактов.
contacts.getLocated Получить пользователей и геогруппы поблизости.
contacts.getSaved Получить все контакты. Требует сессии выгрузки данных.
contacts.getStatuses Получить статусы присутствия всех доступных контактов.
contacts.getTopPeers Получить наиболее частых собеседников.
contacts.importContacts Импортировать контакты: сохранить список на сервере, добавить уже зарегистрированных в список контактов и вернуть сведения о них.
contacts.resetSaved Удалить все контакты, у которых нет аккаунта Ansible.
contacts.resetTopPeerRating Сбросить рейтинг частого собеседника.
contacts.search Найти пользователей по части имени пользователя.
contacts.toggleTopPeers Включить или выключить подсчёт частых собеседников.
contacts.unblock Убрать собеседника или канал из чёрного списка.
contacts.setBlocked Заменить содержимое чёрного списка целиком.
contacts.editCloseFriends Изменить список близких друзей.

Список диалогов

МетодОписание
messages.getDialogs Получить список диалогов.
messages.getPeerDialogs Получить сведения о диалогах с указанными собеседниками.
messages.getPinnedDialogs Получить закреплённые диалоги.
messages.toggleDialogPin Закрепить или открепить диалог.
messages.reorderPinnedDialogs Изменить порядок закреплённых диалогов.
messages.getDialogUnreadMarks Получить диалоги, вручную помеченные непрочитанными.
messages.markDialogUnread Пометить диалог непрочитанным вручную.
messages.getPeerSettings Получить настройки для собеседника или чата.
messages.hidePeerSettingsBar Вызывается после того, как пользователь скрыл панель «пожаловаться на спам / добавить в контакты» в новом чате.
messages.getOnlines Узнать, сколько участников чата сейчас в сети.
messages.sendScreenshotNotification Сообщить собеседнику в личном чате, что был сделан снимок экрана.
messages.setTyping Отправить собеседнику или в группу признак действия — печатает, записывает голосовое и так далее.
messages.setHistoryTTL Задать максимальный срок жизни всех сообщений в чате.

Импорт переписки

МетодОписание
messages.uploadImportedMedia Загрузить вложение, относящееся к импортируемой переписке.
messages.startHistoryImport Завершить импорт переписки, перенеся все сообщения в чат. Вызывается только после messages.initHistoryImport.
messages.checkHistoryImportPeer Проверить, можно ли импортировать переписку из другого мессенджера в конкретный чат.
messages.checkHistoryImport Получить сведения о файле выгрузки переписки, сделанном другим мессенджером.
messages.initHistoryImport Начать импорт переписки из другого мессенджера в конкретный чат.

Языковые пакеты

МетодОписание
langpack.getDifference Получить новые строки языкового пакета.
langpack.getLangPack Получить строки языкового пакета.
langpack.getLanguage Получить сведения о языке в языковом пакете.
langpack.getLanguages Получить сведения обо всех языках в языковом пакете.
langpack.getStrings Получить конкретные строки языкового пакета.

Автозагрузка медиа

МетодОписание
account.getAutoDownloadSettings Получить настройки автозагрузки медиа.
account.saveAutoDownloadSettings Изменить настройки автозагрузки медиа.

Автосохранение медиа

МетодОписание
account.getAutoSaveSettings Получить настройки автосохранения медиа.
account.saveAutoSaveSettings Изменить настройки автосохранения медиа.
account.deleteAutoSaveExceptions Удалить все исключения автосохранения, заданные для отдельных чатов.

Обсуждения под сообщениями

МетодОписание
messages.getReplies Получить сообщения ветки обсуждения.
contacts.blockFromReplies Перестать получать уведомления об ответах конкретного пользователя в ленте обсуждений.
messages.getDiscussionMessage Получить сообщение обсуждения из привязанной к каналу группы, чтобы показать его над комментариями, не вступая в группу.
messages.readDiscussion Отметить ветку обсуждения прочитанной.

Сообщения

МетодОписание
messages.deleteHistory Удалить историю переписки.
messages.deleteMessages Удалить сообщения по их идентификаторам.
messages.editMessage Изменить сообщение.
messages.forwardMessages Переслать сообщения по их идентификаторам.
messages.getHistory Получить историю переписки. Результаты идут от новых к старым.
messages.getSearchResultsPositions Получить разреженные позиции сообщений указанного типа в чате — для прокрутки общих медиа. Результаты идут в обратном порядке.
messages.getMessageEditData Узнать, можно ли изменить подпись к вложению.
messages.getOutboxReadDate Узнать точное время прочтения нашего сообщения в личном чате. Работает только для исходящих сообщений не старше установленного срока.
messages.getMessages Получить сообщения по их идентификаторам.
messages.getMessagesViews Получить и увеличить счётчик просмотров сообщения, отправленного или пересланного из канала.
messages.getRecentLocations Получить последние трансляции геопозиции в чате — не больше одной на участника.
messages.getSearchCounters Узнать, сколько результатов вернул бы поиск с такими же параметрами.
messages.getUnreadMentions Получить непрочитанные сообщения, где нас упомянули.
messages.readHistory Отметить историю переписки прочитанной.
messages.readMentions Отметить упоминания прочитанными.
messages.readMessageContents Сообщить отправителю, что голосовое прослушано или видео просмотрено. Отправляет апдейт updateReadMessagesContents.
messages.receivedMessages Подтвердить получение сообщений клиентом и снять по ним пуш-уведомления.
messages.search Найти сообщения.
messages.getSearchResultsCalendar Получить сведения о следующих сообщениях указанного типа, разбитые по дням. Результаты идут от новых к старым.
messages.searchGlobal Найти сообщения и чаты по всему аккаунту.
messages.searchSentMedia Просмотреть и найти недавно отправленные вложения. Постраничного вывода нет.
channels.checkSearchPostsFlood Проверить, потребует ли глобальный поиск по постам оплаты.
channels.searchPosts Найти посты публичных каналов по хештегу или по тексту — включая каналы, где мы не состоим. Задаётся строго одно из двух.
messages.sendMedia Отправить вложение.
messages.sendMessage Отправить сообщение в чат.
messages.sendMultiMedia Отправить альбом или сгруппированные вложения.
messages.updatePinnedMessage Закрепить сообщение.
messages.unpinAllMessages Открепить все закреплённые сообщения.
messages.saveDefaultSendAs Задать профиль, от имени которого мы по умолчанию пишем, ставим реакции и голосуем в конкретной группе.
channels.getSendAs Получить список профилей, от имени которых можно выступать отправителем в этом контексте.

Настройки уведомлений

МетодОписание
account.registerDevice Зарегистрировать устройство для получения пуш-уведомлений.
account.unregisterDevice Удалить устройство по его токену и прекратить отправку пуш-уведомлений.
account.updateDeviceLocked При включённом коде-пароле не показывать текст сообщений во входящих пуш-уведомлениях.
account.getNotifyExceptions Получить чаты с настройками уведомлений, отличными от общих.
account.getNotifySettings Получить настройки уведомлений для конкретного чата или для всех сразу.
account.updateNotifySettings Изменить настройки уведомлений для конкретного чата или для всех сразу.
account.resetNotifySettings Сбросить все настройки уведомлений.

Звуки уведомлений

МетодОписание
account.getSavedRingtones Получить сохранённые звуки уведомлений.
account.saveRingtone Сохранить звук уведомления или убрать его из сохранённых. Файл не в формате MP3 будет преобразован автоматически.
account.uploadRingtone Загрузить звук уведомления. Добавляется в список через account.saveRingtone.

Другие пользователи

МетодОписание
users.getFullUser Получить расширенные сведения о пользователе.
users.getUsers Получить основные сведения о пользователях по их идентификаторам.
contacts.resolvePhone Найти пользователя по номеру телефона, если это разрешают его настройки приватности. Клиенту следует ограничивать частоту вызовов.

Платежи

МетодОписание
payments.getSavedInfo Получить сохранённые платёжные данные.
payments.clearSavedInfo Удалить сохранённые платёжные данные.
payments.getPaymentForm Получить форму оплаты.
payments.validateRequestedInfo Отправить на проверку данные заказа.
messages.setBotShippingResults Боту: ответить на запрос вариантов доставки, если счёт требовал адрес и был помечен гибким.
account.getTmpPassword Получить временный платёжный пароль.
payments.sendPaymentForm Отправить заполненную форму оплаты.
messages.setBotPrecheckoutResults Боту: подтвердить или отклонить заказ после того, как пользователь подтвердил оплату и данные доставки.
payments.getPaymentReceipt Получить чек об оплате.
payments.exportInvoice Создать диплинк на счёт.
payments.getBankCardData Получить сведения о банковской карте.

Опросы

МетодОписание
messages.getPollResults Получить результаты опроса.
messages.getPollVotes Получить голоса неанонимного опроса.
messages.sendVote Проголосовать в опросе. Голос уходит от профиля, заданного через messages.saveDefaultSendAs.

Отложенные сообщения

МетодОписание
messages.sendScheduledMessages Отправить отложенные сообщения немедленно.
messages.getScheduledHistory Получить историю отложенных сообщений.
messages.deleteScheduledMessages Удалить отложенные сообщения.
messages.getScheduledMessages Получить отложенные сообщения.

Материалы для взрослых

МетодОписание
account.getContentSettings Получить настройки показа материалов для взрослых.
account.setContentSettings Изменить настройки показа материалов для взрослых.

Функции с ИИ

МетодОписание
messages.summarizeText Составить краткое содержание сообщения с помощью ИИ.

Приветственный экран бизнес-аккаунта

МетодОписание
account.updateBusinessIntro Задать или убрать приветственный экран бизнес-аккаунта.

Адрес бизнес-аккаунта

МетодОписание
account.updateBusinessLocation Указать адрес бизнес-аккаунта. Вызов без адреса убирает его.

Меню вложений мини-приложений

МетодОписание
messages.getAttachMenuBots Получить установленные мини-приложения меню вложений.
messages.getAttachMenuBot Получить запись меню вложений для мини-приложения бота.
messages.toggleBotInAttachMenu Добавить мини-приложение в меню вложений или убрать оттуда.

Встроенная защита от спама

МетодОписание
channels.toggleAntiSpam Включить или выключить встроенную защиту от спама.
channels.reportAntiSpamFalsePositive Сообщить о ложном срабатывании встроенной защиты от спама.

Настройки приватности

МетодОписание
account.getPrivacy Получить настройки приватности аккаунта.
account.setPrivacy Изменить настройки приватности аккаунта.
account.setGlobalPrivacySettings Изменить общие настройки приватности.
account.getGlobalPrivacySettings Получить общие настройки приватности.
messages.setDefaultHistoryTTL Изменить срок автоудаления сообщений, применяемый ко всем новым чатам.
messages.getDefaultHistoryTTL Получить срок автоудаления сообщений, применяемый ко всем новым чатам.
users.getRequirementsToContact Проверить, можем ли мы писать указанным пользователям — для пакетной проверки платных сообщений и ограничений подписки.

Выгрузка данных

МетодОписание
account.initTakeoutSession Начать сессию выгрузки данных.
account.finishTakeoutSession Завершить сессию выгрузки данных.
messages.getSplitRanges Получить диапазоны сообщений для сохранения истории переписки.
channels.getLeftChannels Получить каналы и супергруппы, из которых мы вышли. Требует сессии выгрузки данных.
invokeWithMessagesRange Выполнить запрос в пределах указанного диапазона сообщений.
invokeWithTakeout Выполнить запрос внутри сессии выгрузки данных.

Кнопка меню бота

МетодОписание
bots.setBotMenuButton Задать действие кнопки меню бота — для конкретного пользователя или для всех.
bots.getBotMenuButton Получить действие кнопки меню бота, ранее заданное через bots.setBotMenuButton.

Аккаунт пользователя

МетодОписание
account.changePhone Сменить номер телефона аккаунта.
account.confirmPhone Подтвердить номер телефона, чтобы отменить удаление аккаунта.
account.deleteAccount Удалить аккаунт с наших серверов. Тем же методом удаляется аккаунт, к которому есть код входа, но забыт пароль двухфакторной защиты.
account.getAccountTTL Узнать срок бездействия, после которого аккаунт удаляется.
account.resetAuthorization Завершить активную сессию по её хешу.
account.sendChangePhoneCode Отправить код подтверждения на новый номер телефона.
account.sendConfirmPhoneCode Отправить код подтверждения для отмены удаления аккаунта.
account.setAccountTTL Задать срок бездействия, после которого аккаунт удаляется.

Часовые пояса

МетодОписание
help.getTimezonesList Получить справочник часовых поясов.

Имена пользователей

МетодОписание
channels.checkUsername Проверить, свободно ли имя пользователя для канала или супергруппы.
channels.updateUsername Изменить или удалить имя пользователя канала или супергруппы.
account.updateUsername Изменить имя пользователя текущего аккаунта.
account.checkUsername Проверить имя пользователя на допустимость и доступность.
contacts.resolveUsername Найти пользователя, канал или чат по имени пользователя.