Ansible Bot API

Bot API — это интерфейс на основе HTTP, созданный для разработчиков, которые хотят создавать ботов для Ansible.
Чтобы узнать, как создать и настроить бота, обратитесь к нашему Введение в ботов и FAQ по ботам.

Последние изменения

Подпишитесь на @BotNews чтобы первыми узнавать о последних обновлениях и присоединиться к обсуждению в @BotTalk

14 июля 2026 г.

Bot API 10.2

Rich-сообщения

Эфемерные сообщения

Сообщества

  • Добавлена начальная поддержка Сообщества - несколько супергрупп, каналов и ботов, связанных вместе вокруг общей темы или аудитории.
  • Добавлен класс Сообщество который представляет сообщество.
  • Добавлен класс CommunityChatAdded и поле community_chat_added к классу Message.
  • Добавлен класс CommunityChatRemoved и поле community_chat_removed к классу Message.
  • Добавлено поле сообщество к классу ChatFullInfo.

Общее

  • Добавлены обновления об изменениях платёжной подписки пользователя, представленные классом BotSubscriptionUpdated и поле подписка в классе Update.
  • Усилена безопасность Mini Apps: запрещено использование методов Mini App с источников, отличных от исходного домена Mini App. Защита будет автоматически включена для всех Mini Apps 20 июля 2026 года. Отказаться от защиты можно через @BotFather Mini App. Если вы так поступаете, вы признаёте, что бот несёт ответственность за то, чтобы в Mini App не было ссылок на недоверенные сайты.

11 июня 2026 г.

Bot API 10.1

Rich-сообщения

Запросы на вступление

Опросы

8 мая 2026 г.

Bot API 10.0

Гостевой режим

  • Добавлена поддержка гостевой режим, позволяя ботам получать определённые сообщения и отвечать в чатах, участниками которых они не являются.
  • Добавлено поле supports_guest_queries к классу User.
  • Добавлены поля guest_bot_caller_user и guest_bot_caller_chat к классу Message.
  • Добавлено поле guest_query_id к классу Message.
  • Добавлено поле guest_message к классу Update.
  • Добавлен класс SentGuestMessage и метод answerGuestQuery.

Управление чатами

Опросы

  • Добавлены классы InputMediaSticker, InputMediaLocation, и InputMediaVenue.
  • Добавлен класс PollMedia, представляющий медиа в опросе.
  • Добавлено поле media к классу Poll, позволяя ботам видеть медиа в опросах.
  • Добавлено поле explanation_media к классу Poll, позволяя ботам видеть медиа в пояснениях к викторинам.
  • Добавлено поле media к классу PollOption, позволяя ботам видеть медиа в вариантах ответа опроса.
  • Добавлен класс InputPollMedia и параметры media и explanation_media к методу sendPoll, позволяя ботам добавлять медиа в опросы.
  • Добавлен класс InputPollOptionMedia и поле media к классу InputPollOption, позволяя ботам добавлять медиа к вариантам ответа опроса.
  • Добавлено поле members_only к классу Poll.
  • Добавлен параметр members_only к методу sendPoll.
  • Добавлено поле country_codes к классу Poll.
  • Добавлен параметр country_codes к методу sendPoll.
  • Уменьшено минимальное количество вариантов ответа в опросе с 2 до 1.

Живые фото

  • Добавлен класс LivePhoto, который представляет собой фото с коротким видео.
  • Добавлен класс InputMediaLivePhoto.
  • Добавлено поле live_photo в классы Message и ExternalReplyInfo.
  • Добавлен метод sendLivePhoto, позволяющий ботам отправлять живые фото.
  • Добавлен класс PaidMediaLivePhoto, который описывает платное медиа с живым фото.
  • Добавлен класс InputPaidMediaLivePhoto, позволяя ботам отправлять живые фото в качестве платного медиа.
  • Разрешено использовать живые фото в sendMediaGroup и editMessageMedia,

Общее

  • Разрешено Боты-секретари для управления аккаунтами пользователей без подписки Ansible Premium.
  • Добавлена возможность отправлять сообщения другим ботам по username, если оба бота включили общение между ботами.
  • Добавлена возможность отвечать другим ботам из бизнес-бота, если бизнес-бот включил общение между ботами.
  • Ботам разрешено передавать пустой текст в методе sendMessageDraft.
  • Добавлен класс BotAccessSettings и метод getManagedBotAccessSettings.
  • Добавлен метод setManagedBotAccessSettings.
  • Добавлен метод getUserPersonalChatMessages.

Смотрите более ранние изменения »

Авторизация вашего бота

Каждому боту выдаётся уникальный токен аутентификации когда он создаётся. Токен выглядит примерно так 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, но мы будем использовать просто <token> вместо этого в этом документе. Узнать о получении токенов и генерации новых можно в этот документ.

Выполнение запросов

Все запросы к Ansible Bot API должны выполняться по HTTPS и иметь следующий вид: https://api.ansible.su/bot<token>/METHOD_NAME. Например, вот так:

https://api.ansible.su/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMe

Мы поддерживаем GET и POST HTTP-методы. Мы поддерживаем четыре способа передачи параметров в запросах Bot API:

  • Строка запроса URL
  • application/x-www-form-urlencoded
  • application/json (кроме загрузки файлов)
  • multipart/form-data (используется для загрузки файлов)

Ответ содержит объект JSON, который всегда имеет поле типа Boolean 'ok' и может иметь необязательное поле типа String 'description' с человекочитаемым описанием результата. Если 'ok' равно True, запрос был успешным и результат запроса можно найти в поле 'result'. В случае неуспешного запроса 'ok' равно False а ошибка объясняется в «description». Также возвращается поле «error_code» типа Integer, но его содержимое может измениться в будущем. Некоторые ошибки могут также иметь необязательное поле «parameters» типа ResponseParameters, что может помочь автоматически обработать ошибку.

  • Все методы Bot API нечувствительны к регистру.
  • Все запросы должны выполняться в UTF-8.

Выполнение запросов при получении обновлений

Если вы используете вебхуки, вы можете выполнить запрос к Bot API, отправляя ответ на webhook. Используйте либо application/json or application/x-www-form-urlencoded or multipart/form-data тип содержимого ответа для передачи параметров. Укажите вызываемый метод в method параметр запроса. Невозможно узнать, был ли такой запрос успешным, или получить его результат.

Примеры смотрите в нашем FAQ.

Использование локального сервера Bot API

Исходный код сервера Bot API доступен в ansible-bot-api. Вы можете запустить его локально и отправлять запросы на свой собственный сервер вместо https://api.ansible.su. Если вы перейдёте на локальный сервер Bot API, ваш бот сможет:

  • Скачивайте файлы без ограничения по размеру.
  • Загружайте файлы размером до 2000 MB.
  • Загружать файлы по их локальному пути и схема URI file.
  • Используйте HTTP URL для вебхука.
  • Используйте любой локальный IP-адрес для вебхука.
  • Используйте для webhook любой порт.
  • Установить max_webhook_connections up to 100000.
  • Получайте абсолютный локальный путь в качестве значения file_path поле без необходимости скачивать файл после getFile запрос.

Нужен ли мне локальный сервер Bot API

Большинству ботов будет достаточно конфигурации по умолчанию с работой на наших серверах. Но если вы считаете, что вам нужно одно из эти возможности, вы можете в любой момент перейти на свой собственный.

Получение обновлений

Существует два взаимоисключающих способа получения обновлений для вашего бота - getUpdates метод, с одной стороны, и вебхуки с другой. Входящие обновления хранятся на сервере, пока бот не получит их тем или иным способом, но они не хранятся дольше 24 часов.

Независимо от того, какой вариант вы выберете, вы получите JSON-сериализованные Update объектов в качестве результата.

Update

Этот объект представляет входящее обновление.
Не более одно из необязательных полей может присутствовать в любом конкретном обновлении.

Поле Тип Описание
update_id Integer Уникальный идентификатор обновления. Идентификаторы обновлений начинаются с некоторого положительного числа и увеличиваются последовательно. Этот идентификатор особенно удобен, если вы используете вебхуки, поскольку это позволяет игнорировать повторные обновления или восстанавливать правильную последовательность обновлений, если она нарушится. Если новых обновлений не было хотя бы неделю, то идентификатор следующего обновления будет выбран случайно, а не последовательно.
message Message Необязательное. Новое входящее сообщение любого типа - текст, фото, стикер и т. д.
edited_message Message Необязательное. Новая версия сообщения, которое известно боту и было отредактировано. Иногда это обновление может вызываться изменениями полей сообщения, которые недоступны вашему боту или активно им не используются.
channel_post Message Необязательное. Новый входящий пост канала любого типа - текст, фото, стикер и т. д.
edited_channel_post Message Необязательное. Новая версия поста канала, который известен боту и был отредактирован. Иногда это обновление может вызываться изменениями полей сообщения, которые недоступны или активно не используются вашим ботом.
business_connection BusinessConnection Необязательное. Бот был подключён к бизнес-аккаунту или отключён от него, либо пользователь изменил существующее подключение с ботом
business_message Message Необязательное. Новое сообщение из подключённого бизнес-аккаунта
edited_business_message Message Необязательное. Новая версия сообщения из подключённого бизнес-аккаунта
deleted_business_messages BusinessMessagesDeleted Необязательное. Сообщения были удалены из подключённого бизнес-аккаунта
guest_message Message Необязательное. Новое гостевое сообщение. Бот может использовать поле Message.guest_query_id и метод answerGuestQuery чтобы отправить сообщение в ответ.
message_reaction MessageReactionUpdated Необязательное. Реакция на сообщение была изменена пользователем. Бот должен быть администратором в чате и должен явно указать "message_reaction" в списке allowed_updates чтобы получать эти обновления. Обновление не приходит для реакций, установленных ботами.
message_reaction_count MessageReactionCountUpdated Необязательное. Реакции на сообщение с анонимными реакциями были изменены. Бот должен быть администратором в чате и должен явно указать "message_reaction_count" в списке allowed_updates чтобы получать эти обновления. Обновления группируются и могут отправляться с задержкой до нескольких минут.
inline_query InlineQuery Необязательное. Новый входящий inline query
chosen_inline_result ChosenInlineResult Необязательное. Результат inline запрос, который был выбран пользователем и отправлен его собеседнику. Подробности о том, как включить эти обновления для вашего бота, смотрите в нашей документации по сбору обратной связи.
callback_query CallbackQuery Необязательное. Новый входящий callback-запрос
shipping_query ShippingQuery Необязательное. Новый входящий запрос доставки. Только для счетов с гибкой ценой.
pre_checkout_query PreCheckoutQuery Необязательное. Новый входящий запрос pre-checkout. Содержит полную информацию об оформлении заказа.
purchased_paid_media PaidMediaPurchased Необязательное. Пользователь приобрёл платные медиа с непустым payload, отправленные ботом в чате, не являющемся каналом
poll Poll Необязательное. Новое состояние опроса. Боты получают обновления только о вручную остановленных опросах и об опросах, которые отправлены ботом.
poll_answer PollAnswer Необязательное. Пользователь изменил свой ответ в неанонимном опросе. Боты получают новые голоса только в опросах, отправленных самим ботом.
my_chat_member ChatMemberUpdated Необязательное. Статус бота как участника чата был обновлён в чате. Для личных чатов это обновление приходит только тогда, когда пользователь блокирует или разблокирует бота.
chat_member ChatMemberUpdated Необязательное. Статус участника чата был обновлён в чате. Бот должен быть администратором в чате и должен явно указать "chat_member" в списке allowed_updates чтобы получать эти обновления.
chat_join_request ChatJoinRequest Необязательное. Запрос на вступление в чат был отправлен. Бот должен иметь can_invite_users право администратора в чате, чтобы получать эти обновления.
chat_boost ChatBoostUpdated Необязательное. Буст чата был добавлен или изменён. Чтобы получать эти обновления, бот должен быть администратором в чате.
removed_chat_boost ChatBoostRemoved Необязательное. Буст был снят с чата. Чтобы получать эти обновления, бот должен быть администратором в чате.
managed_bot ManagedBotUpdated Необязательное. Создан новый бот, управляемый этим ботом, либо изменён токен или владелец управляемого бота
подписка BotSubscriptionUpdated Необязательное. Платёжная подписка пользователя изменилась

getUpdates

Используйте этот метод, чтобы получать входящие апдейты с помощью long polling (wiki). Возвращает Array of Update объекты.

Параметр Тип Обязательно Описание
offset Integer Необязательное Идентификатор первого возвращаемого обновления. Должен быть на единицу больше наибольшего из идентификаторов ранее полученных обновлений. По умолчанию возвращаются обновления, начиная с самого раннего неподтверждённого обновления. Обновление считается подтверждённым, как только getUpdates вызывается с offset выше, чем его update_id. Можно указать отрицательное смещение, чтобы получить обновления, начиная с -offset обновление с конца очереди обновлений. Все предыдущие обновления будут забыты.
limit Integer Необязательное Ограничивает количество получаемых обновлений. Принимаются значения от 1 до 100. По умолчанию 100.
timeout Integer Необязательное Таймаут в секундах для long polling. По умолчанию 0, то есть обычный short polling. Должен быть положительным; short polling следует использовать только в целях тестирования.
allowed_updates Array of String Необязательное JSON-сериализованный список типов обновлений, которые вы хотите получать в своём боте. Например, укажите ["message", "edited_channel_post", "callback_query"] чтобы получать обновления только этих типов. См. Update полный список доступных типов обновлений. Укажите пустой список, чтобы получать все типы обновлений, кроме chat_member, message_reaction, и message_reaction_count (по умолчанию). Если не указано, будет использована предыдущая настройка.

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

Примечания
1. Этот метод не будет работать, если настроен исходящий вебхук.
2. Чтобы избежать получения дублирующихся обновлений, пересчитывайте offset после каждого ответа сервера.

setWebhook

Используйте этот метод, чтобы указать URL и получать входящие обновления через исходящий вебхук. Каждый раз, когда для бота появляется обновление, мы будем отправлять HTTPS POST-запрос на указанный URL, содержащий JSON-сериализованный Update. В случае неуспешного запроса (запроса с ответом Код состояния HTTP отличный от 2XY), мы повторим запрос и прекратим попытки после разумного их количества. Возвращает True в случае успеха.

Если вы хотите убедиться, что вебхук установлен именно вами, вы можете указать секретные данные в параметре secret_token. Если указан, запрос будет содержать заголовок «X-Ansible-Bot-Api-Secret-Token» с секретным токеном в качестве содержимого.

Параметр Тип Обязательно Описание
url String Да HTTPS URL, на который отправлять обновления. Используйте пустую строку, чтобы удалить интеграцию с webhook.
certificate InputFile Необязательное Загрузите сертификат вашего открытого ключа, чтобы можно было проверить используемый корневой сертификат. Подробности см. в нашем руководстве по самоподписанным сертификатам.
ip_address String Необязательное Фиксированный IP-адрес, который будет использоваться для отправки webhook-запросов вместо IP-адреса, полученного через DNS
max_connections Integer Необязательное Максимально допустимое число одновременных HTTPS-соединений с webhook для доставки апдейтов, 1-100. По умолчанию 40. Используйте меньшие значения, чтобы ограничить нагрузку на сервер вашего бота, и большие значения, чтобы увеличить пропускную способность вашего бота.
allowed_updates Array of String Необязательное JSON-сериализованный список типов обновлений, которые вы хотите получать в своём боте. Например, укажите ["message", "edited_channel_post", "callback_query"] чтобы получать обновления только этих типов. См. Update полный список доступных типов обновлений. Укажите пустой список, чтобы получать все типы обновлений, кроме chat_member, message_reaction, и message_reaction_count (по умолчанию). Если не указано, будет использована предыдущая настройка.
Обратите внимание, что этот параметр не влияет на обновления, созданные до вызова setWebhook, поэтому в течение короткого времени могут приходить нежелательные обновления.
drop_pending_updates Boolean Необязательное Передайте True чтобы сбросить все ожидающие обновления
secret_token String Необязательное Секретный токен, который будет отправляться в заголовке «X-Ansible-Bot-Api-Secret-Token» в каждом запросе webhook, 1-256 символов. Только символы A-Z, a-z, 0-9, _ и - разрешены. Заголовок полезен для того, чтобы убедиться, что запрос приходит от webhook, установленного вами.

Примечания
1. Вы не сможете получать обновления с помощью getUpdates пока настроен исходящий webhook.
2. Чтобы использовать самоподписанный сертификат, вам нужно загрузить сертификат открытого ключа с помощью certificate параметр. Пожалуйста, загружайте как InputFile, отправка String не сработает.
3. Поддерживаемые в настоящее время порты для webhook: 443, 80, 88, 8443.

Если у вас возникают трудности с настройкой webhook, ознакомьтесь с этим замечательным руководством по webhook.

deleteWebhook

Используйте этот метод, чтобы удалить интеграцию с вебхуком, если вы решите вернуться к getUpdates. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
drop_pending_updates Boolean Необязательное Передайте True чтобы сбросить все ожидающие обновления

getWebhookInfo

Используйте этот метод, чтобы получить текущий статус вебхука. Не требует параметров. В случае успеха возвращает WebhookInfo объект. Если бот использует getUpdates, вернёт объект с url поле пустым.

WebhookInfo

Описывает текущий статус вебхука.

Поле Тип Описание
url String URL вебхука, может быть пустым, если вебхук не настроен
has_custom_certificate Boolean True, если для проверки сертификата вебхука был предоставлен пользовательский сертификат
pending_update_count Integer Количество обновлений, ожидающих доставки
ip_address String Необязательное. Используемый в настоящее время IP-адрес webhook
last_error_date Integer Необязательное. Unix-время последней ошибки, произошедшей при попытке доставить обновление через webhook
last_error_message String Необязательное. Сообщение об ошибке в человекочитаемом виде для самой последней ошибки, произошедшей при попытке доставить обновление через webhook
last_synchronization_error_date Integer Необязательное. Unix-время последней ошибки, произошедшей при попытке синхронизировать доступные обновления с дата-центрами Ansible
max_connections Integer Необязательное. Максимально допустимое количество одновременных HTTPS-соединений с webhook для доставки обновлений
allowed_updates Array of String Необязательное. Список типов обновлений, на которые подписан бот. По умолчанию — все типы обновлений, кроме chat_member, message_reaction, и message_reaction_count.

Доступные типы

Все типы, используемые в ответах Bot API, представлены в виде JSON-объектов.

Безопасно использовать 32-битные знаковые целые числа для хранения всех Integer поля, если не указано иное.

Необязательное поля могут не возвращаться, если они неактуальны.

User

Этот объект представляет пользователя или бота Ansible.

Поле Тип Описание
id Integer Уникальный идентификатор этого пользователя или бота. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или давать незаметные ошибки при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битное целое число или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
is_bot Boolean True, если этот пользователь — бот
first_name String Имя пользователя или бота
last_name String Необязательное. Фамилия пользователя или бота
username String Необязательное. Username пользователя или бота
language_code String Необязательное. Языковой тег IETF языка пользователя
is_premium True Необязательное. True, если этот пользователь является пользователем Ansible Premium
added_to_attachment_menu True Необязательное. True, если этот пользователь добавил бота в меню вложений
can_join_groups Boolean Необязательное. True, если бота можно приглашать в группы. Возвращается только в getMe.
can_read_all_group_messages Boolean Необязательное. True, if режим приватности отключено для бота. Возвращается только в getMe.
supports_guest_queries Boolean Необязательное. True, если бот поддерживает гостевые запросы из чатов, участником которых он не является. Возвращается только в getMe.
supports_inline_queries Boolean Необязательное. True, если бот поддерживает inline-запросы. Возвращается только в getMe.
can_connect_to_business Boolean Необязательное. True, если бота можно подключить к аккаунту пользователя для управления им. Возвращается только в getMe.
has_main_web_app Boolean Необязательное. True, если у бота есть основное Web App. Возвращается только в getMe.
has_topics_enabled Boolean Необязательное. True, если у бота включён режим тем форума в личных чатах. Возвращается только в getMe.
allows_users_to_create_topics Boolean Необязательное. True, если бот разрешает пользователям создавать и удалять топики в личных чатах. Возвращается только в getMe.
can_manage_bots Boolean Необязательное. True, если можно создавать других ботов, управляемых этим ботом. Возвращается только в getMe.
supports_join_request_queries Boolean Необязательное. True, если бот поддерживает запросы на вступление и может быть назначен для их обработки. Возвращается только в getMe.

Chat

Этот объект представляет чат.

Поле Тип Описание
id Integer Уникальный идентификатор этого чата. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
type String Тип чата, может быть «private», «group», «supergroup» или «channel»
title String Необязательное. Название, для супергрупп, каналов и групповых чатов
username String Необязательное. Имя пользователя, для личных чатов, супергрупп и каналов, если доступно
first_name String Необязательное. Имя собеседника в личном чате
last_name String Необязательное. Фамилия собеседника в личном чате
is_forum True Необязательное. True, если чат супергруппы является форумом (включены темы)
is_direct_messages True Необязательное. True, если чат является чатом личных сообщений канала

ChatFullInfo

Этот объект содержит полную информацию о чате.

Поле Тип Описание
id Integer Уникальный идентификатор этого чата. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
type String Тип чата, может быть «private», «group», «supergroup» или «channel»
title String Необязательное. Название, для супергрупп, каналов и групповых чатов
username String Необязательное. Имя пользователя, для личных чатов, супергрупп и каналов, если доступно
first_name String Необязательное. Имя собеседника в личном чате
last_name String Необязательное. Фамилия собеседника в личном чате
is_forum True Необязательное. True, если чат супергруппы является форумом (включены темы)
is_direct_messages True Необязательное. True, если чат является чатом личных сообщений канала
accent_color_id Integer Идентификатор акцентного цвета для названия чата и фонов фото чата, заголовка ответа и предпросмотра ссылки. См. акцентные цвета подробнее.
max_reaction_count Integer Максимальное количество реакций, которые можно установить на сообщение в чате
photo ChatPhoto Необязательное. Фото чата
active_usernames Array of String Необязательное. Если не пусто — список всех активных имён пользователя чата; для личных чатов, супергрупп и каналов
birthdate Birthdate Необязательное. Для личных чатов — дата рождения пользователя
business_intro BusinessIntro Необязательное. Для личных чатов с бизнес-аккаунтами — интро бизнеса
business_location BusinessLocation Необязательное. Для личных чатов с бизнес-аккаунтами — местоположение бизнеса
business_opening_hours BusinessOpeningHours Необязательное. Для личных чатов с бизнес-аккаунтами — часы работы бизнеса
personal_chat Chat Необязательное. Для личных чатов — персональный канал пользователя
parent_chat Chat Необязательное. Информация о соответствующем чате канала; только для чатов прямых сообщений
available_reactions Array of ReactionType Необязательное. Список доступных реакций, разрешённых в чате. Если не указан, то все эмодзи-реакции разрешены.
background_custom_emoji_id String Необязательное. Идентификатор пользовательского эмодзи, выбранного чатом для фона заголовка ответа и предпросмотра ссылки
profile_accent_color_id Integer Необязательное. Идентификатор акцентного цвета для фона профиля чата. См. акцентные цвета профиля подробнее.
profile_background_custom_emoji_id String Необязательное. Идентификатор кастомного эмодзи, выбранного чатом для фона своего профиля
emoji_status_custom_emoji_id String Необязательное. Идентификатор кастомного эмодзи для эмодзи-статуса чата или собеседника в личном чате
emoji_status_expiration_date Integer Необязательное. Дата истечения эмодзи-статуса чата или собеседника в личном чате, в Unix time, если есть
bio String Необязательное. Био собеседника в личном чате
has_private_forwards True Необязательное. True, если настройки конфиденциальности собеседника в личном чате позволяют использовать as://user?id=<user_id> ссылки только в чатах с пользователем
has_restricted_voice_and_video_messages True Необязательное. True, если настройки приватности собеседника ограничивают отправку голосовых сообщений и видеосообщений в личном чате
join_to_send_messages True Необязательное. True, если пользователям необходимо вступить в супергруппу, прежде чем они смогут отправлять сообщения
join_by_request True Необязательное. True, если все пользователи, вступающие в супергруппу напрямую без использования пригласительной ссылки, должны быть одобрены администраторами супергруппы
description String Необязательное. Описание, для групп, супергрупп и чатов каналов
invite_link String Необязательное. Основная ссылка-приглашение, для групп, супергрупп и чатов каналов
pinned_message Message Необязательное. Самое последнее закреплённое сообщение (по дате отправки)
permissions ChatPermissions Необязательное. Права участника чата по умолчанию, для групп и супергрупп
accepted_gift_types AcceptedGiftTypes Информация о типах подарков, которые принимает чат или соответствующий пользователь для личных чатов
can_send_paid_media True Необязательное. True, если платные медиасообщения можно отправлять или пересылать в чат канала. Поле доступно только для чатов каналов.
slow_mode_delay Integer Необязательное. Для супергрупп — минимально допустимая задержка между последовательными сообщениями каждого непривилегированного пользователя; в секундах
unrestrict_boost_count Integer Необязательное. Для супергрупп — минимальное количество бустов, которое пользователь-неадминистратор должен добавить, чтобы игнорировать медленный режим и разрешения чата
message_auto_delete_time Integer Необязательное. Время, после которого все отправленные в чат сообщения будут автоматически удалены; в секундах
has_aggressive_anti_spam_enabled True Необязательное. True, если в супергруппе включены агрессивные проверки на спам. Поле доступно только администраторам чата.
has_hidden_members True Необязательное. True, если не-администраторы могут получить только список ботов и администраторов в чате
has_protected_content True Необязательное. True, если сообщения из этого чата нельзя пересылать в другие чаты
has_visible_history True Необязательное. True, если новые участники чата будут иметь доступ к старым сообщениям; доступно только администраторам чата
sticker_set_name String Необязательное. Для супергрупп — название стикерпака группы
can_set_sticker_set True Необязательное. True, если бот может менять набор стикеров группы
custom_emoji_sticker_set_name String Необязательное. Для супергрупп — название набора стикеров с кастомными эмодзи группы. Кастомные эмодзи из этого набора могут использовать все пользователи и боты в группе.
linked_chat_id Integer Необязательное. Уникальный идентификатор связанного чата, т. е. идентификатор группы обсуждения для канала и наоборот; для супергрупп и чатов каналов. Этот идентификатор может быть больше 32 бит, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он меньше 52 бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
location ChatLocation Необязательное. Для супергрупп — местоположение, к которому привязана супергруппа
rating UserRating Необязательное. Для личных чатов — рейтинг пользователя, если он есть
first_profile_audio Audio Необязательное. Для приватных чатов — первое аудио, добавленное в профиль пользователя
unique_gift_colors UniqueGiftColors Необязательное. Цветовая схема на основе уникального подарка, которая должна использоваться для имени чата, ответов на сообщения и предпросмотров ссылок
paid_message_star_count Integer Необязательное. Количество Ansible Stars, которое обычный пользователь должен заплатить, чтобы отправить сообщение в чат
guard_bot User Необязательное. Бот, который обрабатывает запросы на вступление в чате. Поле доступно только администраторам чата.
сообщество Сообщество Необязательное. Сообщество которому принадлежит чат

Message

Этот объект представляет сообщение.

Поле Тип Описание
message_id Integer Уникальный идентификатор сообщения внутри этого чата; 0 для эфемерных сообщений. В отдельных случаях (например, сообщение с видео, отправленное в большой чат) сервер может автоматически запланировать сообщение вместо немедленной отправки. В таких случаях это поле будет равно 0, и соответствующее сообщение будет непригодно к использованию, пока не будет действительно отправлено.
message_thread_id Integer Необязательное. Уникальный идентификатор ветки сообщений или темы форума, которой принадлежит сообщение; только для супергрупп и личных чатов
direct_messages_topic DirectMessagesTopic Необязательное. Информация о теме чата личных сообщений, которая содержит это сообщение
from User Необязательное. Отправитель сообщения; может быть пустым для сообщений, отправленных в каналы. Для обратной совместимости, если сообщение было отправлено от имени чата, поле содержит фиктивного пользователя-отправителя в неканальных чатах.
sender_chat Chat Необязательное. Отправитель сообщения, когда оно отправлено от имени чата. Например, сама супергруппа для сообщений, отправленных её анонимными администраторами, или связанный канал для сообщений, автоматически пересылаемых в группу обсуждения канала. Для обратной совместимости, если сообщение было отправлено от имени чата, поле from содержит фиктивного пользователя-отправителя в чатах, не являющихся каналами.
sender_boost_count Integer Необязательное. Если отправитель сообщения бустил чат — количество бустов, добавленных пользователем
sender_business_bot User Необязательное. Бот, который фактически отправил сообщение от имени бизнес-аккаунта. Доступно только для исходящих сообщений, отправленных от имени подключённого бизнес-аккаунта.
sender_tag String Необязательное. Тег или пользовательское звание отправителя сообщения; только для супергрупп
receiver_user User Необязательное. Для эфемерных сообщений — пользователь, получивший сообщение
ephemeral_message_id Integer Необязательное. Для эфемерных сообщений — идентификатор эфемерного сообщения внутри этого чата. Идентификатор может быть повторно использован для другого эфемерного сообщения после того, как сообщение будет удалено или истечёт.
date Integer Дата отправки сообщения в Unix time. Это всегда положительное число, представляющее корректную дату.
guest_query_id String Необязательное. Уникальный идентификатор гостевого запроса. Используйте этот идентификатор с методом answerGuestQuery чтобы отправить ответное сообщение. Если непусто, сообщение принадлежит чату, в который был вызван гостевой бот, и этот чат может не совпадать с другими существующими чатами бота с тем же идентификатором.
business_connection_id String Необязательное. Уникальный идентификатор бизнес-подключения, из которого получено сообщение. Если не пусто, сообщение принадлежит чату соответствующего бизнес-аккаунта, который независим от любого возможного чата бота, который может иметь тот же идентификатор.
chat Chat Чат, которому принадлежит сообщение
forward_origin MessageOrigin Необязательное. Информация об исходном сообщении для пересланных сообщений
is_topic_message True Необязательное. True, если сообщение отправлено в тему форум-супергруппы или в личный чат с ботом
is_automatic_forward True Необязательное. True, если сообщение является постом канала, который был автоматически переслан в связанную группу обсуждения
reply_to_message Message Необязательное. Для ответов в том же чате и той же ветке сообщений — исходное сообщение. Обратите внимание, что Message объект в этом поле не будет содержать дальнейших reply_to_message поля, даже если оно само является ответом. Если сообщение является ответом на эфемерное сообщение, то это поле может быть опущено.
external_reply ExternalReplyInfo Необязательное. Информация о сообщении, на которое отвечают; оно может быть из другого чата или темы форума
quote TextQuote Необязательное. Для ответов, цитирующих часть исходного сообщения, — процитированная часть сообщения
reply_to_story Story Необязательное. Для ответов на историю — исходная история
reply_to_checklist_task_id Integer Необязательное. Идентификатор конкретной задачи чек-листа, на которую даётся ответ
reply_to_poll_option_id String Необязательное. Постоянный идентификатор конкретного варианта ответа опроса, на который отвечают
via_bot User Необязательное. Бот, через которого было отправлено сообщение
guest_bot_caller_user User Необязательное. Для сообщения, отправленного гостевым ботом, это пользователь, чьё исходное сообщение вызвало ответ бота
guest_bot_caller_chat Chat Необязательное. Для сообщения, отправленного гостевым ботом, это чат, исходное сообщение которого вызвало ответ бота
edit_date Integer Необязательное. Дата последнего редактирования сообщения в формате Unix time
has_protected_content True Необязательное. True, если сообщение нельзя переслать
is_from_offline True Необязательное. True, если сообщение было отправлено неявным действием, например, как бизнес-сообщение об отсутствии или приветственное сообщение, либо как отложенное сообщение
is_paid_post True Необязательное. True, если сообщение является платным постом. Обратите внимание, что такие посты нельзя удалять в течение 24 часов, чтобы получить оплату, и их нельзя редактировать.
media_group_id String Необязательное. Уникальный идентификатор внутри этого чата группы медиасообщений, к которой относится это сообщение
author_signature String Необязательное. Подпись автора поста для сообщений в каналах или пользовательское звание анонимного администратора группы
paid_star_count Integer Необязательное. Количество Ansible Stars, которое отправитель сообщения заплатил за его отправку
text String Необязательное. Для текстовых сообщений — сам текст сообщения в UTF-8
entities Array of MessageEntity Необязательное. Для текстовых сообщений — специальные сущности, такие как имена пользователей, URL, команды бота и т. д., встречающиеся в тексте
link_preview_options LinkPreviewOptions Необязательное. Параметры, использованные для формирования предпросмотра ссылки в сообщении, если это текстовое сообщение и параметры предпросмотра ссылки были изменены
suggested_post_info SuggestedPostInfo Необязательное. Информация о параметрах предложенного поста, если сообщение является предложенным постом в чате личных сообщений канала. Если сообщение является одобренным или отклонённым предложенным постом, то его нельзя редактировать.
effect_id String Необязательное. Уникальный идентификатор эффекта сообщения, добавленного к сообщению
rich_message RichMessage Необязательное. Сообщение является rich-сообщением с расширенным форматированием
animation Animation Необязательное. Сообщение является анимацией, информация об анимации. Для обратной совместимости, когда это поле установлено, document поле также будет установлено.
audio Audio Необязательное. Сообщение представляет собой аудиофайл, информация о файле
document Document Необязательное. Сообщение является обычным файлом, информация о файле
live_photo LivePhoto Необязательное. Сообщение является live-фото, информация о live-фото. Для обратной совместимости, когда это поле задано, photo поле также будет установлено.
paid_media PaidMediaInfo Необязательное. Сообщение содержит платное медиа; информация о платном медиа
photo Array of PhotoSize Необязательное. Сообщение является фотографией, доступные размеры фотографии
sticker Sticker Необязательное. Сообщение является стикером, информация о стикере
story Story Необязательное. Сообщение является пересланной историей
video Video Необязательное. Сообщение является видео, информация о видео
video_note VideoNote Необязательное. Сообщение является видеосообщением, информация о видеосообщении
voice Voice Необязательное. Сообщение является голосовым сообщением, информация о файле
caption String Необязательное. Подпись к анимации, аудио, документу, платному медиа, фото, видео или голосовому сообщению
caption_entities Array of MessageEntity Необязательное. Для сообщений с подписью — специальные сущности, такие как имена пользователей, URL, команды бота и т. п., которые встречаются в подписи
show_caption_above_media True Необязательное. True, если подпись должна отображаться над медиа сообщения
has_media_spoiler True Необязательное. True, если медиа сообщения скрыто анимацией спойлера
чек-лист Checklist Необязательное. Сообщение является чек-листом
contact Contact Необязательное. Сообщение является отправленным контактом, информация о контакте
dice Dice Необязательное. Сообщение является кубиком со случайным значением
game Game Необязательное. Сообщение является игрой, информация об игре. Подробнее об играх »
poll Poll Необязательное. Сообщение является встроенным опросом, информация об опросе
venue Venue Необязательное. Сообщение является местом (venue), информация о месте. Для обратной совместимости, когда это поле задано, location поле также будет установлено.
location Location Необязательное. Сообщение представляет собой отправленную геопозицию, информация о геопозиции
new_chat_members Array of User Необязательное. Новые участники, которые были добавлены в группу или супергруппу, и информация о них (сам бот может быть одним из этих участников)
left_chat_member User Необязательное. Участник был удалён из группы, информация о нём (этим участником может быть сам бот)
chat_owner_left ChatOwnerLeft Необязательное. Служебное сообщение: владелец чата вышел
chat_owner_changed ChatOwnerChanged Необязательное. Служебное сообщение: сменился владелец чата
new_chat_title String Необязательное. Название чата было изменено на это значение
new_chat_photo Array of PhotoSize Необязательное. Фото чата было изменено на это значение
delete_chat_photo True Необязательное. Служебное сообщение: фото чата было удалено
group_chat_created True Необязательное. Служебное сообщение: группа была создана
supergroup_chat_created True Необязательное. Служебное сообщение: супергруппа была создана. Это поле нельзя получить в сообщении, приходящем через updates, потому что бот не может быть участником супергруппы в момент её создания. Его можно найти только в reply_to_message, если кто-то отвечает на самое первое сообщение в напрямую созданной супергруппе.
channel_chat_created True Необязательное. Служебное сообщение: канал был создан. Это поле не может быть получено в сообщении, приходящем через обновления, потому что бот не может быть участником канала в момент его создания. Оно может быть найдено только в reply_to_message, если кто-то отвечает на самое первое сообщение в канале.
message_auto_delete_timer_changed MessageAutoDeleteTimerChanged Необязательное. Служебное сообщение: в чате изменены настройки таймера автоудаления
migrate_to_chat_id Integer Необязательное. Группа была перенесена в супергруппу с указанным идентификатором. Это число может иметь более 32 значащих битов, и некоторые языки программирования могут испытывать трудности/давать незаметные дефекты при его интерпретации. Но оно имеет не более 52 значащих битов, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
migrate_from_chat_id Integer Необязательное. Супергруппа была преобразована из группы с указанным идентификатором. Это число может иметь больше 32 значимых бит, и некоторые языки программирования могут испытывать трудности/иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значимых бит, поэтому знаковое 64-битное целое или число с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
pinned_message MaybeInaccessibleMessage Необязательное. Указанное сообщение было закреплено. Обратите внимание, что Message объект в этом поле не будет содержать дальнейших reply_to_message поля, даже если оно само является ответом.
invoice Invoice Необязательное. Сообщение является счётом на платёж, информация о счёте. Подробнее о платежах »
successful_payment SuccessfulPayment Необязательное. Сообщение является служебным сообщением об успешном платеже, информация о платеже. Подробнее о платежах »
refunded_payment RefundedPayment Необязательное. Сообщение является служебным сообщением о возвращённом платеже, информация о платеже. Подробнее о платежах »
users_shared UsersShared Необязательное. Служебное сообщение: пользователи были переданы боту
chat_shared ChatShared Необязательное. Служебное сообщение: чат был передан боту
gift GiftInfo Необязательное. Служебное сообщение: обычный подарок был отправлен или получен
unique_gift UniqueGiftInfo Необязательное. Служебное сообщение: был отправлен или получен уникальный подарок
gift_upgrade_sent GiftInfo Необязательное. Служебное сообщение: улучшение подарка было куплено после отправки подарка
connected_website String Необязательное. Доменное имя сайта, на котором пользователь вошёл в систему. Подробнее об Ansible Login »
write_access_allowed WriteAccessAllowed Необязательное. Служебное сообщение: пользователь разрешил боту писать сообщения после добавления его в меню вложений или боковое меню, запуска Web App по ссылке либо принятия явного запроса от Web App, отправленного методом requestWriteAccess
passport_data PassportData Необязательное. Данные Ansible Passport
proximity_alert_triggered ProximityAlertTriggered Необязательное. Служебное сообщение: пользователь в чате сработал оповещение о приближении другого пользователя во время трансляции живой геопозиции
boost_added ChatBoostAdded Необязательное. Служебное сообщение: пользователь забустил чат
chat_background_set ChatBackground Необязательное. Служебное сообщение: установлен фон чата
checklist_tasks_done ChecklistTasksDone Необязательное. Служебное сообщение: некоторые задачи в чек-листе были отмечены как выполненные или невыполненные
checklist_tasks_added ChecklistTasksAdded Необязательное. Служебное сообщение: в чек-лист были добавлены задачи
community_chat_added CommunityChatAdded Необязательное. Служебное сообщение: чат добавлен в Сообщество
community_chat_removed CommunityChatRemoved Необязательное. Служебное сообщение: чат удалён из Сообщество
direct_message_price_changed DirectMessagePriceChanged Необязательное. Служебное сообщение: изменилась цена платных сообщений в соответствующем чате личных сообщений канала
forum_topic_created ForumTopicCreated Необязательное. Служебное сообщение: создана тема форума
forum_topic_edited ForumTopicEdited Необязательное. Служебное сообщение: тема форума отредактирована
forum_topic_closed ForumTopicClosed Необязательное. Служебное сообщение: тема форума закрыта
forum_topic_reopened ForumTopicReopened Необязательное. Служебное сообщение: тема форума переоткрыта
general_forum_topic_hidden GeneralForumTopicHidden Необязательное. Служебное сообщение: тема форума 'General' скрыта
general_forum_topic_unhidden GeneralForumTopicUnhidden Необязательное. Служебное сообщение: тема форума 'General' снова показана
giveaway_created GiveawayCreated Необязательное. Служебное сообщение: создан запланированный розыгрыш
giveaway Giveaway Необязательное. Сообщение является сообщением о запланированном розыгрыше
giveaway_winners GiveawayWinners Необязательное. Розыгрыш с публичными победителями был завершён
giveaway_completed GiveawayCompleted Необязательное. Служебное сообщение: розыгрыш без публичных победителей был завершён
managed_bot_created ManagedBotCreated Необязательное. Служебное сообщение: пользователь создал бота, которым будет управлять текущий бот
paid_message_price_changed PaidMessagePriceChanged Необязательное. Служебное сообщение: в чате изменилась цена платных сообщений
poll_option_added PollOptionAdded Необязательное. Служебное сообщение: в опрос был добавлен вариант ответа
poll_option_deleted PollOptionDeleted Необязательное. Служебное сообщение: вариант ответа был удалён из опроса
suggested_post_approved SuggestedPostApproved Необязательное. Служебное сообщение: предложенный пост был одобрен
suggested_post_approval_failed SuggestedPostApprovalFailed Необязательное. Служебное сообщение: одобрение предложенного поста не удалось
suggested_post_declined SuggestedPostDeclined Необязательное. Служебное сообщение: предложенный пост был отклонён
suggested_post_paid SuggestedPostPaid Необязательное. Служебное сообщение: получена оплата за предложенный пост
suggested_post_refunded SuggestedPostRefunded Необязательное. Служебное сообщение: оплата за предложенный пост была возвращена
video_chat_scheduled VideoChatScheduled Необязательное. Служебное сообщение: запланирован видеочат
video_chat_started VideoChatStarted Необязательное. Служебное сообщение: видеочат начат
video_chat_ended VideoChatEnded Необязательное. Служебное сообщение: видеочат завершён
video_chat_participants_invited VideoChatParticipantsInvited Необязательное. Служебное сообщение: в видеочат приглашены новые участники
web_app_data WebAppData Необязательное. Служебное сообщение: данные, отправленные Web App
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению. login_url кнопки представлены как обычные url кнопки.

MessageId

Этот объект представляет уникальный идентификатор сообщения.

Поле Тип Описание
message_id Integer Уникальный идентификатор сообщения. В отдельных случаях (например, сообщение с видео, отправленное в большой чат) сервер может автоматически запланировать сообщение вместо немедленной отправки. В таких случаях это поле будет равно 0, а соответствующее сообщение будет непригодно для использования, пока оно действительно не будет отправлено.

InaccessibleMessage

Этот объект описывает сообщение, которое было удалено или иным образом недоступно боту.

Поле Тип Описание
chat Chat Чат, которому принадлежало сообщение
message_id Integer Уникальный идентификатор сообщения внутри чата
date Integer Всегда 0. Поле можно использовать, чтобы отличать обычные сообщения от недоступных.

MaybeInaccessibleMessage

Этот объект описывает сообщение, которое может быть недоступно боту. Это может быть одно из

MessageEntity

Этот объект представляет одну специальную сущность в текстовом сообщении. Например, хештеги, имена пользователей, URL и т. д.

Поле Тип Описание
type String Тип сущности. В настоящее время может быть «mention» (@username), «hashtag» (#hashtag or #hashtag@chatusername), «cashtag» ($USD or $USD@chatusername), «bot_command» (/start@jobs_bot), «url» (https://ansible.su), «email» (do-not-reply@ansible.su), «phone_number» (+1-212-555-0123), «bold» (полужирный текст), “italic” (курсивный текст), «underline» (подчёркнутый текст), «strikethrough» (зачёркнутый текст), «spoiler» (текст-спойлер), «blockquote» (цитата), «expandable_blockquote» (свёрнутая по умолчанию цитата), «code» (моноширинная строка), «pre» (моноширинный блок), «text_link» (для кликабельных текстовых URL), «text_mention» (для пользователей без имён пользователя), «custom_emoji» (для встроенных стикеров с пользовательскими эмодзи) или «date_time» (для форматированных даты и времени).
offset Integer Смещение в кодовых единицах UTF-16 до начала сущности
длины Integer Длина сущности в кодовых единицах UTF-16
url String Необязательное. Только для «text_link», URL, который будет открыт после нажатия пользователем на текст
пользователя User Необязательное. Только для «text_mention» — упомянутый пользователь
language String Необязательное. Только для «pre» — язык программирования текста сущности
custom_emoji_id String Необязательное. Только для “custom_emoji” — уникальный идентификатор кастомного эмодзи. Используйте getCustomEmojiStickers чтобы получить полную информацию о стикере.
unix_time Integer Необязательное. Только для «date_time» — Unix-время, связанное с сущностью
date_time_format String Необязательное. Только для «date_time», строка, определяющая формат даты и времени. См. форматирование сущности даты и времени подробнее.

TextQuote

Этот объект содержит информацию о процитированной части сообщения, на которое отвечает данное сообщение.

Поле Тип Описание
text String Текст процитированной части сообщения, на которое отвечает данное сообщение
entities Array of MessageEntity Необязательное. Специальные сущности, встречающиеся в цитате. В настоящее время только bold, italic, underline, strikethrough, spoiler, custom_emoji, и date_time сущности сохраняются в кавычках.
position Integer Примерная позиция цитаты в исходном сообщении в кодовых единицах UTF-16, указанная отправителем
is_manual True Необязательное. True, если цитата была выбрана вручную отправителем сообщения. В противном случае цитата была добавлена сервером автоматически.

ExternalReplyInfo

Этот объект содержит информацию о сообщении, на которое даётся ответ и которое может быть из другого чата или темы форума.

Поле Тип Описание
origin MessageOrigin Источник сообщения, на которое отвечает данное сообщение
chat Chat Необязательное. Чат, которому принадлежит исходное сообщение. Доступно, только если чат является супергруппой или каналом.
message_id Integer Необязательное. Уникальный идентификатор сообщения внутри исходного чата. Доступно, только если исходный чат является супергруппой или каналом.
link_preview_options LinkPreviewOptions Необязательное. Параметры, использованные для генерации предпросмотра ссылки в исходном сообщении, если это текстовое сообщение
animation Animation Необязательное. Сообщение является анимацией, информация об анимации
audio Audio Необязательное. Сообщение представляет собой аудиофайл, информация о файле
document Document Необязательное. Сообщение является обычным файлом, информация о файле
live_photo LivePhoto Необязательное. Сообщение является live-фото, информация о live-фото
paid_media PaidMediaInfo Необязательное. Сообщение содержит платное медиа; информация о платном медиа
photo Array of PhotoSize Необязательное. Сообщение является фотографией, доступные размеры фотографии
sticker Sticker Необязательное. Сообщение является стикером, информация о стикере
story Story Необязательное. Сообщение является пересланной историей
video Video Необязательное. Сообщение является видео, информация о видео
video_note VideoNote Необязательное. Сообщение является видеосообщением, информация о видеосообщении
voice Voice Необязательное. Сообщение является голосовым сообщением, информация о файле
has_media_spoiler True Необязательное. True, если медиа сообщения скрыто анимацией спойлера
чек-лист Checklist Необязательное. Сообщение является чек-листом
contact Contact Необязательное. Сообщение является отправленным контактом, информация о контакте
dice Dice Необязательное. Сообщение является кубиком со случайным значением
game Game Необязательное. Сообщение является игрой, информация об игре. Подробнее об играх »
giveaway Giveaway Необязательное. Сообщение — это запланированный розыгрыш, информация о розыгрыше
giveaway_winners GiveawayWinners Необязательное. Розыгрыш с публичными победителями был завершён
invoice Invoice Необязательное. Сообщение является счётом на платёж, информация о счёте. Подробнее о платежах »
location Location Необязательное. Сообщение представляет собой отправленную геопозицию, информация о геопозиции
poll Poll Необязательное. Сообщение является встроенным опросом, информация об опросе
venue Venue Необязательное. Сообщение является местом, информация о месте

ReplyParameters

Описывает параметры ответа для отправляемого сообщения.

Поле Тип Описание
message_id Integer Необязательное. Идентификатор сообщения, на которое будет дан ответ в текущем чате или в чате chat_id если он указан. Обязательно, если ephemeral_message_id не указан.
chat_id Integer или String Необязательное. Если сообщение, на которое даётся ответ, находится в другом чате — уникальный идентификатор чата или имя пользователя бота, супергруппы или канала в формате @username. Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта, сообщений из чатов личных сообщений канала и эфемерных сообщений.
ephemeral_message_id Integer Необязательное. Идентификатор входящего эфемерного сообщения, на которое будет дан ответ в текущем чате. Ответ на эфемерное сообщение сам должен быть эфемерным сообщением. Ответить на эфемерное сообщение можно только в течение 15 секунд после его отправки. Обязательно, если message_id не указан.
allow_sending_without_reply Boolean Необязательное. Передайте True если сообщение должно быть отправлено, даже если указанное сообщение, на которое нужно ответить, не найдено. Всегда False для ответов в другом чате или теме форума, а также для отправленных эфемерных сообщений. Всегда True для сообщений, отправленных от имени бизнес-аккаунта.
quote String Необязательное. Цитируемая часть сообщения, на которое даётся ответ; 0-1024 символа после разбора сущностей. Цитата должна быть точной подстрокой сообщения, на которое даётся ответ, включая bold, italic, underline, strikethrough, spoiler, custom_emoji, и date_time entities. Сообщение не будет отправлено, если цитата не найдена в исходном сообщении. Игнорируется для эфемерных сообщений.
quote_parse_mode String Необязательное. Режим разбора сущностей в цитате. См. варианты форматирования подробнее.
quote_entities Array of MessageEntity Необязательное. JSON-сериализованный список специальных сущностей, которые присутствуют в цитате. Может быть указан вместо quote_parse_mode.
quote_position Integer Необязательное. Позиция цитаты в исходном сообщении в кодовых единицах UTF-16
checklist_task_id Integer Необязательное. Идентификатор конкретной задачи чек-листа, на которую нужно ответить
poll_option_id String Необязательное. Постоянный идентификатор конкретного варианта опроса, на который даётся ответ

MessageOrigin

Этот объект описывает происхождение сообщения. Это может быть один из

MessageOriginUser

Изначально сообщение было отправлено известным пользователем.

Поле Тип Описание
type String Тип источника сообщения, всегда «user»
date Integer Дата, когда сообщение было отправлено изначально, в формате Unix time
sender_user User Пользователь, который изначально отправил сообщение

MessageOriginHiddenUser

Сообщение изначально было отправлено неизвестным пользователем.

Поле Тип Описание
type String Тип источника сообщения, всегда «hidden_user»
date Integer Дата, когда сообщение было отправлено изначально, в формате Unix time
sender_user_name String Имя пользователя, который изначально отправил сообщение

MessageOriginChat

Сообщение было изначально отправлено от имени чата в групповой чат.

Поле Тип Описание
type String Тип источника сообщения, всегда «chat»
date Integer Дата, когда сообщение было отправлено изначально, в формате Unix time
sender_chat Chat Чат, который изначально отправил сообщение
author_signature String Необязательное. Для сообщений, изначально отправленных анонимным администратором чата, подпись автора исходного сообщения

MessageOriginChannel

Изначально сообщение было отправлено в чат канала.

Поле Тип Описание
type String Тип источника сообщения, всегда «channel»
date Integer Дата, когда сообщение было отправлено изначально, в формате Unix time
chat Chat Чат канала, в который изначально было отправлено сообщение
message_id Integer Уникальный идентификатор сообщения внутри чата
author_signature String Необязательное. Подпись автора исходного поста

PhotoSize

Этот объект представляет один размер фотографии или file / sticker миниатюра.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
width Integer Ширина фотографии
height Integer Высота фото
file_size Integer Необязательное. Размер файла в байтах

Animation

Этот объект представляет файл анимации (GIF или видео H.264/MPEG-4 AVC без звука).

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
width Integer Ширина видео, заданная отправителем
height Integer Высота видео, заданная отправителем
duration Integer Длительность видео в секундах, как указано отправителем
thumbnail PhotoSize Необязательное. Миниатюра анимации, заданная отправителем
file_name String Необязательное. Исходное имя файла анимации, заданное отправителем
mime_type String Необязательное. MIME-тип файла, указанный отправителем
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.

Audio

Этот объект представляет аудиофайл, который клиенты Ansible должны воспринимать как музыку.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
duration Integer Длительность аудио в секундах, как указано отправителем
performer String Необязательное. Исполнитель аудио, заданный отправителем или тегами аудио
title String Необязательное. Название аудио, заданное отправителем или аудиотегами
file_name String Необязательное. Исходное имя файла, заданное отправителем
mime_type String Необязательное. MIME-тип файла, указанный отправителем
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.
thumbnail PhotoSize Необязательное. Миниатюра обложки альбома, к которому относится музыкальный файл

Document

Этот объект представляет обычный файл (в отличие от photos, голосовые сообщения и аудиофайлы).

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
thumbnail PhotoSize Необязательное. Миниатюра документа, заданная отправителем
file_name String Необязательное. Исходное имя файла, заданное отправителем
mime_type String Необязательное. MIME-тип файла, указанный отправителем
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.

LivePhoto

Этот объект представляет live-фото.

Поле Тип Описание
photo Array of PhotoSize Необязательное. Доступные размеры соответствующего статичного фото
file_id String Идентификатор видеофайла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор видеофайла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или переиспользования файла.
width Integer Ширина видео, заданная отправителем
height Integer Высота видео, заданная отправителем
duration Integer Длительность видео в секундах, как указано отправителем
mime_type String Необязательное. MIME-тип файла, указанный отправителем
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.

Story

Этот объект представляет историю.

Поле Тип Описание
chat Chat Чат, опубликовавший историю
id Integer Уникальный идентификатор истории в чате

VideoQuality

Этот объект представляет видеофайл определённого качества.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
width Integer Ширина видео
height Integer Высота видео
codec String Кодек, который использовался для кодирования видео, например «h264», «h265» или «av01»
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.

Video

Этот объект представляет видеофайл.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
width Integer Ширина видео, заданная отправителем
height Integer Высота видео, заданная отправителем
duration Integer Длительность видео в секундах, как указано отправителем
thumbnail PhotoSize Необязательное. Миниатюра видео
cover Array of PhotoSize Необязательное. Доступные размеры обложки видео в сообщении
start_timestamp Integer Необязательное. Отметка времени в секундах, с которой видео будет воспроизводиться в сообщении
qualities Array of VideoQuality Необязательное. Список доступных качеств видео
file_name String Необязательное. Исходное имя файла, заданное отправителем
mime_type String Необязательное. MIME-тип файла, указанный отправителем
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.

VideoNote

Этот объект представляет видеосообщение (доступно в приложениях Ansible начиная с v.4.0).

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
длины Integer Ширина и высота видео (диаметр видеосообщения), заданные отправителем
duration Integer Длительность видео в секундах, как указано отправителем
thumbnail PhotoSize Необязательное. Миниатюра видео
file_size Integer Необязательное. Размер файла в байтах

Voice

Этот объект представляет голосовое сообщение.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
duration Integer Длительность аудио в секундах, как указано отправителем
mime_type String Необязательное. MIME-тип файла, указанный отправителем
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.

PaidMediaInfo

Описывает платное медиа, добавленное к сообщению.

Поле Тип Описание
star_count Integer Количество Ansible Stars, которое необходимо заплатить, чтобы купить доступ к медиа
paid_media Array of PaidMedia Информация о платном медиа

PaidMedia

Этот объект описывает платное медиа. В настоящее время это может быть одно из

PaidMediaLivePhoto

Платное медиа — это живое фото.

Поле Тип Описание
type String Тип платного медиа, всегда «live_photo»
live_photo LivePhoto Фото

PaidMediaPhoto

Платное медиа является фотографией.

Поле Тип Описание
type String Тип платного медиа, всегда «photo»
photo Array of PhotoSize Фото

PaidMediaPreview

Платное медиа недоступно до оплаты.

Поле Тип Описание
type String Тип платного медиа, всегда «preview»
width Integer Необязательное. Ширина медиа, как указано отправителем
height Integer Необязательное. Высота медиа, заданная отправителем
duration Integer Необязательное. Длительность медиа в секундах, как указано отправителем

PaidMediaVideo

Платное медиа — это видео.

Поле Тип Описание
type String Тип платного медиа, всегда «video»
video Video Видео

Contact

Этот объект представляет телефонный контакт.

Поле Тип Описание
phone_number String Номер телефона контакта
first_name String Имя контакта
last_name String Необязательное. Фамилия контакта
user_id Integer Необязательное. Идентификатор пользователя контакта в Ansible. Это число может иметь больше 32 значимых бит, и некоторые языки программирования могут испытывать трудности/иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значимых бит, поэтому 64-битное целое или число с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
vcard String Необязательное. Дополнительные данные о контакте в виде vCard

Dice

Этот объект представляет анимированный эмодзи, отображающий случайное значение.

Поле Тип Описание
emoji String Эмодзи, на котором основана анимация броска кубика
value Integer Значение кубика, 1-6 для «🎲”, “🎯» и «🎳» базовый эмодзи, 1-5 для «🏀» и «⚽» базовое эмодзи, 1-64 для «🎰» базовый эмодзи

Ссылка

Представляет HTTP-ссылку.

Поле Тип Описание
url String URL ссылки

PollMedia

Не более одно из необязательных полей может присутствовать в любом отдельно взятом объекте.

Поле Тип Описание
animation Animation Необязательное. Медиа является анимацией, информация об анимации
audio Audio Необязательное. Медиа является аудиофайлом, информация о файле; в настоящее время не может быть получено в варианте ответа опроса
document Document Необязательное. Медиа является обычным файлом, информация о файле; в настоящее время не может быть получено в варианте ответа опроса
link Ссылка Необязательное. HTTP-ссылка, прикреплённая к варианту ответа опроса
live_photo LivePhoto Необязательное. Медиа является live-фото, информация о live-фото
location Location Необязательное. Медиа — это отправленное местоположение, информация о местоположении
photo Array of PhotoSize Необязательное. Медиа является фотографией, доступные размеры фотографии
sticker Sticker Необязательное. Медиа является стикером, информация о стикере; в настоящее время только для вариантов ответа опроса
venue Venue Необязательное. Медиа — место, информация о месте
video Video Необязательное. Медиа является видео, информация о видео

InputPollMedia

Этот объект представляет содержимое отправляемого описания опроса или пояснения к викторине. Это должен быть один из

InputPollOptionMedia

Этот объект представляет содержимое отправляемого варианта ответа опроса. Это должен быть один из

PollOption

Этот объект содержит информацию об одном варианте ответа в опросе.

Поле Тип Описание
persistent_id String Уникальный идентификатор варианта ответа, сохраняющийся при добавлении и удалении вариантов
text String Текст варианта, 1-100 символов
text_entities Array of MessageEntity Необязательное. Специальные сущности, которые встречаются в варианте ответа text. В настоящее время в текстах вариантов ответа опроса допускаются только сущности кастомных эмодзи
media PollMedia Необязательное. Медиа, добавленное к варианту опроса
voter_count Integer Количество пользователей, проголосовавших за этот вариант; может быть 0, если неизвестно
added_by_user User Необязательное. Пользователь, добавивший вариант ответа; отсутствует, если вариант не был добавлен пользователем после создания опроса
added_by_chat Chat Необязательное. Чат, добавивший вариант ответа; отсутствует, если вариант не был добавлен чатом после создания опроса
addition_date Integer Необязательное. Момент времени (Unix timestamp), когда был добавлен вариант ответа; отсутствует, если вариант был в исходном опросе

InputPollOption

Этот объект содержит информацию об одном варианте ответа в отправляемом опросе.

Поле Тип Описание
text String Текст варианта, 1-100 символов
text_parse_mode String Необязательное. Режим разбора сущностей в тексте. См. варианты форматирования для получения дополнительной информации. В настоящее время разрешены только сущности кастомных эмодзи.
text_entities Array of MessageEntity Необязательное. JSON-сериализованный список специальных сущностей, которые присутствуют в тексте варианта ответа опроса. Может быть указан вместо text_parse_mode.
media InputPollOptionMedia Необязательное. Медиа, добавленное к варианту опроса

PollAnswer

Этот объект представляет ответ пользователя в неанонимном опросе.

Поле Тип Описание
poll_id String Уникальный идентификатор опроса
voter_chat Chat Необязательное. Чат, изменивший ответ в опросе, если голосующий анонимен
пользователя User Необязательное. Пользователь, изменивший ответ в опросе, если голосующий не анонимен
option_ids Array of Integer Идентификаторы выбранных вариантов ответа, начинающиеся с 0. Может быть пустым, если голос был отозван.
option_persistent_ids Array of String Постоянные идентификаторы выбранных вариантов ответа. Может быть пустым, если голос был отозван.

Poll

Этот объект содержит информацию об опросе.

Поле Тип Описание
id String Уникальный идентификатор опроса
question String Вопрос опроса, 1-300 символов
question_entities Array of MessageEntity Необязательное. Специальные сущности, которые встречаются в question. В настоящее время в вопросах опроса разрешены только сущности custom emoji
options Array of PollOption Список вариантов ответа опроса
total_voter_count Integer Общее количество пользователей, проголосовавших в опросе
is_closed Boolean True, если опрос закрыт
is_anonymous Boolean True, если опрос анонимный
type String Тип опроса, в настоящее время может быть «regular» или «quiz»
allows_multiple_answers Boolean True, если опрос допускает несколько вариантов ответа
allows_revoting Boolean True, если опрос позволяет менять выбранные варианты ответа
members_only Boolean True если голосование ограничено пользователями, которые состоят в чате, где изначально был отправлен опрос, более 24 часов
country_codes Array of String Необязательное. Список двухбуквенных ISO 3166-1 alpha-2 коды стран, указывающие страны, из которых пользователи могут голосовать в опросе. Код страны “FT” используется для пользователей с анонимными номерами. Если не указано, то в опросе могут участвовать пользователи из любой страны.
correct_option_ids Array of Integer Необязательное. Массив отсчитываемых от нуля идентификаторов правильных вариантов ответа. Доступно только для опросов в режиме викторины, которые закрыты или были отправлены (не пересланы) ботом либо в личный чат с ботом.
explanation String Необязательное. Текст, который показывается, когда пользователь выбирает неверный ответ или нажимает на значок лампочки в опросе-викторине, 0-200 символов
explanation_entities Array of MessageEntity Необязательное. Специальные сущности, такие как имена пользователей, URL, команды бота и т. д., которые встречаются в explanation
explanation_media PollMedia Необязательное. Медиа, добавленное к пояснению викторины
open_period Integer Необязательное. Время в секундах, в течение которого опрос будет активен после создания
close_date Integer Необязательное. Момент времени (Unix timestamp), когда опрос будет автоматически закрыт
description String Необязательное. Описание опроса; для опросов внутри Message объекте только
description_entities Array of MessageEntity Необязательное. Специальные сущности, такие как имена пользователей, URL, команды бота и т. д., встречающиеся в описании
media PollMedia Необязательное. Медиа, добавленное к описанию опроса; для опросов внутри Message объекте только

ChecklistTask

Описывает задачу в чек-листе.

Поле Тип Описание
id Integer Уникальный идентификатор задачи
text String Текст задачи
text_entities Array of MessageEntity Необязательное. Специальные сущности, которые присутствуют в тексте задачи
completed_by_user User Необязательное. Пользователь, выполнивший задачу; отсутствует, если задача была выполнена не пользователем
completed_by_chat Chat Необязательное. Чат, который выполнил задачу; отсутствует, если задача была выполнена не чатом
completion_date Integer Необязательное. Момент времени (Unix timestamp), когда задача была выполнена; 0, если задача не была выполнена

Checklist

Описывает чек-лист.

Поле Тип Описание
title String Название чек-листа
title_entities Array of MessageEntity Необязательное. Специальные сущности, которые встречаются в заголовке чек-листа
tasks Array of ChecklistTask Список задач в чек-листе
others_can_add_tasks True Необязательное. True, если пользователи, отличные от создателя списка, могут добавлять задачи в список
others_can_mark_tasks_as_done True Необязательное. True, если пользователи, отличные от создателя списка, могут отмечать задачи выполненными или невыполненными

InputChecklistTask

Описывает задачу, добавляемую в чек-лист.

Поле Тип Описание
id Integer Уникальный идентификатор задачи; должен быть положительным и уникальным среди всех идентификаторов задач, присутствующих в чек-листе в данный момент
text String Текст задачи; 1-100 символов после разбора entities
parse_mode String Необязательное. Режим разбора сущностей в тексте. См. варианты форматирования подробнее.
text_entities Array of MessageEntity Необязательное. Список специальных сущностей, которые встречаются в тексте; может быть указан вместо parse_mode. В настоящее время только bold, italic, underline, strikethrough, spoiler, custom_emoji, и date_time сущности разрешены.

InputChecklist

Описывает создаваемый чек-лист.

Поле Тип Описание
title String Заголовок чек-листа; 1-255 символов после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в заголовке. См. варианты форматирования подробнее.
title_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в заголовке, который можно указать вместо parse_mode. В настоящее время только bold, italic, underline, strikethrough, spoiler, custom_emoji, и date_time сущности разрешены.
tasks Array of InputChecklistTask Список из 1-30 задач в чек-листе
others_can_add_tasks Boolean Необязательное. Передайте True если другие пользователи могут добавлять задачи в чек-лист
others_can_mark_tasks_as_done Boolean Необязательное. Передайте True если другие пользователи могут отмечать задачи в чек-листе как выполненные или невыполненные

Location

Этот объект представляет точку на карте.

Поле Тип Описание
latitude Float Широта, заданная отправителем
longitude Float Долгота, заданная отправителем
horizontal_accuracy Float Необязательное. Радиус погрешности местоположения, измеряемый в метрах; 0-1500
live_period Integer Необязательное. Время относительно даты отправки сообщения, в течение которого местоположение может обновляться; в секундах. Только для активных трансляций местоположения.
heading Integer Необязательное. Направление, в котором движется пользователь, в градусах; 1-360. Только для активных live-локаций.
proximity_alert_radius Integer Необязательное. Максимальное расстояние для оповещений о приближении к другому участнику чата, в метрах. Только для отправленных live-локаций.

Venue

Этот объект представляет место.

Поле Тип Описание
location Location Местоположение места. Не может быть трансляцией местоположения.
title String Название места
address String Адрес места
foursquare_id String Необязательное. Идентификатор места в Foursquare
foursquare_type String Необязательное. Тип заведения в Foursquare. (Например, «arts_entertainment/default», «arts_entertainment/aquarium» или «food/icecream».)
google_place_id String Необязательное. Идентификатор места в Google Places
google_place_type String Необязательное. Тип места по классификации Google Places. (См. поддерживаемые типы.)

WebAppData

Описывает данные, отправленные из Web App боту.

Поле Тип Описание
data String Данные. Учтите, что недобросовестный клиент может отправить в этом поле произвольные данные.
button_text String Текст web_app кнопки клавиатуры, из которой было открыто Web App. Учтите, что плохой клиент может отправить в этом поле произвольные данные.

ProximityAlertTriggered

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

Поле Тип Описание
traveler User Пользователь, вызвавший оповещение
watcher User Пользователь, установивший оповещение
distance Integer Расстояние между пользователями

MessageAutoDeleteTimerChanged

Этот объект представляет служебное сообщение об изменении настроек таймера автоудаления.

Поле Тип Описание
message_auto_delete_time Integer Новое время автоудаления сообщений в чате; в секундах

ManagedBotCreated

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

Поле Тип Описание
бот User Информация о боте. Токен бота может быть получен с помощью метода getManagedBotToken.

ManagedBotUpdated

Этот объект содержит информацию о создании, обновлении токена или смене владельца бота, которым управляет текущий бот.

Поле Тип Описание
пользователя User Пользователь, создавший бота
бот User Информация о боте. Токен бота можно получить с помощью метода getManagedBotToken.

BotSubscriptionUpdated

Этот объект содержит информацию об изменениях платной подписки пользователя на текущего бота.

Поле Тип Описание
пользователя User Пользователь, который подписался на платежи в пользу бота
invoice_payload String Полезная нагрузка счёта, заданная ботом
state String Новое состояние подписки. В настоящее время это может быть «canceled», если пользователь отменил подписку, «active», если пользователь снова включил ранее отменённую подписку, или «failed», если платёж за подписку не прошёл.

PollOptionAdded

Описывает служебное сообщение о варианте ответа, добавленном в опрос.

Поле Тип Описание
poll_message MaybeInaccessibleMessage Необязательное. Сообщение, содержащее опрос, в который был добавлен вариант ответа, если оно известно. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
option_persistent_id String Уникальный идентификатор добавленного варианта
option_text String Текст варианта
option_text_entities Array of MessageEntity Необязательное. Специальные сущности, которые встречаются в option_text

PollOptionDeleted

Описывает служебное сообщение об удалении варианта из опроса.

Поле Тип Описание
poll_message MaybeInaccessibleMessage Необязательное. Сообщение, содержащее опрос, из которого был удалён вариант ответа, если оно известно. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
option_persistent_id String Уникальный идентификатор удалённого варианта
option_text String Текст варианта
option_text_entities Array of MessageEntity Необязательное. Специальные сущности, которые встречаются в option_text

ChatBoostAdded

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

Поле Тип Описание
boost_count Integer Количество бустов, добавленных пользователем

BackgroundFill

Этот объект описывает способ заливки фона на основе выбранных цветов. В настоящее время это может быть одно из

BackgroundFillSolid

Фон заливается выбранным цветом.

Поле Тип Описание
type String Тип заливки фона, всегда «solid»
color Integer Цвет заливки фона в формате RGB24

BackgroundFillGradient

Фон представляет собой градиентную заливку.

Поле Тип Описание
type String Тип заливки фона, всегда “gradient”
top_color Integer Верхний цвет градиента в формате RGB24
bottom_color Integer Нижний цвет градиента в формате RGB24
rotation_angle Integer Угол поворота заливки фона по часовой стрелке в градусах; 0-359

BackgroundFillFreeformGradient

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

Поле Тип Описание
type String Тип заливки фона, всегда “freeform_gradient”
colors Array of Integer Список из 3 или 4 базовых цветов, которые используются для создания произвольного градиента, в формате RGB24

BackgroundType

Этот объект описывает тип фона. В настоящее время это может быть одно из

BackgroundTypeFill

Фон автоматически заливается на основе выбранных цветов.

Поле Тип Описание
type String Тип фона, всегда «fill»
fill BackgroundFill Заливка фона
dark_theme_dimming Integer Затемнение фона в тёмных темах, в процентах; 0-100

BackgroundTypeWallpaper

Фон представляет собой обои в формате JPEG.

Поле Тип Описание
type String Тип фона, всегда «wallpaper»
document Document Документ с обоями
dark_theme_dimming Integer Затемнение фона в тёмных темах, в процентах; 0-100
is_blurred True Необязательное. True, если обои уменьшены до квадрата 450x450, а затем размыты box-фильтром с радиусом 12
is_moving True Необязательное. True, если фон слегка смещается при наклоне устройства

BackgroundTypePattern

Фон — это узор .PNG или .TGV (сжатое gzip подмножество SVG с MIME-типом «application/x-tgwallpattern»), который должен быть совмещён с заливкой фона, выбранной пользователем.

Поле Тип Описание
type String Тип фона, всегда «pattern»
document Document Документ с узором
fill BackgroundFill Фоновая заливка, которая комбинируется с узором
intensity Integer Интенсивность узора, когда он показан поверх залитого фона; 0-100
is_inverted True Необязательное. True, если заливка фона должна применяться только к самому узору. Все остальные пиксели в этом случае чёрные. Только для тёмных тем.
is_moving True Необязательное. True, если фон слегка смещается при наклоне устройства

BackgroundTypeChatTheme

Фон берётся непосредственно из встроенной темы чата.

Поле Тип Описание
type String Тип фона, всегда «chat_theme»
theme_name String Название темы оформления чата, обычно это эмодзи

ChatBackground

Этот объект представляет фон чата.

Поле Тип Описание
type BackgroundType Тип фона

ChecklistTasksDone

Описывает служебное сообщение о задачах чек-листа, отмеченных как выполненные или невыполненные.

Поле Тип Описание
checklist_message Message Необязательное. Сообщение, содержащее чек-лист, задачи которого были отмечены как выполненные или невыполненные. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
marked_as_done_task_ids Array of Integer Необязательное. Идентификаторы задач, которые были отмечены как выполненные
marked_as_not_done_task_ids Array of Integer Необязательное. Идентификаторы задач, которые были отмечены как невыполненные

ChecklistTasksAdded

Описывает служебное сообщение о задачах, добавленных в чек-лист.

Поле Тип Описание
checklist_message Message Необязательное. Сообщение, содержащее чек-лист, в который были добавлены задачи. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
tasks Array of ChecklistTask Список задач, добавленных в чек-лист

CommunityChatAdded

Описывает служебное сообщение о добавлении чата в сообщество.

Поле Тип Описание
сообщество Сообщество Новое сообщество, которому принадлежит чат

CommunityChatRemoved

Описывает служебное сообщение об удалении чата из сообщества. В настоящее время не содержит информации.

ForumTopicCreated

Этот объект представляет служебное сообщение о создании в чате нового топика форума.

Поле Тип Описание
name String Название темы
icon_color Integer Цвет иконки темы в формате RGB
icon_custom_emoji_id String Необязательное. Уникальный идентификатор кастомного эмодзи, показываемого как иконка темы
is_name_implicit True Необязательное. True, если название темы не было явно указано её создателем и, вероятно, должно быть изменено ботом

ForumTopicClosed

Этот объект представляет служебное сообщение о закрытии темы форума в чате. В настоящее время не содержит информации.

ForumTopicEdited

Этот объект представляет служебное сообщение об отредактированной теме форума.

Поле Тип Описание
name String Необязательное. Новое имя темы, если оно было изменено
icon_custom_emoji_id String Необязательное. Новый идентификатор кастомного эмодзи, показываемого в качестве иконки темы, если он был изменён; пустая строка, если иконка была удалена

ForumTopicReopened

Этот объект представляет служебное сообщение о переоткрытой в чате теме форума. В настоящее время не содержит информации.

GeneralForumTopicHidden

Этот объект представляет служебное сообщение о том, что тема форума General скрыта в чате. В настоящее время не содержит информации.

GeneralForumTopicUnhidden

Этот объект представляет служебное сообщение о том, что тема форума General снова показана в чате. В настоящее время не содержит информации.

SharedUser

Этот объект содержит информацию о пользователе, который был передан боту с помощью KeyboardButtonRequestUsers кнопки.

Поле Тип Описание
user_id Integer Идентификатор переданного пользователя. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или давать незаметные ошибки при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битные целые числа или типы с плавающей точкой двойной точности безопасны для хранения этих идентификаторов. У бота может не быть доступа к пользователю, и он может быть не в состоянии использовать этот идентификатор, если пользователь не известен боту каким-либо другим способом.
first_name String Необязательное. Имя пользователя, если имя было запрошено ботом
last_name String Необязательное. Фамилия пользователя, если имя было запрошено ботом
username String Необязательное. Username пользователя, если username был запрошен ботом
photo Array of PhotoSize Необязательное. Доступные размеры фотографии чата, если фотография была запрошена ботом

UsersShared

Этот объект содержит информацию о пользователях, чьи идентификаторы были переданы боту с помощью KeyboardButtonRequestUsers кнопки.

Поле Тип Описание
request_id Integer Идентификатор запроса
users Array of SharedUser Информация о пользователях, переданных боту

ChatShared

Этот объект содержит информацию о чате, которым поделились с ботом с помощью KeyboardButtonRequestChat кнопки.

Поле Тип Описание
request_id Integer Идентификатор запроса
chat_id Integer Идентификатор переданного чата. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности либо иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битное целое или число с плавающей точкой двойной точности безопасны для хранения этого идентификатора. Бот может не иметь доступа к чату и не сможет использовать этот идентификатор, если только чат уже не известен боту каким-либо другим способом.
title String Необязательное. Название чата, если оно было запрошено ботом
username String Необязательное. Имя пользователя чата, если имя пользователя было запрошено ботом и доступно
photo Array of PhotoSize Необязательное. Доступные размеры фотографии чата, если фотография была запрошена ботом

WriteAccessAllowed

Этот объект представляет служебное сообщение о том, что пользователь разрешил боту писать сообщения после добавления его в меню вложений, запуска Web App по ссылке или принятия явного запроса от Web App, отправленного методом requestWriteAccess.

Поле Тип Описание
from_request Boolean Необязательное. True, если доступ был предоставлен после того, как пользователь принял явный запрос от Web App, отправленный методом requestWriteAccess
web_app_name String Необязательное. Название Web App, если доступ был предоставлен при запуске Web App по ссылке
from_attachment_menu Boolean Необязательное. True, если доступ был предоставлен при добавлении бота в меню вложений или боковое меню

VideoChatScheduled

Этот объект представляет служебное сообщение о видеочате, запланированном в чате.

Поле Тип Описание
start_date Integer Момент времени (Unix timestamp), когда видеочат должен быть начат администратором чата

VideoChatStarted

Этот объект представляет служебное сообщение о начале видеочата в чате. В настоящее время не содержит информации.

VideoChatEnded

Этот объект представляет служебное сообщение о завершившемся в чате видеочате.

Поле Тип Описание
duration Integer Длительность видеочата в секундах

VideoChatParticipantsInvited

Этот объект представляет служебное сообщение о новых участниках, приглашённых в видеочат.

Поле Тип Описание
users Array of User Новые участники, которые были приглашены в видеочат

PaidMessagePriceChanged

Описывает служебное сообщение об изменении цены платных сообщений в чате.

Поле Тип Описание
paid_message_star_count Integer Новое количество Ansible Stars, которое должны платить пользователи чата супергруппы, не являющиеся администраторами, за каждое отправленное сообщение

DirectMessagePriceChanged

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

Поле Тип Описание
are_direct_messages_enabled Boolean True, если для чата канала включены прямые сообщения; False в противном случае
direct_message_star_count Integer Необязательное. Новое количество Ansible Stars, которое пользователи должны платить за каждое личное сообщение, отправленное каналу. Не применяется к пользователям, освобождённым администраторами. По умолчанию 0.

SuggestedPostApproved

Описывает служебное сообщение об одобрении предложенного поста.

Поле Тип Описание
suggested_post_message Message Необязательное. Сообщение, содержащее предложенный пост. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
price SuggestedPostPrice Необязательное. Сумма, уплаченная за пост
send_date Integer Дата, когда пост будет опубликован

SuggestedPostApprovalFailed

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

Поле Тип Описание
suggested_post_message Message Необязательное. Сообщение, содержащее предложенный пост, одобрение которого не удалось. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
price SuggestedPostPrice Ожидаемая цена поста

SuggestedPostDeclined

Описывает служебное сообщение об отклонении предложенного поста.

Поле Тип Описание
suggested_post_message Message Необязательное. Сообщение, содержащее предложенный пост. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
comment String Необязательное. Комментарий, с которым пост был отклонён

SuggestedPostPaid

Описывает служебное сообщение об успешной оплате предложенного поста.

Поле Тип Описание
suggested_post_message Message Необязательное. Сообщение, содержащее предложенный пост. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
currency String Валюта, в которой был произведён платёж. В настоящее время одно из «XTR» для Ansible Stars или «TON» для TON grams.
amount Integer Необязательное. Сумма валюты, полученная каналом, в нанограммах; только для платежей в граммах TON
star_amount StarAmount Необязательное. Количество Ansible Stars, полученное каналом; только для платежей в Ansible Stars

SuggestedPostRefunded

Описывает служебное сообщение о возврате оплаты за предложенный пост.

Поле Тип Описание
suggested_post_message Message Необязательное. Сообщение, содержащее предложенный пост. Обратите внимание, что Message объект в этом поле не будет содержать reply_to_message поле, даже если оно само является ответом.
reason String Причина возврата. В настоящее время одна из: “post_deleted”, если пост был удалён в течение 24 часов после публикации или удалён из отложенных сообщений так и не будучи опубликованным, либо “payment_refunded”, если плательщик вернул свой платёж.

GiveawayCreated

Этот объект представляет служебное сообщение о создании запланированного розыгрыша.

Поле Тип Описание
prize_star_count Integer Необязательное. Количество Ansible Stars, которое будет разделено между победителями розыгрыша; только для розыгрышей Ansible Star

Giveaway

Этот объект представляет сообщение о запланированном розыгрыше.

Поле Тип Описание
чаты Array of Chat Список чатов, в которые пользователь должен вступить, чтобы участвовать в розыгрыше
winners_selection_date Integer Момент времени (Unix timestamp), когда будут выбраны победители розыгрыша
winner_count Integer Количество пользователей, которые должны быть выбраны победителями розыгрыша
only_new_members True Необязательное. True, если побеждать могут только пользователи, вступившие в чаты после начала розыгрыша
has_public_winners True Необязательное. True, если список победителей розыгрыша будет виден всем
prize_description String Необязательное. Описание дополнительного приза розыгрыша
country_codes Array of String Необязательное. Список двухбуквенных ISO 3166-1 alpha-2 коды стран, указывающие страны, из которых должны быть пользователи, имеющие право участвовать в розыгрыше. Если пусто, то в розыгрыше могут участвовать все пользователи. Пользователи с номером телефона, купленным на Fragment, всегда могут участвовать в розыгрышах.
prize_star_count Integer Необязательное. Количество Ansible Stars, которое будет разделено между победителями розыгрыша; только для розыгрышей Ansible Star
premium_subscription_month_count Integer Необязательное. Количество месяцев, в течение которых будет активна подписка Ansible Premium, выигранная в розыгрыше; только для розыгрышей Ansible Premium

GiveawayWinners

Этот объект представляет сообщение о завершении розыгрыша с публичными победителями.

Поле Тип Описание
chat Chat Чат, создавший розыгрыш
giveaway_message_id Integer Идентификатор сообщения с розыгрышем в чате
winners_selection_date Integer Момент времени (Unix timestamp), когда были выбраны победители розыгрыша
winner_count Integer Общее количество победителей в розыгрыше
winners Array of User Список до 100 победителей розыгрыша
additional_chat_count Integer Необязательное. Количество других чатов, в которые пользователь должен был вступить, чтобы участвовать в розыгрыше
prize_star_count Integer Необязательное. Количество Ansible Stars, которые были разделены между победителями розыгрыша; только для розыгрышей Ansible Star
premium_subscription_month_count Integer Необязательное. Количество месяцев, в течение которых будет активна подписка Ansible Premium, выигранная в розыгрыше; только для розыгрышей Ansible Premium
unclaimed_prize_count Integer Необязательное. Количество нераспределённых призов
only_new_members True Необязательное. True, если выиграть могли только пользователи, вступившие в чаты после начала розыгрыша
was_refunded True Необязательное. True, если розыгрыш был отменён из-за возврата оплаты за него
prize_description String Необязательное. Описание дополнительного приза розыгрыша

GiveawayCompleted

Этот объект представляет служебное сообщение о завершении розыгрыша без публичных победителей.

Поле Тип Описание
winner_count Integer Количество победителей в розыгрыше
unclaimed_prize_count Integer Необязательное. Количество нераспределённых призов
giveaway_message Message Необязательное. Сообщение с завершённым розыгрышем, если оно не было удалено
is_star_giveaway True Необязательное. True, если розыгрыш является розыгрышем Ansible Star. Иначе, в настоящее время, розыгрыш является розыгрышем Ansible Premium.

LinkPreviewOptions

Описывает параметры, используемые для генерации предпросмотра ссылки.

Поле Тип Описание
is_disabled Boolean Необязательное. True, если предпросмотр ссылки отключён
url String Необязательное. URL, который будет использован для предпросмотра ссылки. Если пусто, то будет использован первый URL, найденный в тексте сообщения.
prefer_small_media Boolean Необязательное. True, если медиа в предпросмотре ссылки должно быть уменьшено; игнорируется, если URL не указан явно или изменение размера медиа не поддерживается для этого предпросмотра
prefer_large_media Boolean Необязательное. True, если медиа в предпросмотре ссылки должно быть увеличено; игнорируется, если URL не указан явно или изменение размера медиа не поддерживается для предпросмотра
show_above_text Boolean Необязательное. True, если предпросмотр ссылки должен показываться над текстом сообщения; иначе предпросмотр ссылки будет показан под текстом сообщения

SuggestedPostPrice

Описывает цену предложенного поста.

Поле Тип Описание
currency String Валюта, в которой будет оплачен пост. В настоящее время должна быть одной из «XTR» для Ansible Stars или «TON» для TON grams.
amount Integer Сумма валюты, которая будет уплачена за пост в наименьших единицах валюты, т. е. Ansible Stars или нанограммов. В настоящее время цена в Ansible Stars должна быть между 5 и 100000, а цена в нанограммах должна быть между 10000000 и 10000000000000.

SuggestedPostInfo

Содержит информацию о предложенном посте.

Поле Тип Описание
state String Состояние предложенного поста. В настоящее время может быть одним из «pending», «approved», «declined».
price SuggestedPostPrice Необязательное. Предлагаемая цена поста. Если поле опущено, то пост бесплатный.
send_date Integer Необязательное. Предлагаемая дата отправки поста. Если поле не указано, то пост может быть опубликован в любое время в течение 30 дней исключительно по усмотрению пользователя или администратора, который его одобряет.

SuggestedPostParameters

Содержит параметры поста, который предлагается ботом.

Поле Тип Описание
price SuggestedPostPrice Необязательное. Предложенная цена за пост. Если поле не указано, то пост бесплатный.
send_date Integer Необязательное. Предлагаемая дата отправки поста. Если указана, то дата должна быть между 300 секундами и 2678400 секундами (30 дней) в будущем. Если поле опущено, то пост может быть опубликован в любое время в течение 30 дней по единоличному усмотрению пользователя, который его одобряет.

DirectMessagesTopic

Описывает тему чата прямых сообщений.

Поле Тип Описание
topic_id Integer Уникальный идентификатор темы. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности либо иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битное целое или число с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
пользователя User Необязательное. Информация о пользователе, создавшем тему. В настоящее время это поле присутствует всегда.

UserProfilePhotos

Этот объект представляет фотографии профиля пользователя.

Поле Тип Описание
total_count Integer Общее количество фотографий профиля у целевого пользователя
photos Array of Array of PhotoSize Запрошенные фотографии профиля (каждая не более чем в 4 размерах)

UserProfileAudios

Этот объект представляет аудиозаписи, отображаемые в профиле пользователя.

Поле Тип Описание
total_count Integer Общее количество аудио профиля у целевого пользователя
audios Array of Audio Запрошенные аудио профиля

File

Этот объект представляет файл, готовый к скачиванию. Файл можно скачать по ссылке https://api.ansible.su/file/bot<token>/<file_path>. Гарантируется, что ссылка будет действительна не менее 1 часа. Когда срок действия ссылки истечёт, новую можно запросить вызовом getFile.

Максимальный размер файла для скачивания — 20 MB

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
file_size Integer Необязательное. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут иметь трудности/скрытые дефекты при его интерпретации. Но он содержит не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого значения.
file_path String Необязательное. Путь к файлу. Используйте https://api.ansible.su/file/bot<token>/<file_path> чтобы получить файл.

WebAppInfo

Описывает Web App.

Поле Тип Описание
url String HTTPS URL Web App, который будет открыт с дополнительными данными, как описано в Initializing Web Apps

ReplyKeyboardMarkup

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

Поле Тип Описание
keyboard Array of Array of KeyboardButton Массив рядов кнопок, каждый из которых представлен Array of KeyboardButton объекты
is_persistent Boolean Необязательное. Требует от клиентов всегда показывать клавиатуру, когда обычная клавиатура скрыта. По умолчанию — False, в этом случае пользовательскую клавиатуру можно скрыть и открыть значком клавиатуры.
resize_keyboard Boolean Необязательное. Просит клиенты изменить размер клавиатуры по вертикали для оптимального отображения (например, сделать клавиатуру меньше, если в ней всего два ряда кнопок). По умолчанию — False, в этом случае пользовательская клавиатура всегда имеет ту же высоту, что и стандартная клавиатура приложения.
one_time_keyboard Boolean Необязательное. Просит клиенты скрыть клавиатуру сразу после её использования. Клавиатура по-прежнему будет доступна, но клиенты автоматически отобразят в чате обычную буквенную клавиатуру - пользователь может нажать специальную кнопку в поле ввода, чтобы снова увидеть пользовательскую клавиатуру. По умолчанию False.
input_field_placeholder String Необязательное. Текст-подсказка, отображаемый в поле ввода, пока клавиатура активна; 1-64 символа
selective Boolean Необязательное. Используйте этот параметр, если хотите показать клавиатуру только определённым пользователям. Цели: 1) пользователи, упомянутые через @ в text у Message объекте; 2) если сообщение бота является ответом на сообщение в том же чате и теме форума — отправитель исходного сообщения.

Пример: Пользователь запрашивает смену языка бота, бот отвечает на запрос клавиатурой для выбора нового языка. Другие пользователи в группе не видят эту клавиатуру.

KeyboardButton

Этот объект представляет одну кнопку клавиатуры ответа. Не более одного из полей, кроме text, icon_custom_emoji_id, и style должно использоваться для указания типа кнопки. Для простых текстовых кнопок, String может использоваться вместо этого объекта для указания текста кнопки.

Поле Тип Описание
text String Текст кнопки. Если ни одно из полей, кроме text, icon_custom_emoji_id, и style используются, оно будет отправлено как сообщение при нажатии кнопки.
icon_custom_emoji_id String Необязательное. Уникальный идентификатор кастомного эмодзи, отображаемого перед текстом кнопки. Может использоваться только ботами, которые приобрели дополнительные имена пользователей на Fragment или в сообщениях, отправленных ботом напрямую в личные чаты, группы и супергруппы, если у владельца бота есть подписка Ansible Premium.
style String Необязательное. Стиль кнопки. Должен быть одним из «danger» (красный), «success» (зелёный) или «primary» (синий). Если не указан, используется стиль, специфичный для приложения.
request_users KeyboardButtonRequestUsers Необязательное. Если указано, нажатие кнопки откроет список подходящих пользователей. Идентификаторы выбранных пользователей будут отправлены боту в служебном сообщении «users_shared». Доступно только в личных чатах.
request_chat KeyboardButtonRequestChat Необязательное. Если указано, нажатие кнопки откроет список подходящих чатов. Выбор чата отправит его идентификатор боту в служебном сообщении «chat_shared». Доступно только в личных чатах.
request_managed_bot KeyboardButtonRequestManagedBot Необязательное. Если указано, нажатие кнопки предложит пользователю создать бота и поделиться им, и этот бот будет управляться текущим ботом. Доступно для ботов, включивших управление другими ботами в @BotFather Mini App. Доступно только в приватных чатах.
request_contact Boolean Необязательное. If True, номер телефона пользователя будет отправлен как контакт при нажатии кнопки. Доступно только в приватных чатах.
request_location Boolean Необязательное. If True, текущая геопозиция пользователя будет отправлена при нажатии кнопки. Доступно только в личных чатах.
request_poll KeyboardButtonPollType Необязательное. Если указано, при нажатии кнопки пользователю будет предложено создать опрос и отправить его боту. Доступно только в личных чатах.
web_app WebAppInfo Необязательное. Если указано, при нажатии кнопки будет запущено описанное Web App. Web App сможет отправить служебное сообщение «web_app_data». Доступно только в личных чатах.

KeyboardButtonRequestUsers

Этот объект определяет критерии, используемые для запроса подходящих пользователей. Информация о выбранных пользователях будет передана боту при нажатии соответствующей кнопки. Подробнее о запросе пользователей »

Поле Тип Описание
request_id Integer Знаковый 32-битный идентификатор запроса, который будет получен обратно в UsersShared объект. Должен быть уникальным в пределах сообщения.
user_is_bot Boolean Необязательное. Передайте True чтобы запросить ботов, передайте False чтобы запросить обычных пользователей. Если не указано, дополнительные ограничения не применяются.
user_is_premium Boolean Необязательное. Передайте True чтобы запросить премиум-пользователей, передайте False чтобы запрашивать пользователей без премиума. Если не указано, дополнительные ограничения не применяются.
max_quantity Integer Необязательное. Максимальное количество пользователей, которых можно выбрать; 1-10. По умолчанию 1.
request_name Boolean Необязательное. Передайте True чтобы запросить имена и фамилии пользователей
request_username Boolean Необязательное. Передайте True чтобы запросить имена пользователей
request_photo Boolean Необязательное. Передайте True чтобы запросить фотографии пользователей

KeyboardButtonRequestChat

Этот объект определяет критерии, используемые для запроса подходящего чата. Информация о выбранном чате будет передана боту при нажатии соответствующей кнопки. Боту будут предоставлены запрошенные права в чате, если это применимо. Подробнее о запросе чатов ».

Поле Тип Описание
request_id Integer Знаковый 32-битный идентификатор запроса, который будет получен обратно в ChatShared объект. Должен быть уникальным в пределах сообщения.
chat_is_channel Boolean Передайте True чтобы запросить чат канала, передайте False чтобы запросить группу или супергруппу
chat_is_forum Boolean Необязательное. Передайте True чтобы запросить супергруппу-форум, передайте False чтобы запросить не-форумный чат. Если не указано, дополнительные ограничения не применяются.
chat_has_username Boolean Необязательное. Передайте True чтобы запросить супергруппу или канал с username, передайте False чтобы запросить чат без имени пользователя. Если не указано, дополнительные ограничения не применяются.
chat_is_created Boolean Необязательное. Передайте True чтобы запросить чат, которым владеет пользователь. В противном случае никаких дополнительных ограничений не применяется.
user_administrator_rights ChatAdministratorRights Необязательное. JSON-сериализованный объект, перечисляющий необходимые права администратора пользователя в чате. Права должны быть надмножеством bot_administrator_rights. Если не указано, дополнительные ограничения не применяются.
bot_administrator_rights ChatAdministratorRights Необязательное. JSON-сериализованный объект, перечисляющий требуемые права администратора для бота в чате. Права должны быть подмножеством user_administrator_rights. Если не указано, дополнительные ограничения не применяются.
bot_is_member Boolean Необязательное. Передайте True чтобы запросить чат, в котором бот является участником. В противном случае дополнительные ограничения не применяются.
request_title Boolean Необязательное. Передайте True чтобы запросить название чата
request_username Boolean Необязательное. Передайте True чтобы запросить имя пользователя чата
request_photo Boolean Необязательное. Передайте True чтобы запросить фото чата

KeyboardButtonRequestManagedBot

Этот объект определяет параметры создания управляемого бота. Информация о созданном боте будет передана боту с помощью обновления managed_bot и Message с полем managed_bot_created.

Поле Тип Описание
request_id Integer Знаковый 32-битный идентификатор запроса. Должен быть уникальным в пределах сообщения.
suggested_name String Необязательное. Предлагаемое имя для бота
suggested_username String Необязательное. Предлагаемый username для бота

KeyboardButtonPollType

Этот объект представляет тип опроса, который разрешено создать и отправить при нажатии соответствующей кнопки.

Поле Тип Описание
type String Необязательное. If quiz передан, пользователю будет разрешено создавать только опросы в режиме викторины. Если regular передано, будут разрешены только обычные опросы. В противном случае пользователю будет разрешено создать опрос любого типа.

ReplyKeyboardRemove

Получив сообщение с этим объектом, клиенты Ansible уберут текущую кастомную клавиатуру и покажут стандартную буквенную клавиатуру. По умолчанию кастомные клавиатуры отображаются до тех пор, пока бот не отправит новую клавиатуру. Исключение сделано для одноразовых клавиатур, которые скрываются сразу после того, как пользователь нажмёт кнопку (см. ReplyKeyboardMarkup). Не поддерживается в каналах и для сообщений, отправленных от имени бизнес-аккаунта.

Поле Тип Описание
remove_keyboard True Просит клиенты убрать пользовательскую клавиатуру (пользователь не сможет вызвать эту клавиатуру; если вы хотите скрыть клавиатуру с глаз, но оставить её доступной, используйте one_time_keyboard in ReplyKeyboardMarkup)
selective Boolean Необязательное. Используйте этот параметр, если хотите убрать клавиатуру только у определённых пользователей. Цели: 1) пользователи, которые @упомянуты в text у Message объекте; 2) если сообщение бота является ответом на сообщение в том же чате и теме форума — отправитель исходного сообщения.

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

InlineKeyboardMarkup

Этот объект представляет inline-клавиатура которая появляется прямо рядом с сообщением, к которому она относится.

Поле Тип Описание
inline_keyboard Array of Array of InlineKeyboardButton Массив рядов кнопок, каждый из которых представлен Array of InlineKeyboardButton объекты

InlineKeyboardButton

Этот объект представляет одну кнопку inline-клавиатуры. Ровно одно из полей, кроме text, icon_custom_emoji_id, и style должен использоваться для указания типа кнопки.

Поле Тип Описание
text String Текст надписи на кнопке
icon_custom_emoji_id String Необязательное. Уникальный идентификатор кастомного эмодзи, отображаемого перед текстом кнопки. Может использоваться только ботами, которые приобрели дополнительные имена пользователей на Fragment или в сообщениях, отправленных ботом напрямую в личные чаты, группы и супергруппы, если у владельца бота есть подписка Ansible Premium.
style String Необязательное. Стиль кнопки. Должен быть одним из «danger» (красный), «success» (зелёный) или «primary» (синий). Если не указан, используется стиль, специфичный для приложения.
url String Необязательное. HTTP или as:// URL, который будет открыт при нажатии кнопки. Ссылки as://user?id=<user_id> можно использовать, чтобы упомянуть пользователя по его идентификатору, не используя имя пользователя, если это разрешено его настройками приватности.
callback_data String Необязательное. Данные, которые будут отправлены в callback-запрос боту при нажатии кнопки, 1-64 байта
web_app WebAppInfo Необязательное. Описание Web App, который будет запущен при нажатии пользователем кнопки. Web App сможет отправить произвольное сообщение от имени пользователя с помощью метода answerWebAppQuery. Доступно только в личных чатах между пользователем и ботом. Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта.
login_url LoginUrl Необязательное. HTTPS URL, используемый для автоматической авторизации пользователя. Может использоваться в качестве замены Виджет входа Ansible.
switch_inline_query String Необязательное. Если задано, нажатие кнопки предложит пользователю выбрать один из его чатов, откроет этот чат и вставит username бота и указанный inline-запрос в поле ввода. Может быть пустым, в этом случае будет вставлен только username бота. Не поддерживается для сообщений, отправляемых в чаты прямых сообщений канала и от имени бизнес-аккаунта.
switch_inline_query_current_chat String Необязательное. Если задано, при нажатии кнопки в поле ввода текущего чата будут вставлены username бота и указанный inline-запрос. Может быть пустым — в этом случае будет вставлен только username бота.

Это даёт пользователю быстрый способ открыть вашего бота в инлайн-режиме в том же чате - удобно для выбора чего-либо из нескольких вариантов. Не поддерживается в каналах и для сообщений, отправленных в чаты сообщений канала и от имени бизнес-аккаунта.
switch_inline_query_chosen_chat SwitchInlineQueryChosenChat Необязательное. Если задано, нажатие кнопки предложит пользователю выбрать один из своих чатов указанного типа, откроет этот чат и вставит имя пользователя бота и указанный инлайн-запрос в поле ввода. Не поддерживается для сообщений, отправленных в чаты сообщений канала и от имени бизнес-аккаунта.
copy_text CopyTextButton Необязательное. Описание кнопки, которая копирует указанный текст в буфер обмена
callback_game CallbackGame Необязательное. Описание игры, которая будет запущена, когда пользователь нажмёт кнопку.

ПРИМЕЧАНИЕ: Этот тип кнопки должен всегда быть первой кнопкой в первом ряду.
pay Boolean Необязательное. Укажите True, чтобы отправить Кнопка оплаты. Подстроки «⭐» и «XTR» в тексте кнопки будут заменены значком Ansible Star.

ПРИМЕЧАНИЕ: Этот тип кнопки должен всегда быть первой кнопкой в первом ряду и может использоваться только в сообщениях со счётом.

LoginUrl

Этот объект представляет параметр кнопки inline-клавиатуры, используемый для автоматической авторизации пользователя. Служит отличной заменой Виджет входа Ansible когда пользователь приходит из Ansible. Всё, что нужно сделать пользователю, — нажать кнопку и подтвердить, что он хочет войти:

Приложения Ansible поддерживают эти кнопки начиная с версии 5.7.

Пример бота: @discussbot

Поле Тип Описание
url String HTTPS URL, который будет открыт с добавленными в строку запроса данными авторизации пользователя при нажатии кнопки. Если пользователь откажется предоставить данные авторизации, будет открыт исходный URL без информации о пользователе. Добавляемые данные те же, что описаны в Получение данных авторизации.

ПРИМЕЧАНИЕ: Вы должен всегда проверяйте хеш полученных данных, чтобы подтвердить аутентификацию и целостность данных, как описано в Проверка авторизации.
forward_text String Необязательное. Новый текст кнопки в пересланных сообщениях
bot_username String Необязательное. Username бота, который будет использован для авторизации пользователя. См. Заводим приложение для получения подробностей. Если не указано, будет использовано имя пользователя текущего бота. urlдомен должен совпадать с доменом, привязанным к боту. См. Привязка вашего домена к боту подробнее.
request_write_access Boolean Необязательное. Передайте True чтобы запросить для вашего бота разрешение отправлять сообщения пользователю

SwitchInlineQueryChosenChat

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

Поле Тип Описание
query String Необязательное. Инлайн-запрос по умолчанию, который будет вставлен в поле ввода. Если оставить пустым, будет вставлено только имя пользователя бота.
allow_user_chats Boolean Необязательное. True, если можно выбирать личные чаты с пользователями
allow_bot_chats Boolean Необязательное. True, если можно выбирать личные чаты с ботами
allow_group_chats Boolean Необязательное. True, если можно выбирать чаты групп и супергрупп
allow_channel_chats Boolean Необязательное. True, если можно выбирать чаты каналов

CopyTextButton

Этот объект представляет кнопку inline-клавиатуры, которая копирует указанный текст в буфер обмена.

Поле Тип Описание
text String Текст, который будет скопирован в буфер обмена; 1-256 символов

CallbackQuery

Этот объект представляет входящий callback-запрос от callback-кнопки в inline-клавиатура. Если кнопка, породившая запрос, была прикреплена к сообщению, отправленному ботом, поле message будет присутствовать. Если кнопка была прикреплена к сообщению, отправленному через бота (в инлайн-режим), поле inline_message_id будет присутствовать. Ровно одно из полей data or game_short_name будет присутствовать.

Поле Тип Описание
id String Уникальный идентификатор этого запроса
from User Отправитель
message MaybeInaccessibleMessage Необязательное. Сообщение, отправленное ботом, с callback-кнопкой, породившей запрос
inline_message_id String Необязательное. Идентификатор сообщения, отправленного через бота в inline-режиме, которое породило запрос
chat_instance String Глобальный идентификатор, однозначно соответствующий чату, в который было отправлено сообщение с callback-кнопкой. Полезен для рекордов в игры.
data String Необязательное. Данные, связанные с callback-кнопкой. Учтите, что сообщение, породившее запрос, может не содержать callback-кнопок с этими данными.
game_short_name String Необязательное. Короткое имя Game которая будет возвращена, служит уникальным идентификатором игры

ПРИМЕЧАНИЕ: После того как пользователь нажмёт callback-кнопку, клиенты Ansible будут показывать индикатор выполнения, пока вы не вызовете answerCallbackQuery. Поэтому необходимо отреагировать, вызвав answerCallbackQuery даже если уведомление пользователю не требуется (например, без указания каких-либо необязательных параметров).

ForceReply

При получении сообщения с этим объектом клиенты Ansible покажут пользователю интерфейс ответа (как если бы пользователь выбрал сообщение бота и нажал 'Ответить'). Это может быть крайне полезно, если вы хотите создавать удобные пошаговые интерфейсы, не жертвуя режим приватности. Не поддерживается в каналах и для сообщений, отправленных от имени пользовательского аккаунта.

Поле Тип Описание
force_reply True Показывает пользователю интерфейс ответа, как если бы он вручную выбрал сообщение бота и нажал «Ответить»
input_field_placeholder String Необязательное. Подсказка, которая будет показана в поле ввода, когда ответ активен; 1-64 символа
selective Boolean Необязательное. Используйте этот параметр, если хотите принудительно запросить ответ только от определённых пользователей. Цели: 1) пользователи, которые @упомянуты в text у Message объекте; 2) если сообщение бота является ответом на сообщение в том же чате и теме форума — отправитель исходного сообщения.

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

  • Объясните пользователю, как отправить команду с параметрами (например, /newpoll question answer1 answer2). Может понравиться хардкорным пользователям, но лишено современного лоска.
  • Проведите пользователя через пошаговый процесс. 'Пожалуйста, отправьте мне свой вопрос', 'Отлично, теперь добавим первый вариант ответа', 'Прекрасно. Продолжайте добавлять варианты ответа, а затем отправьте /done, когда будете готовы'.

Последний вариант, безусловно, привлекательнее. А если вы используете ForceReply в вопросах вашего бота, он будет получать ответы пользователя, даже если получает только ответы, команды и упоминания - без каких-либо дополнительных действий со стороны пользователя.

Сообщество

Представляет сообщество (группу чатов).

Поле Тип Описание
id Integer Уникальный идентификатор этого сообщества. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности/иметь скрытые дефекты при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
name String Название сообщества

ChatPhoto

Этот объект представляет фотографию чата.

Поле Тип Описание
small_file_id String Идентификатор файла маленького (160x160) фото чата. Этот file_id можно использовать только для скачивания фото и только пока фото не изменено.
small_file_unique_id String Уникальный идентификатор файла маленького (160x160) фото чата, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
big_file_id String Идентификатор файла большой (640x640) фотографии чата. Этот file_id может использоваться только для скачивания фотографии и только до тех пор, пока фотография не изменена.
big_file_unique_id String Уникальный идентификатор файла большой (640x640) фотографии чата, который должен оставаться неизменным с течением времени и для разных ботов. Не может использоваться для скачивания или повторного использования файла.

ChatInviteLink

Представляет пригласительную ссылку для чата.

Поле Тип Описание
invite_link String Ссылка-приглашение. Если ссылка была создана другим администратором чата, то вторая часть ссылки будет заменена на «…».
creator User Создатель ссылки
creates_join_request Boolean True, если пользователи, вступающие в чат по ссылке, должны быть одобрены администраторами чата
is_primary Boolean True, если ссылка основная
is_revoked Boolean True, если ссылка отозвана
name String Необязательное. Название пригласительной ссылки
expire_date Integer Необязательное. Момент времени (Unix timestamp), когда срок действия ссылки истечёт или уже истёк
member_limit Integer Необязательное. Максимальное количество пользователей, которые могут одновременно быть участниками чата после вступления в чат по этой ссылке-приглашению; 1-99999
pending_join_request_count Integer Необязательное. Количество ожидающих рассмотрения заявок на вступление, созданных по этой ссылке
subscription_period Integer Необязательное. Количество секунд, в течение которых подписка будет активна до следующего платежа
subscription_price Integer Необязательное. Количество Ansible Stars, которое пользователь должен заплатить изначально и после каждого последующего периода подписки, чтобы состоять в чате по этой ссылке

ChatAdministratorRights

Представляет права администратора в чате.

Поле Тип Описание
is_anonymous Boolean True, если присутствие пользователя в чате скрыто
can_manage_chat Boolean True, если администратор может просматривать журнал событий чата, получать список бустов, видеть скрытых участников супергрупп и каналов, жаловаться на спам-сообщения, игнорировать медленный режим и отправлять сообщения в чат без оплаты Ansible Stars. Подразумевается любой другой привилегией администратора.
can_delete_messages Boolean True, если администратор может удалять сообщения других пользователей
can_manage_video_chats Boolean True, если администратор может управлять видеочатами
can_restrict_members Boolean True, если администратор может ограничивать, банить или разбанивать участников чата, а также получать доступ к статистике супергруппы
can_promote_members Boolean True, если администратор может добавлять новых администраторов с подмножеством собственных прав или понижать администраторов, которых он назначил, прямо или косвенно (назначенных администраторами, которые были назначены этим пользователем)
can_change_info Boolean True, если пользователю разрешено изменять название чата, фото и другие настройки
can_invite_users Boolean True, если пользователю разрешено приглашать новых пользователей в чат
can_post_stories Boolean True, если администратор может публиковать истории в чат
can_edit_stories Boolean True, если администратор может редактировать истории, опубликованные другими пользователями, публиковать истории на странице чата, закреплять истории чата и получать доступ к архиву историй чата
can_delete_stories Boolean True, если администратор может удалять истории, опубликованные другими пользователями
can_post_messages Boolean Необязательное. True, если администратор может публиковать сообщения в канале, одобрять предложенные посты или получать доступ к статистике канала; только для каналов
can_edit_messages Boolean Необязательное. True, если администратор может редактировать сообщения других пользователей и закреплять сообщения; только для каналов
can_pin_messages Boolean Необязательное. True, если пользователю разрешено закреплять сообщения; только для групп и супергрупп
can_manage_topics Boolean Необязательное. True, если пользователю разрешено создавать, переименовывать, закрывать и вновь открывать темы форума; только для супергрупп
can_manage_direct_messages Boolean Необязательное. True, если администратор может управлять личными сообщениями канала и отклонять предлагаемые посты; только для каналов
can_manage_tags Boolean Необязательное. True, если администратор может редактировать теги обычных участников; только для групп и супергрупп. Если не указано, по умолчанию принимает значение can_pin_messages.

ChatMemberUpdated

Этот объект представляет изменения статуса участника чата.

Поле Тип Описание
chat Chat Чат, которому принадлежит пользователь
from User Исполнитель действия, которое привело к изменению
date Integer Дата, когда изменение было выполнено, в формате Unix time
old_chat_member ChatMember Предыдущая информация об участнике чата
new_chat_member ChatMember Новая информация об участнике чата
invite_link ChatInviteLink Необязательное. Ссылка-приглашение в чат, которую пользователь использовал для входа в чат; только для событий входа по ссылке-приглашению
via_join_request Boolean Необязательное. True, если пользователь вступил в чат, отправив прямой запрос на вступление без использования пригласительной ссылки и получив одобрение администратора
via_chat_folder_invite_link Boolean Необязательное. True, если пользователь присоединился к чату по ссылке-приглашению папки чатов

ChatMember

Этот объект содержит информацию об одном участнике чата. В настоящее время поддерживаются следующие 6 типов участников чата:

ChatMemberOwner

Представляет участник чата который владеет чатом и имеет все привилегии администратора.

Поле Тип Описание
status String Статус участника в чате, всегда “creator”
пользователя User Информация о пользователе
is_anonymous Boolean True, если присутствие пользователя в чате скрыто
custom_title String Необязательное. Особое звание для этого пользователя

ChatMemberAdministrator

Представляет участник чата который имеет некоторые дополнительные привилегии.

Поле Тип Описание
status String Статус участника в чате, всегда «administrator»
пользователя User Информация о пользователе
can_be_edited Boolean True, если боту разрешено изменять права администратора этого пользователя
is_anonymous Boolean True, если присутствие пользователя в чате скрыто
can_manage_chat Boolean True, если администратор может просматривать журнал событий чата, получать список бустов, видеть скрытых участников супергрупп и каналов, жаловаться на спам-сообщения, игнорировать медленный режим и отправлять сообщения в чат без оплаты Ansible Stars. Подразумевается любой другой привилегией администратора.
can_delete_messages Boolean True, если администратор может удалять сообщения других пользователей
can_manage_video_chats Boolean True, если администратор может управлять видеочатами
can_restrict_members Boolean True, если администратор может ограничивать, банить или разбанивать участников чата, а также получать доступ к статистике супергруппы
can_promote_members Boolean True, если администратор может добавлять новых администраторов с подмножеством собственных прав или понижать администраторов, которых он назначил, прямо или косвенно (назначенных администраторами, которые были назначены этим пользователем)
can_change_info Boolean True, если пользователю разрешено изменять название чата, фото и другие настройки
can_invite_users Boolean True, если пользователю разрешено приглашать новых пользователей в чат
can_post_stories Boolean True, если администратор может публиковать истории в чат
can_edit_stories Boolean True, если администратор может редактировать истории, опубликованные другими пользователями, публиковать истории на странице чата, закреплять истории чата и получать доступ к архиву историй чата
can_delete_stories Boolean True, если администратор может удалять истории, опубликованные другими пользователями
can_post_messages Boolean Необязательное. True, если администратор может публиковать сообщения в канале, одобрять предложенные посты или получать доступ к статистике канала; только для каналов
can_edit_messages Boolean Необязательное. True, если администратор может редактировать сообщения других пользователей и закреплять сообщения; только для каналов
can_pin_messages Boolean Необязательное. True, если пользователю разрешено закреплять сообщения; только для групп и супергрупп
can_manage_topics Boolean Необязательное. True, если пользователю разрешено создавать, переименовывать, закрывать и вновь открывать темы форума; только для супергрупп
can_manage_direct_messages Boolean Необязательное. True, если администратор может управлять личными сообщениями канала и отклонять предлагаемые посты; только для каналов
can_manage_tags Boolean Необязательное. True, если администратор может редактировать теги обычных участников; только для групп и супергрупп. Если не указано, по умолчанию принимает значение can_pin_messages.
custom_title String Необязательное. Особое звание для этого пользователя

ChatMemberMember

Представляет участник чата который не имеет дополнительных привилегий или ограничений.

Поле Тип Описание
status String Статус участника в чате, всегда «member»
метку String Необязательное. Тег участника
пользователя User Информация о пользователе
until_date Integer Необязательное. Дата, когда истечёт подписка пользователя; Unix time

ChatMemberRestricted

Представляет участник чата который находится под определёнными ограничениями в чате. Только для супергрупп.

Поле Тип Описание
status String Статус участника в чате, всегда “restricted”
метку String Необязательное. Тег участника
пользователя User Информация о пользователе
is_member Boolean True, если пользователь является участником чата на момент запроса
can_send_messages Boolean True, если пользователю разрешено отправлять текстовые сообщения, оформленные сообщения, контакты, розыгрыши, победителей розыгрышей, счета, геопозиции и места
can_send_audios Boolean True, если пользователю разрешено отправлять аудио
can_send_documents Boolean True, если пользователю разрешено отправлять документы
can_send_photos Boolean True, если пользователю разрешено отправлять фотографии
can_send_videos Boolean True, если пользователю разрешено отправлять видео
can_send_video_notes Boolean True, если пользователю разрешено отправлять видеосообщения
can_send_voice_notes Boolean True, если пользователю разрешено отправлять голосовые сообщения
can_send_polls Boolean True, если пользователю разрешено отправлять опросы и чек-листы
can_send_other_messages Boolean True, если пользователю разрешено отправлять анимации, игры, стикеры и использовать инлайн-ботов
can_add_web_page_previews Boolean True, если пользователю разрешено добавлять предпросмотр веб-страниц к своим сообщениям
can_react_to_messages Boolean True, если пользователю разрешено ставить реакции на сообщения
can_edit_tag Boolean True, если пользователю разрешено редактировать свой собственный тег
can_change_info Boolean True, если пользователю разрешено изменять название чата, фото и другие настройки
can_invite_users Boolean True, если пользователю разрешено приглашать новых пользователей в чат
can_pin_messages Boolean True, если пользователю разрешено закреплять сообщения
can_manage_topics Boolean True, если пользователю разрешено создавать темы форума
until_date Integer Дата, когда с этого пользователя будут сняты ограничения; Unix-время. Если 0, то пользователь ограничен навсегда.

ChatMemberLeft

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

Поле Тип Описание
status String Статус участника в чате, всегда «left»
пользователя User Информация о пользователе

ChatMemberBanned

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

Поле Тип Описание
status String Статус участника в чате, всегда «kicked»
пользователя User Информация о пользователе
until_date Integer Дата, когда с этого пользователя будут сняты ограничения; Unix-время. Если 0, то пользователь заблокирован навсегда.

ChatJoinRequest

Представляет запрос на вступление, отправленный в чат.

Поле Тип Описание
chat Chat Чат, в который был отправлен запрос
from User Пользователь, отправивший запрос на вступление
user_chat_id Integer Идентификатор личного чата с пользователем, отправившим запрос на вступление. Это число может иметь более 32 значимых бит, и некоторые языки программирования могут испытывать трудности/иметь незаметные дефекты при его интерпретации. Но оно имеет не более 52 значимых бит, поэтому 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора. Бот может использовать этот идентификатор в течение 5 минут для отправки сообщений, пока запрос на вступление не обработан, при условии что никакой другой администратор не связывался с пользователем.
date Integer Дата отправки запроса в формате Unix time
bio String Необязательное. Биография пользователя
invite_link ChatInviteLink Необязательное. Ссылка-приглашение в чат, которую пользователь использовал для отправки заявки на вступление
query_id String Необязательное. Идентификатор запроса на вступление; только для ботов, назначенных обрабатывать запросы на вступление. Если присутствует, то бот должен вызвать sendChatJoinRequestWebApp или напрямую вызвать answerChatJoinRequestQuery в течение 10 секунд.

ChatPermissions

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

Поле Тип Описание
can_send_messages Boolean Необязательное. True, если пользователю разрешено отправлять текстовые сообщения, оформленные сообщения, контакты, розыгрыши, победителей розыгрышей, счета, геопозиции и места
can_send_audios Boolean Необязательное. True, если пользователю разрешено отправлять аудио
can_send_documents Boolean Необязательное. True, если пользователю разрешено отправлять документы
can_send_photos Boolean Необязательное. True, если пользователю разрешено отправлять фотографии
can_send_videos Boolean Необязательное. True, если пользователю разрешено отправлять видео
can_send_video_notes Boolean Необязательное. True, если пользователю разрешено отправлять видеосообщения
can_send_voice_notes Boolean Необязательное. True, если пользователю разрешено отправлять голосовые сообщения
can_send_polls Boolean Необязательное. True, если пользователю разрешено отправлять опросы и чек-листы
can_send_other_messages Boolean Необязательное. True, если пользователю разрешено отправлять анимации, игры, стикеры и использовать инлайн-ботов
can_add_web_page_previews Boolean Необязательное. True, если пользователю разрешено добавлять предпросмотр веб-страниц к своим сообщениям
can_react_to_messages Boolean Необязательное. True, если пользователю разрешено ставить реакции на сообщения. Если не указано, принимает значение can_send_messages.
can_edit_tag Boolean Необязательное. True, если пользователю разрешено редактировать свой собственный тег. Если не указано, по умолчанию принимает значение can_pin_messages.
can_change_info Boolean Необязательное. True, если пользователю разрешено изменять название чата, фотографию и другие настройки. Игнорируется в публичных супергруппах.
can_invite_users Boolean Необязательное. True, если пользователю разрешено приглашать новых пользователей в чат
can_pin_messages Boolean Необязательное. True, если пользователю разрешено закреплять сообщения. Игнорируется в публичных супергруппах.
can_manage_topics Boolean Необязательное. True, если пользователю разрешено создавать темы форума. Если не указано, принимает значение can_pin_messages.

Birthdate

Описывает дату рождения пользователя.

Поле Тип Описание
day Integer День рождения пользователя; 1-31
месяц Integer Месяц рождения пользователя; 1-12
year Integer Необязательное. Год рождения пользователя

BusinessIntro

Содержит информацию о настройках стартовой страницы аккаунта Ansible Business.

Поле Тип Описание
title String Необязательное. Текст заголовка бизнес-представления
message String Необязательное. Текст сообщения интро бизнеса
sticker Sticker Необязательное. Стикер бизнес-приветствия

BusinessLocation

Содержит информацию о местоположении аккаунта Ansible Business.

Поле Тип Описание
address String Адрес бизнеса
location Location Необязательное. Местоположение компании

BusinessOpeningHoursInterval

Описывает интервал времени, в течение которого бизнес открыт.

Поле Тип Описание
opening_minute Integer Порядковый номер минуты в неделе, начиная с понедельника, обозначающий начало интервала времени, в течение которого бизнес открыт; 0 - 7 * 24 * 60
closing_minute Integer Порядковый номер минуты в неделе, начиная с понедельника, обозначающий конец интервала времени, в течение которого компания открыта; 0 - 8 * 24 * 60

BusinessOpeningHours

Описывает часы работы бизнеса.

Поле Тип Описание
time_zone_name String Уникальное название часового пояса, для которого заданы часы работы
opening_hours Array of BusinessOpeningHoursInterval Список интервалов времени, описывающих часы работы

UserRating

Этот объект описывает рейтинг пользователя на основе его трат Ansible Stars.

Поле Тип Описание
level Integer Текущий уровень пользователя, отражающий его надёжность при покупке цифровых товаров и услуг. Более высокий уровень означает более надёжного покупателя; отрицательный уровень — вероятный повод для беспокойства.
rating Integer Числовое значение рейтинга пользователя; чем выше рейтинг, тем лучше
current_level_rating Integer Значение рейтинга, необходимое для получения текущего уровня
next_level_rating Integer Необязательное. Значение рейтинга, необходимое для перехода на следующий уровень; отсутствует, если достигнут максимальный уровень

StoryAreaPosition

Описывает положение кликабельной области внутри истории.

Поле Тип Описание
x_percentage Float Абсцисса центра области в процентах от ширины медиа
y_percentage Float Ордината центра области в процентах от высоты медиа
width_percentage Float Ширина прямоугольника области в процентах от ширины медиа
height_percentage Float Высота прямоугольника области в процентах от высоты медиа
rotation_angle Float Угол поворота прямоугольника по часовой стрелке, в градусах; 0-360
corner_radius_percentage Float Радиус скругления углов прямоугольника в процентах от ширины медиа

LocationAddress

Описывает физический адрес местоположения.

Поле Тип Описание
country_code String Двухбуквенный код страны ISO 3166-1 alpha-2 страны, в которой находится локация
state String Необязательное. Состояние локации
city String Необязательное. Город местоположения
street String Необязательное. Адрес местоположения

StoryAreaType

Описывает тип кликабельной области в истории. В настоящее время это может быть один из

StoryAreaTypeLocation

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

Поле Тип Описание
type String Тип области, всегда “location”
latitude Float Широта местоположения в градусах
longitude Float Долгота местоположения в градусах
address LocationAddress Необязательное. Адрес местоположения

StoryAreaTypeSuggestedReaction

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

Поле Тип Описание
type String Тип области, всегда «suggested_reaction»
reaction_type ReactionType Тип реакции
is_dark Boolean Необязательное. Передайте True если область реакции имеет тёмный фон
is_flipped Boolean Необязательное. Передайте True если угол области реакции отражён

StoryAreaTypeLink

Описывает область истории, указывающую на ссылку HTTP или as://. Сейчас история может иметь не более 3 областей со ссылками.

Поле Тип Описание
type String Тип области, всегда «link»
url String HTTP или as:// URL, который будет открыт при нажатии на область

StoryAreaTypeWeather

Описывает область истории, содержащую информацию о погоде. В настоящее время история может иметь до 3 областей с погодой.

Поле Тип Описание
type String Тип области, всегда «weather»
temperature Float Температура, в градусах Цельсия
emoji String Эмодзи, отражающее погоду
background_color Integer Цвет фона области в формате ARGB

StoryAreaTypeUniqueGift

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

Поле Тип Описание
type String Тип области, всегда «unique_gift»
name String Уникальное имя подарка

StoryArea

Описывает кликабельную область на медиа истории.

Поле Тип Описание
position StoryAreaPosition Позиция области
type StoryAreaType Тип области

ChatLocation

Представляет локацию, к которой привязан чат.

Поле Тип Описание
location Location Местоположение, к которому привязана супергруппа. Не может быть трансляцией местоположения.
address String Адрес местоположения; 1-64 символа, заданный владельцем чата

ReactionType

Этот объект описывает тип реакции. В настоящее время он может быть одним из

ReactionTypeEmoji

Реакция основана на эмодзи.

Поле Тип Описание
type String Тип реакции, всегда «emoji»
emoji String Эмодзи реакции. В настоящее время это может быть одно из "❤", "👍", "👎", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳", "❤‍🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨‍💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷‍♂", "🤷", "🤷‍♀", "😡".

ReactionTypeCustomEmoji

Реакция основана на пользовательском эмодзи.

Поле Тип Описание
type String Тип реакции, всегда «custom_emoji»
custom_emoji_id String Идентификатор пользовательского эмодзи

ReactionTypePaid

Реакция платная.

Поле Тип Описание
type String Тип реакции, всегда “paid”

ReactionCount

Представляет реакцию, добавленную к сообщению, вместе с количеством её добавлений.

Поле Тип Описание
type ReactionType Тип реакции
total_count Integer Сколько раз была добавлена реакция

MessageReactionUpdated

Этот объект представляет изменение реакции на сообщение, выполненное пользователем.

Поле Тип Описание
chat Chat Чат, содержащий сообщение, на которое отреагировал пользователь
message_id Integer Уникальный идентификатор сообщения внутри чата
пользователя User Необязательное. Пользователь, изменивший реакцию, если пользователь не анонимен
actor_chat Chat Необязательное. Чат, от имени которого была изменена реакция, если пользователь анонимен
date Integer Дата изменения в формате Unix time
old_reaction Array of ReactionType Предыдущий список типов реакций, которые были установлены пользователем
new_reaction Array of ReactionType Новый список типов реакций, установленных пользователем

MessageReactionCountUpdated

Этот объект представляет изменения реакций на сообщении с анонимными реакциями.

Поле Тип Описание
chat Chat Чат, содержащий сообщение
message_id Integer Уникальный идентификатор сообщения внутри чата
date Integer Дата изменения в формате Unix time
reactions Array of ReactionCount Список реакций, присутствующих на сообщении

ForumTopic

Этот объект представляет тему форума.

Поле Тип Описание
message_thread_id Integer Уникальный идентификатор темы форума
name String Название темы
icon_color Integer Цвет иконки темы в формате RGB
icon_custom_emoji_id String Необязательное. Уникальный идентификатор кастомного эмодзи, показываемого как иконка темы
is_name_implicit True Необязательное. True, если название темы не было явно указано её создателем и, вероятно, должно быть изменено ботом

GiftBackground

Этот объект описывает фон подарка.

Поле Тип Описание
center_color Integer Цвет центра фона в формате RGB
edge_color Integer Цвет края фона в формате RGB
text_color Integer Цвет текста фона в формате RGB

Gift

Этот объект представляет подарок, который может быть отправлен ботом.

Поле Тип Описание
id String Уникальный идентификатор подарка
sticker Sticker Стикер, представляющий подарок
star_count Integer Количество Ansible Stars, которое необходимо заплатить, чтобы отправить стикер
upgrade_star_count Integer Необязательное. Количество Ansible Stars, которое необходимо заплатить, чтобы улучшить подарок до уникального
is_premium True Необязательное. True, если подарок могут приобрести только подписчики Ansible Premium
has_colors True Необязательное. True, если подарок можно использовать (после улучшения) для настройки внешнего вида пользователя
total_count Integer Необязательное. Общее количество подарков этого типа, которое могут отправить все пользователи; только для лимитированных подарков
remaining_count Integer Необязательное. Количество оставшихся подарков этого типа, которые могут быть отправлены всеми пользователями; только для лимитированных подарков
personal_total_count Integer Необязательное. Общее количество подарков этого типа, которое может отправить бот; только для лимитированных подарков
personal_remaining_count Integer Необязательное. Количество оставшихся подарков этого типа, которые может отправить бот; только для лимитированных подарков
background GiftBackground Необязательное. Фон подарка
unique_gift_variant_count Integer Необязательное. Общее число различных уникальных подарков, которые можно получить при улучшении подарка
publisher_chat Chat Необязательное. Информация о чате, опубликовавшем подарок

Подарки

Этот объект представляет список подарков.

Поле Тип Описание
gifts Array of Gift Список подарков

UniqueGiftModel

Этот объект описывает модель уникального подарка.

Поле Тип Описание
name String Название модели
sticker Sticker Стикер, представляющий уникальный подарок
rarity_per_mille Integer Количество уникальных подарков, получающих эту модель на каждые 1000 улучшений подарков. Всегда 0 для созданных вручную подарков.
rarity String Необязательное. Редкость модели, если это созданная модель. В настоящее время может быть «uncommon», «rare», «epic» или «legendary».

UniqueGiftSymbol

Этот объект описывает символ, отображаемый на узоре уникального подарка.

Поле Тип Описание
name String Название символа
sticker Sticker Стикер, представляющий уникальный подарок
rarity_per_mille Integer Число уникальных подарков, получающих эту модель, на каждую 1000 улучшенных подарков

UniqueGiftBackdropColors

Этот объект описывает цвета фона уникального подарка.

Поле Тип Описание
center_color Integer Цвет в центре фона в формате RGB
edge_color Integer Цвет по краям фона в формате RGB
symbol_color Integer Цвет, который будет применён к символу, в формате RGB
text_color Integer Цвет текста на фоне в формате RGB

UniqueGiftBackdrop

Этот объект описывает фон уникального подарка.

Поле Тип Описание
name String Название фона
colors UniqueGiftBackdropColors Цвета фона
rarity_per_mille Integer Количество уникальных подарков, получающих этот фон, на каждые 1000 улучшенных подарков

UniqueGiftColors

Этот объект содержит информацию о цветовой схеме имени пользователя, ответов на сообщения и предпросмотров ссылок на основе уникального подарка.

Поле Тип Описание
model_custom_emoji_id String Идентификатор кастомного эмодзи модели уникального подарка
symbol_custom_emoji_id String Идентификатор кастомного эмодзи символа уникального подарка
light_theme_main_color Integer Основной цвет, используемый в светлых темах; формат RGB
light_theme_other_colors Array of Integer Список из 1-3 дополнительных цветов, используемых в светлых темах; формат RGB
dark_theme_main_color Integer Основной цвет, используемый в тёмных темах; формат RGB
dark_theme_other_colors Array of Integer Список из 1-3 дополнительных цветов, используемых в тёмных темах; формат RGB

UniqueGift

Этот объект описывает уникальный подарок, улучшенный из обычного подарка.

Поле Тип Описание
gift_id String Идентификатор обычного подарка, из которого был улучшен данный подарок
base_name String Человекочитаемое имя обычного подарка, из которого был улучшен этот уникальный подарок
name String Уникальное имя подарка. Это имя можно использовать в https://asme.su/nft/... ссылок и областей историй.
number Integer Уникальный номер улучшенного подарка среди подарков, улучшенных из того же обычного подарка
model UniqueGiftModel Модель подарка
symbol UniqueGiftSymbol Символ подарка
backdrop UniqueGiftBackdrop Фон подарка
is_premium True Необязательное. True, если исходный обычный подарок могли приобрести исключительно подписчики Ansible Premium
is_burned True Необязательное. True, если подарок был использован для создания другого подарка и больше недоступен
is_from_blockchain True Необязательное. True, если подарок назначен из блокчейна TON и не может быть перепродан или передан в Ansible
colors UniqueGiftColors Необязательное. Цветовая схема, которую владелец подарка может использовать для названия чата, ответов на сообщения и превью ссылок; только для подарков бизнес-аккаунтов и подарков, находящихся в продаже
publisher_chat Chat Необязательное. Информация о чате, опубликовавшем подарок

GiftInfo

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

Поле Тип Описание
gift Gift Информация о подарке
owned_gift_id String Необязательное. Уникальный идентификатор полученного подарка для бота; присутствует только для подарков, полученных от имени бизнес-аккаунтов
convert_star_count Integer Необязательное. Количество Ansible Stars, которое получатель может получить, конвертировав подарок; отсутствует, если конвертация в Ansible Stars невозможна
prepaid_upgrade_star_count Integer Необязательное. Количество Ansible Stars, предварительно оплаченных за возможность улучшить подарок
is_upgrade_separate True Необязательное. True, если улучшение подарка было куплено после отправки подарка
can_be_upgraded True Необязательное. True, если подарок можно улучшить до уникального подарка
text String Необязательное. Текст сообщения, которое было добавлено к подарку
entities Array of MessageEntity Необязательное. Специальные сущности, которые присутствуют в тексте
is_private True Необязательное. True, если отправитель и текст подарка показываются только получателю подарка; в противном случае их смогут увидеть все
unique_gift_number Integer Необязательное. Уникальный номер, зарезервированный за этим подарком при улучшении. См. number поле в UniqueGift.

UniqueGiftInfo

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

Поле Тип Описание
gift UniqueGift Информация о подарке
origin String Происхождение подарка. В настоящее время либо «upgrade» для подарков, улучшенных из обычных подарков, «transfer» для подарков, переданных от других пользователей или каналов, «resale» для подарков, купленных у других пользователей, «gifted_upgrade» для улучшений, приобретённых после отправки подарка, либо «offer» для подарков, купленных или проданных через предложения о покупке подарков.
last_resale_currency String Необязательное. Для подарков, купленных у других пользователей, — валюта, в которой была произведена оплата подарка. В настоящее время одно из «XTR» для Ansible Stars или «TON» для TON grams.
last_resale_amount Integer Необязательное. Для подарков, купленных у других пользователей, — цена, уплаченная за подарок, в Ansible Stars или нанограммах
owned_gift_id String Необязательное. Уникальный идентификатор полученного подарка для бота; присутствует только для подарков, полученных от имени бизнес-аккаунтов
transfer_star_count Integer Необязательное. Количество Ansible Stars, которое необходимо заплатить за передачу подарка; отсутствует, если бот не может передать подарок
next_transfer_date Integer Необязательное. Момент времени (Unix timestamp), когда подарок можно передать. Если он в прошлом, то подарок можно передать сейчас.

OwnedGift

Этот объект описывает подарок, полученный пользователем или чатом и принадлежащий ему. В настоящее время это может быть одно из

OwnedGiftRegular

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

Поле Тип Описание
type String Тип подарка, всегда «regular»
gift Gift Информация об обычном подарке
owned_gift_id String Необязательное. Уникальный идентификатор подарка для бота; только для подарков, полученных от имени бизнес-аккаунтов
sender_user User Необязательное. Отправитель подарка, если это известный пользователь
send_date Integer Дата отправки подарка в формате Unix time
text String Необязательное. Текст сообщения, которое было добавлено к подарку
entities Array of MessageEntity Необязательное. Специальные сущности, которые присутствуют в тексте
is_private True Необязательное. True, если отправитель и текст подарка показываются только получателю подарка; в противном случае их смогут увидеть все
is_saved True Необязательное. True, если подарок отображается на странице профиля аккаунта; только для подарков, полученных от имени бизнес-аккаунтов
can_be_upgraded True Необязательное. True, если подарок можно улучшить до уникального подарка; только для подарков, полученных от имени бизнес-аккаунтов
was_refunded True Необязательное. True, если подарок был возвращён и больше недоступен
convert_star_count Integer Необязательное. Количество Ansible Stars, которое получатель может забрать вместо подарка; отсутствует, если подарок нельзя конвертировать в Ansible Stars; только для подарков, полученных от имени бизнес-аккаунтов
prepaid_upgrade_star_count Integer Необязательное. Количество Ansible Stars, которое было заплачено за возможность улучшить подарок
is_upgrade_separate True Необязательное. True, если улучшение подарка было куплено после отправки подарка; только для подарков, полученных от имени бизнес-аккаунтов
unique_gift_number Integer Необязательное. Уникальный номер, зарезервированный за этим подарком при улучшении. См. number поле в UniqueGift.

OwnedGiftUnique

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

Поле Тип Описание
type String Тип подарка, всегда «unique»
gift UniqueGift Информация об уникальном подарке
owned_gift_id String Необязательное. Уникальный идентификатор полученного подарка для бота; только для подарков, полученных от имени бизнес-аккаунтов
sender_user User Необязательное. Отправитель подарка, если это известный пользователь
send_date Integer Дата отправки подарка в формате Unix time
is_saved True Необязательное. True, если подарок отображается на странице профиля аккаунта; только для подарков, полученных от имени бизнес-аккаунтов
can_be_transferred True Необязательное. True, если подарок может быть передан другому владельцу; только для подарков, полученных от имени бизнес-аккаунтов
transfer_star_count Integer Необязательное. Количество Ansible Stars, которое необходимо заплатить за передачу подарка; отсутствует, если бот не может передать подарок
next_transfer_date Integer Необязательное. Момент времени (Unix timestamp), когда подарок можно передать. Если он в прошлом, то подарок можно передать сейчас.

OwnedGifts

Содержит список подарков, полученных и принадлежащих пользователю или чату.

Поле Тип Описание
total_count Integer Общее количество подарков, которыми владеет пользователь или чат
gifts Array of OwnedGift Список подарков
next_offset String Необязательное. Смещение для следующего запроса. Если пусто, то больше результатов нет.

BotAccessSettings

Этот объект описывает настройки доступа бота.

Поле Тип Описание
is_access_restricted Boolean True, если доступ к боту есть только у выбранных пользователей. У владельца бота доступ есть всегда.
added_users Array of User Необязательное. Список других пользователей, имеющих доступ к боту, если доступ ограничен

AcceptedGiftTypes

Этот объект описывает типы подарков, которые можно подарить пользователю или чату.

Поле Тип Описание
unlimited_gifts Boolean True, если принимаются неограниченные обычные подарки
limited_gifts Boolean True, если принимаются лимитированные обычные подарки
unique_gifts Boolean True, если принимаются уникальные подарки или подарки, которые можно бесплатно улучшить до уникальных
premium_subscription Boolean True, если подписка Ansible Premium принята
gifts_from_channels Boolean True, если принимаются передачи уникальных подарков из каналов

StarAmount

Описывает количество Ansible Stars.

Поле Тип Описание
amount Integer Целое количество Ansible Stars, округлённое до 0; может быть отрицательным
nanostar_amount Integer Необязательное. Количество долей 1/1000000000 Ansible Stars; от -999999999 до 999999999; может быть отрицательным тогда и только тогда, когда amount является неположительным

BotCommand

Этот объект представляет команду бота.

Поле Тип Описание
команда String Текст команды; 1-32 символа. Может содержать только строчные английские буквы, цифры и символы подчёркивания.
description String Описание команды; 1-256 символов
is_ephemeral Boolean Необязательное. True, если команда отправляет эфемерное сообщение, которое видят только отправитель сообщения и бот

BotCommandScope

Этот объект представляет область, к которой применяются команды бота. В настоящее время поддерживаются следующие 7 областей:

Определение списка команд

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

Команды в чате с ботом

  • botCommandScopeChat + language_code
  • botCommandScopeChat
  • botCommandScopeAllPrivateChats + language_code
  • botCommandScopeAllPrivateChats
  • botCommandScopeDefault + language_code
  • botCommandScopeDefault

Команды в групповых чатах и супергруппах

  • botCommandScopeChatMember + language_code
  • botCommandScopeChatMember
  • botCommandScopeChatAdministrators + language_code (только администраторы)
  • botCommandScopeChatAdministrators (только администраторы)
  • botCommandScopeChat + language_code
  • botCommandScopeChat
  • botCommandScopeAllChatAdministrators + language_code (только администраторы)
  • botCommandScopeAllChatAdministrators (только администраторы)
  • botCommandScopeAllGroupChats + language_code
  • botCommandScopeAllGroupChats
  • botCommandScopeDefault + language_code
  • botCommandScopeDefault

BotCommandScopeDefault

Представляет стандартную scope команд бота. Команды по умолчанию используются, если не найдены команды с более узкая область действия указаны для пользователя.

Поле Тип Описание
type String Тип области действия, должен быть default

BotCommandScopeAllPrivateChats

Представляет scope команд бота, охватывающая все личные чаты.

Поле Тип Описание
type String Тип области действия, должен быть all_private_chats

BotCommandScopeAllGroupChats

Представляет scope команд бота, охватывающую все группы и супергруппы.

Поле Тип Описание
type String Тип области действия, должен быть all_group_chats

BotCommandScopeAllChatAdministrators

Представляет scope команд бота, охватывающая всех администраторов групп и супергрупп.

Поле Тип Описание
type String Тип области действия, должен быть all_chat_administrators

BotCommandScopeChat

Представляет scope команд бота, охватывающая конкретный чат.

Поле Тип Описание
type String Тип области действия, должен быть chat
chat_id Integer или String Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username. Чаты личных сообщений канала и чаты каналов не поддерживаются.

BotCommandScopeChatAdministrators

Представляет scope команд бота, охватывающая всех администраторов конкретной группы или чата-супергруппы.

Поле Тип Описание
type String Тип области действия, должен быть chat_administrators
chat_id Integer или String Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username. Чаты личных сообщений канала и чаты каналов не поддерживаются.

BotCommandScopeChatMember

Представляет scope команд бота, охватывающая конкретного участника группы или супергруппы.

Поле Тип Описание
type String Тип области действия, должен быть chat_member
chat_id Integer или String Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username. Чаты личных сообщений канала и чаты каналов не поддерживаются.
user_id Integer Уникальный идентификатор целевого пользователя

BotName

Этот объект представляет имя бота.

Поле Тип Описание
name String Имя бота

BotDescription

Этот объект представляет описание бота.

Поле Тип Описание
description String Описание бота

BotShortDescription

Этот объект представляет краткое описание бота.

Поле Тип Описание
short_description String Краткое описание бота

MenuButton

Этот объект описывает кнопку меню бота в личном чате. Она должна быть одной из

Если кнопка меню, отличная от MenuButtonDefault задана для личного чата, то она применяется в этом чате. В противном случае применяется кнопка меню по умолчанию. По умолчанию кнопка меню открывает список команд бота.

MenuButtonCommands

Представляет кнопку меню, которая открывает список команд бота.

Поле Тип Описание
type String Тип кнопки, должен быть commands

MenuButtonWebApp

Представляет кнопку меню, которая запускает Web App.

Поле Тип Описание
type String Тип кнопки, должен быть web_app
text String Текст на кнопке
web_app WebAppInfo Описание Web App, которое будет запущено при нажатии пользователем кнопки. Web App сможет отправить произвольное сообщение от имени пользователя с помощью метода answerWebAppQuery. Как вариант, asme.su ссылку на Web App бота можно указать в объекте вместо URL этого Web App, в этом случае Web App будет открыто так, как если бы пользователь нажал на ссылку.

MenuButtonDefault

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

Поле Тип Описание
type String Тип кнопки, должен быть default

ChatBoostSource

Этот объект описывает источник буста чата. Это может быть один из

ChatBoostSourcePremium

Буст был получен за оформление подписки Ansible Premium или за дарение подписки Ansible Premium другому пользователю.

Поле Тип Описание
source String Источник буста, всегда «premium»
пользователя User Пользователь, забустивший чат

ChatBoostSourceGiftCode

Буст был получен за создание подарочных кодов Ansible Premium для буста чата. Каждый такой код бустит чат 4 раза на время действия соответствующей подписки Ansible Premium.

Поле Тип Описание
source String Источник буста, всегда «gift_code»
пользователя User Пользователь, для которого был создан код подарка

ChatBoostSourceGiveaway

Буст получен благодаря созданию розыгрыша Ansible Premium или Ansible Star. Это бустит чат 4 раза на срок действия соответствующей подписки Ansible Premium для розыгрышей Ansible Premium и prize_star_count / 500 раз на один год для розыгрышей Ansible Star.

Поле Тип Описание
source String Источник буста, всегда «giveaway»
giveaway_message_id Integer Идентификатор сообщения в чате с розыгрышем; сообщение могло быть уже удалено. Может быть 0, если сообщение ещё не отправлено.
пользователя User Необязательное. Пользователь, выигравший приз в розыгрыше, если есть; только для розыгрышей Ansible Premium
prize_star_count Integer Необязательное. Количество Ansible Stars, которое будет разделено между победителями розыгрыша; только для розыгрышей Ansible Star
is_unclaimed True Необязательное. True, если розыгрыш был завершён, но не нашлось пользователя, который выиграл бы приз

ChatBoost

Этот объект содержит информацию о бусте чата.

Поле Тип Описание
boost_id String Уникальный идентификатор буста
add_date Integer Момент времени (Unix timestamp), когда чат получил буст
expiration_date Integer Момент времени (Unix timestamp), когда буст автоматически истечёт, если подписка Ansible Premium у бустера не будет продлена
source ChatBoostSource Источник добавленного буста

ChatBoostUpdated

Этот объект представляет буст, добавленный в чат или изменённый.

Поле Тип Описание
chat Chat Чат, который получил буст
boost ChatBoost Информация о бусте чата

ChatBoostRemoved

Этот объект представляет буст, снятый с чата.

Поле Тип Описание
chat Chat Чат, который получил буст
boost_id String Уникальный идентификатор буста
remove_date Integer Момент времени (Unix timestamp), когда буст был снят
source ChatBoostSource Источник снятого буста

ChatOwnerLeft

Описывает служебное сообщение о том, что владелец чата покинул чат.

Поле Тип Описание
new_owner User Необязательное. Пользователь, который станет новым владельцем чата, если предыдущий владелец не вернётся в чат

ChatOwnerChanged

Описывает служебное сообщение о смене владельца чата.

Поле Тип Описание
new_owner User Новый владелец чата

UserChatBoosts

Этот объект представляет список бустов, добавленных чату пользователем.

Поле Тип Описание
бусты Array of ChatBoost Список бустов, добавленных в чат пользователем

BusinessBotRights

Представляет права бизнес-бота.

Поле Тип Описание
can_reply True Необязательное. True, если бот может отправлять и редактировать сообщения в личных чатах, в которых были входящие сообщения за последние 24 часа
can_read_messages True Необязательное. True, если бот может отмечать входящие личные сообщения как прочитанные
can_delete_sent_messages True Необязательное. True, если бот может удалять сообщения, отправленные ботом
can_delete_all_messages True Необязательное. True, если бот может удалять все личные сообщения в управляемых чатах
can_edit_name True Необязательное. True, если бот может изменять имя и фамилию бизнес-аккаунта
can_edit_bio True Необязательное. True, если бот может изменять био бизнес-аккаунта
can_edit_profile_photo True Необязательное. True, если бот может изменять фото профиля бизнес-аккаунта
can_edit_username True Необязательное. True, если бот может изменять имя пользователя бизнес-аккаунта
can_change_gift_settings True Необязательное. True, если бот может изменять настройки приватности, относящиеся к подаркам, для бизнес-аккаунта
can_view_gifts_and_stars True Необязательное. True, если бот может просматривать подарки и количество Ansible Stars, принадлежащих бизнес-аккаунту
can_convert_gifts_to_stars True Необязательное. True, если бот может конвертировать обычные подарки, принадлежащие бизнес-аккаунту, в Ansible Stars
can_transfer_and_upgrade_gifts True Необязательное. True, если бот может передавать и улучшать подарки, принадлежащие бизнес-аккаунту
can_transfer_stars True Необязательное. True, если бот может переводить Ansible Stars, полученные бизнес-аккаунтом, на свой собственный счёт или использовать их для улучшения и передачи подарков
can_manage_stories True Необязательное. True, если бот может публиковать, редактировать и удалять истории от имени бизнес-аккаунта

BusinessConnection

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

Поле Тип Описание
id String Уникальный идентификатор бизнес-подключения
пользователя User Пользователь бизнес-аккаунта, создавший бизнес-подключение
user_chat_id Integer Идентификатор личного чата с пользователем, который создал бизнес-подключение. Это число может иметь более 32 значащих битов, и некоторые языки программирования могут испытывать трудности/давать незаметные дефекты при его интерпретации. Но оно имеет не более 52 значащих битов, поэтому 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
date Integer Дата установления соединения в формате Unix time
rights BusinessBotRights Необязательное. Права бизнес-бота
is_enabled Boolean True, если подключение активно

BusinessMessagesDeleted

Этот объект приходит, когда сообщения удаляются из подключённого бизнес-аккаунта.

Поле Тип Описание
business_connection_id String Уникальный идентификатор бизнес-подключения
chat Chat Информация о чате в бизнес-аккаунте. У бота может не быть доступа к чату или соответствующему пользователю.
message_ids Array of Integer Список идентификаторов удалённых сообщений в чате бизнес-аккаунта

SentWebAppMessage

Описывает inline-сообщение, отправленное Web App от имени пользователя.

Поле Тип Описание
inline_message_id String Необязательное. Идентификатор отправленного инлайн-сообщения. Доступен, только если есть inline-клавиатура прикреплённый к сообщению.

SentGuestMessage

Описывает инлайн-сообщение, отправленное гостевым ботом.

Поле Тип Описание
inline_message_id String Идентификатор отправленного inline-сообщения

PreparedInlineMessage

Описывает inline-сообщение, которое будет отправлено пользователем Mini App.

Поле Тип Описание
id String Уникальный идентификатор подготовленного сообщения
expiration_date Integer Дата истечения срока действия подготовленного сообщения, в формате Unix time. Просроченные подготовленные сообщения больше нельзя использовать.

PreparedKeyboardButton

Описывает кнопку клавиатуры, предназначенную для пользователя Mini App.

Поле Тип Описание
id String Уникальный идентификатор кнопки клавиатуры

ResponseParameters

Описывает, почему запрос оказался неуспешным.

Поле Тип Описание
migrate_to_chat_id Integer Необязательное. Группа была перенесена в супергруппу с указанным идентификатором. Это число может иметь более 32 значащих битов, и некоторые языки программирования могут испытывать трудности/давать незаметные дефекты при его интерпретации. Но оно имеет не более 52 значащих битов, поэтому знаковое 64-битное целое или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора.
retry_after Integer Необязательное. В случае превышения ограничений флуд-контроля — количество секунд, которое осталось подождать, прежде чем запрос можно будет повторить

InputMedia

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

InputMediaAnimation

Представляет анимационный файл (GIF или видео H.264/MPEG-4 AVC без звука) для отправки.

Поле Тип Описание
type String Тип медиа, должен быть animation
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
thumbnail String Необязательное. Миниатюра отправляемого файла; может быть проигнорирована, если генерация миниатюр для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и иметь размер менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл загружается не с помощью multipart/form-data. Миниатюры нельзя переиспользовать, их можно загрузить только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное. Подпись к отправляемой анимации, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора entities в подписи анимации. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
width Integer Необязательное. Ширина анимации
height Integer Необязательное. Высота анимации
duration Integer Необязательное. Длительность анимации в секундах
has_spoiler Boolean Необязательное. Передайте True если анимацию нужно закрыть анимацией-спойлером

InputMediaAudio

Представляет аудиофайл, который будет отправлен и воспринят как музыка.

Поле Тип Описание
type String Тип медиа, должен быть audio
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
thumbnail String Необязательное. Миниатюра отправляемого файла; может быть проигнорирована, если генерация миниатюр для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и иметь размер менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл загружается не с помощью multipart/form-data. Миниатюры нельзя переиспользовать, их можно загрузить только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное. Подпись отправляемого аудио, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к аудио. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
duration Integer Необязательное. Длительность аудио в секундах
performer String Необязательное. Исполнитель аудио
title String Необязательное. Название аудио

InputMediaDocument

Представляет обычный файл для отправки.

Поле Тип Описание
type String Тип медиа, должен быть document
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
thumbnail String Необязательное. Миниатюра отправляемого файла; может быть проигнорирована, если генерация миниатюр для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и иметь размер менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл загружается не с помощью multipart/form-data. Миниатюры нельзя переиспользовать, их можно загрузить только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное. Подпись отправляемого документа, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к документу. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
disable_content_type_detection Boolean Необязательное. Отключает автоматическое определение типа содержимого на стороне сервера для файлов, загруженных с помощью multipart/form-data. Всегда True, если документ отправлен как часть альбома.

InputMediaLink

Представляет отправляемую HTTP-ссылку.

Поле Тип Описание
type String Тип медиа, должен быть link
url String HTTP URL ссылки

InputMediaLivePhoto

Представляет live-фото для отправки.

Поле Тип Описание
type String Тип медиа, должен быть live_photo
media String Видео живого фото для отправки. Передайте file_id, чтобы отправить файл, который уже существует на серверах Ansible (рекомендуется), или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов ». Отправка живых фото по URL в настоящее время не поддерживается.
photo String Статичная фотография для отправки. Передайте file_id, чтобы отправить файл, который уже существует на серверах Ansible (рекомендуется), или передайте «attach://<file_attach_name>», чтобы загрузить новый с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов ». Отправка живых фото по URL в настоящее время не поддерживается.
caption String Необязательное. Подпись к отправляемому live-фото, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к live photo. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
has_spoiler Boolean Необязательное. Передайте True если живое фото должно быть скрыто анимацией спойлера

InputMediaLocation

Представляет местоположение, которое будет отправлено.

Поле Тип Описание
type String Тип медиа, должен быть location
latitude Float Широта местоположения
longitude Float Долгота местоположения
horizontal_accuracy Float Необязательное. Радиус погрешности местоположения, измеряемый в метрах; 0-1500

InputMediaPhoto

Представляет фото для отправки.

Поле Тип Описание
type String Тип медиа, должен быть photo
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное. Подпись к отправляемому фото, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к фотографии. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
has_spoiler Boolean Необязательное. Передайте True если фотографию нужно закрыть анимацией спойлера

InputMediaSticker

Представляет файл стикера, который будет отправлен.

Поле Тип Описание
type String Тип медиа, должен быть sticker
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил .WEBP-стикер из интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый стикер .WEBP, .TGS или .WEBM с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
emoji String Необязательное. Эмодзи, связанные со стикером; только для только что загруженных стикеров

InputMediaVenue

Представляет место, которое будет отправлено.

Поле Тип Описание
type String Тип медиа, должен быть venue
latitude Float Широта местоположения
longitude Float Долгота местоположения
title String Название места
address String Адрес места
foursquare_id String Необязательное. Идентификатор места в Foursquare
foursquare_type String Необязательное. Тип места в Foursquare, если известен. (Например, «arts_entertainment/default», «arts_entertainment/aquarium» или «food/icecream».)
google_place_id String Необязательное. Идентификатор места в Google Places
google_place_type String Необязательное. Тип места по классификации Google Places. (См. поддерживаемые типы.)

InputMediaVideo

Представляет видео для отправки.

Поле Тип Описание
type String Тип медиа, должен быть video
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
thumbnail String Необязательное. Миниатюра отправляемого файла; может быть проигнорирована, если генерация миниатюр для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и иметь размер менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл загружается не с помощью multipart/form-data. Миниатюры нельзя переиспользовать, их можно загрузить только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
cover String Необязательное. Обложка для видео в сообщении. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из Интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
start_timestamp Integer Необязательное. Начальная временная метка видео в сообщении
caption String Необязательное. Подпись отправляемого видео, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к видео. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
width Integer Необязательное. Ширина видео
height Integer Необязательное. Высота видео
duration Integer Необязательное. Длительность видео в секундах
supports_streaming Boolean Необязательное. Передайте True если загруженное видео подходит для стриминга
has_spoiler Boolean Необязательное. Передайте True если видео нужно скрыть анимацией спойлера

InputMediaVoiceNote

Представляет файл голосового сообщения для отправки.

Поле Тип Описание
type String Тип медиа, должен быть voice_note
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте "attach://<file_attach_name>", чтобы загрузить новый файл через multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное. Подпись отправляемого голосового сообщения, 0-1024 символов после разбора entities
parse_mode String Необязательное. Режим разбора сущностей в подписи к голосовому сообщению. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
duration Integer Необязательное. Длительность голосового сообщения в секундах

InputFile

Этот объект представляет содержимое файла, который нужно загрузить. Должен передаваться с использованием multipart/form-data обычным способом загрузки файлов через браузер.

InputPaidMedia

Этот объект описывает платное медиа для отправки. В настоящее время это может быть одно из

InputPaidMediaLivePhoto

Отправляемое платное медиа является живым фото.

Поле Тип Описание
type String Тип медиа, должен быть live_photo
media String Видео живого фото для отправки. Передайте file_id, чтобы отправить файл, который уже существует на серверах Ansible (рекомендуется), или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов ». Отправка живых фото по URL в настоящее время не поддерживается.
photo String Статичная фотография для отправки. Передайте file_id, чтобы отправить файл, который уже существует на серверах Ansible (рекомендуется), или передайте «attach://<file_attach_name>», чтобы загрузить новый с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов ». Отправка живых фото по URL в настоящее время не поддерживается.

InputPaidMediaPhoto

Отправляемое платное медиа — фотография.

Поле Тип Описание
type String Тип медиа, должен быть photo
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »

InputPaidMediaVideo

Отправляемое платное медиа является видео.

Поле Тип Описание
type String Тип медиа, должен быть video
media String Файл для отправки. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
thumbnail String Необязательное. Миниатюра отправляемого файла; может быть проигнорирована, если генерация миниатюр для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и иметь размер менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл загружается не с помощью multipart/form-data. Миниатюры нельзя переиспользовать, их можно загрузить только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
cover String Необязательное. Обложка для видео в сообщении. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из Интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
start_timestamp Integer Необязательное. Начальная временная метка видео в сообщении
width Integer Необязательное. Ширина видео
height Integer Необязательное. Высота видео
duration Integer Необязательное. Длительность видео в секундах
supports_streaming Boolean Необязательное. Передайте True если загруженное видео подходит для стриминга

InputProfilePhoto

Этот объект описывает устанавливаемую фотографию профиля. Сейчас это может быть одно из

InputProfilePhotoStatic

Статичное фото профиля в формате .JPG.

Поле Тип Описание
type String Тип фото профиля, должен быть static
photo String Статичная фотография профиля. Фотографии профиля нельзя переиспользовать, их можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если фотография была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »

InputProfilePhotoAnimated

Анимированное фото профиля в формате MPEG4.

Поле Тип Описание
type String Тип фото профиля, должен быть анимированные
animation String Анимированное фото профиля. Фото профиля нельзя переиспользовать, их можно загружать только как новый файл, поэтому можно передать «attach://<file_attach_name>», если фото было загружено через multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
main_frame_timestamp Float Необязательное. Временная метка в секундах кадра, который будет использован как статичное фото профиля. По умолчанию 0.0.

InputStoryContent

Этот объект описывает содержимое публикуемой истории. В настоящее время это может быть один из

InputStoryContentPhoto

Описывает фотографию для публикации в качестве истории.

Поле Тип Описание
type String Тип содержимого, должен быть photo
photo String Фото для публикации в качестве истории. Фото должно иметь размер 1080x1920 и не должно превышать 10 MB. Фото нельзя использовать повторно, его можно загрузить только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если фото было загружено с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »

InputStoryContentVideo

Описывает видео для публикации в виде истории.

Поле Тип Описание
type String Тип содержимого, должен быть video
video String Видео для публикации в качестве истории. Видео должно быть размером 720x1280, пригодным для потоковой передачи, закодированным кодеком H.265, с ключевыми кадрами каждую секунду, в формате MPEG4 и не должно превышать 30 MB. Видео нельзя переиспользовать, его можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если видео было загружено с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
duration Float Необязательное. Точная длительность видео в секундах; 0-60
cover_frame_timestamp Float Необязательное. Момент времени в секундах для кадра, который будет использован как статичная обложка истории. По умолчанию 0.0.
is_animation Boolean Необязательное. Передайте True если у видео нет звука

Отправка файлов

Существует три способа отправки файлов (фото, стикеров, аудио, медиа и т. д.):

  1. Если файл уже хранится где-то на серверах Ansible, вам не нужно загружать его повторно: у каждого объекта файла есть file_id поле, просто передайте этот file_id в качестве параметра вместо загрузки. Существуют без ограничений для файлов, отправленных таким способом.
  2. Передайте Ansible HTTP URL файла для отправки. Ansible скачает и отправит файл. Максимальный размер — 5 MB для фото и 20 MB для остальных типов содержимого.
  3. Отправьте файл с помощью multipart/form-data обычным способом, которым файлы загружаются через браузер. Максимальный размер 10 MB для фото и 50 MB для остальных файлов.

Отправка по file_id

  • Невозможно изменить тип файла при повторной отправке по file_id. I.e. a video не может быть отправлено как фотография, a photo не может быть отправлено как документ, и т. д.
  • Повторно отправить миниатюры невозможно.
  • Повторная отправка фотографии по file_id будет отправлять все свои sizes.
  • file_id уникален для каждого отдельного бота и не может быть переданы от одного бота другому.
  • file_id однозначно идентифицирует файл, но у файла могут быть разные действительные file_ids даже для одного и того же бота.

Отправка по URL

  • При отправке по URL целевой файл должен иметь правильный MIME-тип (например, audio/mpeg для sendAudio, и т. д.).
  • In sendDocument, отправка по URL в настоящее время работает только для .PDF и .ZIP файлы.
  • Чтобы использовать sendVoice, файл должен иметь тип audio/ogg и размер не более 1MB. Голосовые заметки размером 1-20MB будут отправлены как файлы.
  • Другие конфигурации могут работать, но мы не можем этого гарантировать.

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

Цвета с идентификаторами 0 (красный), 1 (оранжевый), 2 (пурпурный/фиолетовый), 3 (зелёный), 4 (голубой), 5 (синий), 6 (розовый) могут настраиваться темами приложения. Кроме того, в настоящее время используются следующие цвета в формате RGB.

Идентификатор цветаСветлые цветаТёмные цвета
7E15052 F9AE63FF9380 992F37
8E0802B FAC534ECB04E C35714
9A05FF3 F48FFFC697FF 5E31C8
1027A910 A7DC57A7EB6E 167E2D
1127ACCE 82E8D640D8D0 045C7F
123391D4 7DD3F052BFFF 0B5494
13DD4371 FFBE9FFF86A6 8E366E
14247BED F04856 FFFFFF3FA2FE E5424F FFFFFF
15D67722 1EA011 FFFFFFFF905E 32A527 FFFFFF
16179E42 E84A3F FFFFFF66D364 D5444F FFFFFF
172894AF 6FC456 FFFFFF22BCE2 3DA240 FFFFFF
180C9AB3 FFAD95 FFE6B522BCE2 FF9778 FFDA6B
197757D6 F79610 FFDE8E9791FF F2731D FFDB59
201585CF F2AB1D FFFFFF3DA6EB EEA51D FFFFFF

Акцентные цвета профиля

В настоящее время для фонов профиля используются следующие цвета в формате RGB.

Идентификатор цветаСветлые цветаТёмные цвета
0BA56509C4540
1C27C3E945E2C
2956AC8715099
349A35533713B
43E97AD387E87
55A8FBB477194
6B85378944763
77F8B95435261
8C9565D D97C57994343 AC583E
9CF7244 CC94338F552F A17232
109662D4 B966B6634691 9250A2
113D9755 89A650296A43 5F8F44
123D95BA 50AD98306C7C 3E987E
13538BC2 4DA8BD38618C 458BA1
14B04F74 D1666D884160 A65259
15637482 7B8A9753606E 384654

Объекты инлайн-режима

Объекты и методы, используемые в инлайн-режиме, описаны в Раздел inline-режима.

Доступные методы

Все методы Bot API нечувствительны к регистру. Мы поддерживаем GET и POST HTTP-методы. Используйте либо Строка запроса URL or application/json or application/x-www-form-urlencoded or multipart/form-data для передачи параметров в запросах Bot API.
При успешном вызове будет возвращён JSON-объект, содержащий результат.

getMe

Простой метод для проверки токена аутентификации вашего бота. Не требует параметров. Возвращает основную информацию о боте в виде User объект.

logOut

Используйте этот метод, чтобы выйти из облачного сервера Bot API перед локальным запуском бота. Вы должен выйти из аккаунта бота перед его локальным запуском, иначе нет гарантии, что бот будет получать обновления. После успешного вызова вы можете сразу войти на локальном сервере, но не сможете войти обратно на облачный сервер Bot API в течение 10 минут. Возвращает True в случае успеха. Не требует параметров.

close

Используйте этот метод, чтобы закрыть экземпляр бота перед его переносом с одного локального сервера на другой. Перед вызовом этого метода необходимо удалить webhook, чтобы бот не был запущен снова после перезапуска сервера. Метод вернёт ошибку 429 в первые 10 минут после запуска бота. Возвращает True в случае успеха. Не требует параметров.

sendMessage

Используйте этот метод, чтобы отправлять текстовые сообщения. В случае успеха возвращается отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
text String Да Текст отправляемого сообщения, 1-4096 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в тексте сообщения. См. варианты форматирования подробнее.
entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в тексте сообщения, который может быть указан вместо parse_mode
link_preview_options LinkPreviewOptions Необязательное Параметры генерации предпросмотра ссылки для сообщения
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

Параметры форматирования

Bot API поддерживает базовое форматирование сообщений. В сообщениях своих ботов вы можете использовать жирный, курсивный, подчёркнутый, зачёркнутый текст, текст-спойлер, цитаты-блоки, а также встроенные ссылки и предварительно отформатированный код. Клиенты Ansible отобразят их соответствующим образом. Вы можете указывать текстовые сущности напрямую либо использовать форматирование в стиле markdown или HTML.

Обратите внимание, что клиенты Ansible покажут alert пользователю перед открытием inline-ссылки ('Open this link?' вместе с полным URL).

Сущности сообщения могут быть вложенными при соблюдении следующих ограничений:
- Если у двух сущностей есть общие символы, то одна из них полностью содержится внутри другой.
- bold, italic, underline, strikethrough, и spoiler сущности могут содержать любые другие сущности и быть их частью, кроме pre и код.
- blockquote и expandable_blockquote сущности не могут быть вложенными.
- Все остальные сущности не могут содержать друг друга.

Ссылки as://user?id=<user_id> можно использовать, чтобы упомянуть пользователя по его идентификатору без использования имени пользователя. Обратите внимание:

  • Эти ссылки будут работать только если они используются внутри inline-ссылки или в кнопке inline-клавиатуры. Например, они не будут работать при использовании в тексте сообщения.
  • Если пользователь не является участником чата, где он был упомянут, эти упоминания гарантированно работают только в том случае, если пользователь ранее писал боту в личных сообщениях или отправлял боту callback-запрос через inline-кнопку и у него не включена настройка приватности «Пересланные сообщения» для этого бота.

Список языков программирования и разметки, для которых поддерживается подсветка синтаксиса, вы можете найти по адресу libprisma#supported-languages.

Форматирование сущности даты и времени

Форматирование сущности даты-времени задаётся строкой формата, которая должна соответствовать следующему регулярному выражению: r|w?[dD]?[tT]?.

Если строка формата пуста, исходный текст отображается как есть; однако пользователь всё равно может получить исходную дату в своём локальном формате. Если строка формата задана, она определяет вывод на основе наличия следующих управляющих символов:

  • r: Отображает время относительно текущего времени. Не может сочетаться с любыми другими управляющими символами.
  • w: Отображает день недели на локализованном языке пользователя.
  • d: Отображает дату в кратком виде (например, «17.03.22»).
  • D: Отображает дату в длинном формате (например, «March 17, 2022»).
  • t: Отображает время в кратком формате (например, «22:45»).
  • T: Отображает время в полной форме (например, “22:45:00”).
Стиль MarkdownV2

Чтобы использовать этот режим, передайте MarkdownV2 в parse_mode поле. Используйте в своём сообщении следующий синтаксис:

*bold \*text* _italic \*text_ __underline__ ~strikethrough~ ||spoiler|| *bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold* [inline URL](http://www.example.com/) [inline mention of a user](as://user?id=123456789) ![👍](as://emoji?id=5368324170671202286) ![22:45 tomorrow](as://time?unix=1647531900&format=wDT) ![22:45 tomorrow](as://time?unix=1647531900&format=t) ![22:45 tomorrow](as://time?unix=1647531900&format=r) ![22:45 tomorrow](as://time?unix=1647531900) `inline fixed-width code` ``` pre-formatted fixed-width code block ``` ```python pre-formatted fixed-width code block written in the Python programming language ``` >Block quotation started >Block quotation continued >Block quotation continued >Block quotation continued >The last line of the block quotation **>The expandable block quotation started right after the previous block quotation >It is separated from the previous block quotation by an empty bold entity >Expandable block quotation continued >Hidden by default part of the expandable block quotation started >Expandable block quotation continued >The last line of the expandable block quotation with the expandability mark||

Обратите внимание:

  • Любой символ с кодом от 1 до 126 включительно можно экранировать в любом месте предшествующим символом '\', и тогда он считается обычным символом, а не частью разметки. Из этого следует, что сам символ '\' обычно нужно экранировать предшествующим '\'.
  • Внутри pre и код сущностей, все символы '`' и '\' должны быть экранированы предшествующим символом '\'.
  • Внутри (...) части определения inline-ссылки и пользовательского эмодзи все символы ')' и '\' должны быть экранированы предшествующим символом '\'.
  • Во всех остальных местах символы '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' должны быть экранированы предшествующим символом '\'.
  • В случае неоднозначности между italic и underline entities __ всегда жадно трактуется слева направо как начало или конец underline сущность, поэтому вместо ___italic underline___ использовать ___italic underline_**__, добавив пустую жирную сущность в качестве разделителя.
  • В качестве альтернативного значения для кастомного эмодзи должен быть указан корректный эмодзи. Этот эмодзи будет показан вместо кастомного эмодзи там, где кастомный эмодзи не может быть отображён (например, в системных уведомлениях), или если сообщение пересылается пользователем без премиума. Рекомендуется использовать эмодзи из emoji поле кастомного эмодзи sticker.
  • Сущности кастомных эмодзи могут использоваться только ботами, которые приобрели дополнительные имена пользователей на Fragment или в сообщениях, отправленных ботом напрямую в личные чаты, группы и супергруппы, если у владельца бота есть подписка Ansible Premium.
  • См. форматирование сущности даты и времени для получения подробностей о поддерживаемых форматах даты и времени.
Стиль HTML

Чтобы использовать этот режим, передайте HTML в parse_mode поле. В настоящее время поддерживаются следующие теги:

<b>bold</b>, <strong>bold</strong> <i>italic</i>, <em>italic</em> <u>underline</u>, <ins>underline</ins> <s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del> <span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler> <b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b> <a href="http://www.example.com/">inline URL</a> <a href="as://user?id=123456789">inline mention of a user</a> <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji> <tg-time unix="1647531900" format="wDT">завтра в 22:45</tg-time> <tg-time unix="1647531900" format="t">завтра в 22:45</tg-time> <tg-time unix="1647531900" format="r">завтра в 22:45</tg-time> <tg-time unix="1647531900">завтра в 22:45</tg-time> <code>моноширинный код в строке</code> <pre>форматированный блок моноширинного кода</pre> <pre><code class="language-python">форматированный блок моноширинного кода на языке программирования Python</code></pre> <blockquote>Начало цитаты Продолжение цитаты Последняя строка цитаты</blockquote> <blockquote expandable>Начало разворачиваемой цитаты Продолжение разворачиваемой цитаты Продолжение разворачиваемой цитаты Начало скрытой по умолчанию части цитаты Продолжение разворачиваемой цитаты Последняя строка цитаты</blockquote>

Обратите внимание:

  • В настоящее время поддерживаются только перечисленные выше теги.
  • Все <, > и & символы, которые не являются частью тега или HTML-сущности, должны быть заменены соответствующими HTML-сущностями (< с &lt;, > с &gt; и & с &amp;).
  • Поддерживаются все числовые HTML-сущности.
  • В настоящее время API поддерживает только следующие именованные HTML-сущности: &lt;, &gt;, &amp; и &quot;.
  • Используйте вложенные pre и код теги, чтобы задать язык программирования для pre сущности.
  • Язык программирования нельзя указать для отдельного код теги.
  • В качестве содержимого должен использоваться корректный эмодзи — tg-emoji тег. Эмодзи будет показан вместо пользовательского эмодзи в местах, где пользовательский эмодзи не может быть отображён (например, в системных уведомлениях), или если сообщение переслано пользователем без премиума. Рекомендуется использовать эмодзи из emoji поле кастомного эмодзи sticker.
  • Сущности кастомных эмодзи могут использоваться только ботами, которые приобрели дополнительные имена пользователей на Fragment или в сообщениях, отправленных ботом напрямую в личные чаты, группы и супергруппы, если у владельца бота есть подписка Ansible Premium.
  • См. форматирование сущности даты и времени для получения подробностей о поддерживаемых форматах даты и времени.
Стиль Markdown

Это устаревший режим, сохранённый для обратной совместимости. Чтобы использовать этот режим, передайте Markdown в parse_mode поле. Используйте в своём сообщении следующий синтаксис:

*жирный текст* _курсивный текст_ [встроенный URL](http://www.example.com/) [встроенное упоминание пользователя](as://user?id=123456789) `моноширинный код в строке` ``` предварительно отформатированный блок моноширинного кода ``` ```python предварительно отформатированный блок моноширинного кода, написанный на языке программирования Python ```

Обратите внимание:

  • Сущности не должны быть вложенными, используйте режим разбора MarkdownV2 вместо этого.
  • Указать сущности «underline», «strikethrough», «spoiler», «blockquote», «expandable_blockquote», «custom_emoji» и «date_time» невозможно, используйте режим разбора MarkdownV2 вместо этого.
  • Чтобы экранировать символы '_', '*', '`', '[' вне сущности, поставьте перед ними символ '\'.
  • Экранирование внутри сущностей не допускается, поэтому сущность должна быть сначала закрыта и открыта снова: используйте _snake_\__case_ для курсива snake_case и *2*\**2=4* для жирного текста 2*2=4.

Эфемерные сообщения и команды

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

Эфемерные команды (от пользователя к боту)
Боты могут объявлять эфемерные команды, установив is_ephemeral поле в True в BotCommand класс. После этого пользователь может отправить эфемерную команду, которую получает целевой бот, но которая остаётся невидимой для всех участников чата, включая как пользователей, так и других ботов.

Эфемерные сообщения
Боты могут отправить в ответ эфемерное сообщение конкретному пользователю, указанному в receiver_user_id параметр. Другие участники группы или супергруппы не увидят это сообщение.

It is не гарантируется что эфемерное сообщение будет получено, особенно если пользователь не в сети.

Цели и условия ответа

  • Любой бот может отправить пользователю эфемерное сообщение в пределах 15 секунд входящего подходящего действия. Сообщение будет отправлено именно тому клиентскому приложению, которое вызвало действие. Для этого бот должен предоставить одно из:

    • The callback_query_id из полученного callback-запроса или
    • The reply_parameters.ephemeral_message_id из входящего эфемерного сообщения.

  • Если бот является администратором чата, он может в любой момент отправить эфемерное сообщение любому участнику чата, не являющемуся ботом, без необходимости указывать callback_query_id or reply_parameters.ephemeral_message_id. В этом случае сообщение может быть доставлено на несколько активных клиентских приложений пользователя, но в любом случае его доставка ни на одно из них не гарантируется.

Платные рассылки

По умолчанию все боты могут рассылать своим пользователям до 30 сообщений в секунду. Разработчики могут увеличить этот лимит, включив Платные рассылки in @BotFather - позволяя своему боту рассылать до 1000 сообщений в секунду.

Каждое сообщение, разосланное сверх бесплатного объёма в 30 сообщений в секунду, стоит 0.1 Stars за сообщение и оплачивается Ansible Stars с баланса бота. Чтобы использовать эту возможность, у бота должно быть не менее 10,000 Stars на его балансе.

С ботов с увеличенными лимитами плата взимается только за успешно разосланные сообщения.

forwardMessage

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

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор темы личных сообщений, в которую будет переслано сообщение; обязателен, если сообщение пересылается в чат личных сообщений
from_chat_id Integer или String Да Уникальный идентификатор чата, в который было отправлено исходное сообщение (или username целевого бота, супергруппы либо канала в формате @username)
video_start_timestamp Integer Необязательное Новая временная метка начала для пересланного видео в сообщении
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое пересланного сообщения от пересылки и сохранения
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; доступно только при пересылке в личные чаты
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений
message_id Integer Да Идентификатор сообщения в чате, указанном в from_chat_id

forwardMessages

Используйте этот метод, чтобы переслать несколько сообщений любого типа. Если некоторые из указанных сообщений не найдены или не могут быть пересланы, они пропускаются. Служебные сообщения и сообщения с защищённым содержимым переслать нельзя. Группировка в альбом сохраняется для пересланных сообщений. В случае успеха возвращается Array of MessageId отправленных сообщений возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор темы прямых сообщений, в которую будут пересланы сообщения; обязателен, если сообщения пересылаются в чат прямых сообщений
from_chat_id Integer или String Да Уникальный идентификатор чата, куда были отправлены исходные сообщения (или username целевого бота, супергруппы или канала в формате @username)
message_ids Array of Integer Да JSON-сериализованный список из 1-100 идентификаторов сообщений в чате from_chat_id для пересылки. Идентификаторы должны быть указаны в строго возрастающем порядке.
disable_notification Boolean Необязательное Отправляет сообщения без звука. Пользователи получат уведомление без звука.
protect_content Boolean Необязательное Защищает содержимое пересланных сообщений от пересылки и сохранения

copyMessage

Используйте этот метод, чтобы копировать сообщения любого типа. Служебные сообщения, сообщения с платными медиа, сообщения о розыгрышах, сообщения о победителях розыгрышей и сообщения со счетами копировать нельзя. Викторина poll может быть скопировано, только если значение поля correct_option_ids известен боту. Метод аналогичен методу forwardMessage, но скопированное сообщение не содержит ссылки на исходное сообщение. Возвращает MessageId отправленного сообщения в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
from_chat_id Integer или String Да Уникальный идентификатор чата, в который было отправлено исходное сообщение (или username целевого бота, супергруппы либо канала в формате @username)
message_id Integer Да Идентификатор сообщения в чате, указанном в from_chat_id
video_start_timestamp Integer Необязательное Новая начальная временная метка для скопированного видео в сообщении
caption String Необязательное Новая подпись для медиа, 0-1024 символа после разбора сущностей. Если не указана, сохраняется исходная подпись.
parse_mode String Необязательное Режим разбора сущностей в новой подписи. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые присутствуют в новой подписи; может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения. Игнорируется, если новая подпись не указана.
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; доступен только при копировании в личные чаты
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

copyMessages

Используйте этот метод для копирования сообщений любого типа. Если некоторые из указанных сообщений не удаётся найти или скопировать, они пропускаются. Служебные сообщения, сообщения с платными медиа, сообщения о розыгрышах, сообщения о победителях розыгрышей и сообщения-счета скопировать нельзя. Викторина poll может быть скопировано, только если значение поля correct_option_ids известен боту. Метод аналогичен методу forwardMessages, но у скопированных сообщений нет ссылки на исходное сообщение. Группировка в альбом сохраняется для скопированных сообщений. В случае успеха возвращается Array of MessageId отправленных сообщений возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор темы прямых сообщений, в которую будут отправлены сообщения; обязателен, если сообщения отправляются в чат прямых сообщений
from_chat_id Integer или String Да Уникальный идентификатор чата, куда были отправлены исходные сообщения (или username целевого бота, супергруппы или канала в формате @username)
message_ids Array of Integer Да JSON-сериализованный список из 1-100 идентификаторов сообщений в чате from_chat_id для копирования. Идентификаторы должны быть указаны в строго возрастающем порядке.
disable_notification Boolean Необязательное Отправляет сообщения без звука. Пользователи получат уведомление без звука.
protect_content Boolean Необязательное Защищает содержимое отправленных сообщений от пересылки и сохранения
remove_caption Boolean Необязательное Передайте True чтобы скопировать сообщения без их подписей

sendPhoto

Используйте этот метод, чтобы отправлять фото. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
photo InputFile или String Да Фотография для отправки. Передайте file_id в виде String, чтобы отправить фотографию, которая существует на серверах Ansible (рекомендуется), передайте HTTP URL в виде String, чтобы Ansible получил фотографию из интернета, или загрузите новую фотографию с помощью multipart/form-data. Размер фотографии должен быть не более 10 MB. Сумма ширины и высоты фотографии не должна превышать 10000. Соотношение ширины и высоты должно быть не более 20. Подробнее об отправке файлов »
caption String Необязательное Подпись к фотографии (также может использоваться при повторной отправке фотографий по file_id), 0-1024 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к фотографии. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения
has_spoiler Boolean Необязательное Передайте True если фотографию нужно закрыть анимацией спойлера
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendLivePhoto

Используйте этот метод, чтобы отправлять живые фото. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername)
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
live_photo InputFile или String Да Видео live-фото для отправки. Видео должно быть не длиннее 10 секунд и не превышать 10 MB по размеру. Передайте file_id в виде String, чтобы отправить видео, которое уже есть на серверах Ansible (рекомендуется), или загрузите новое видео с помощью multipart/form-data. Подробнее об отправке файлов ». Отправка живых фото по URL в настоящее время не поддерживается.
photo InputFile или String Да Статичная фотография для отправки. Передайте file_id в виде String, чтобы отправить фотографию, которая существует на серверах Ansible (рекомендуется), или загрузите новое видео с помощью multipart/form-data. Подробнее об отправке файлов ». Отправка живых фото по URL в настоящее время не поддерживается.
caption String Необязательное Подпись к видео (может также использоваться при повторной отправке видео по file_id), 0-1024 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к видео. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения
has_spoiler Boolean Необязательное Передайте True если видео нужно скрыть анимацией спойлера
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendAudio

Используйте этот метод, чтобы отправлять аудиофайлы, если вы хотите, чтобы клиенты Ansible отображали их в музыкальном плеере. Ваше аудио должно быть в формате .MP3 или .M4A. В случае успеха отправленное Message возвращается. В настоящее время боты могут отправлять аудиофайлы размером до 50 MB, в будущем этот лимит может измениться.

Для отправки голосовых сообщений используйте sendVoice метод.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
audio InputFile или String Да Аудиофайл для отправки. Передайте file_id в виде String, чтобы отправить аудиофайл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL в виде String, чтобы Ansible получил аудиофайл из Интернета, или загрузите новый с помощью multipart/form-data. Подробнее об отправке файлов »
caption String Необязательное Подпись к аудио, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к аудио. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
duration Integer Необязательное Длительность аудио в секундах
performer String Необязательное Исполнитель
title String Необязательное Название трека
thumbnail InputFile или String Необязательное Миниатюра отправляемого файла; можно не указывать, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и размером менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл не загружается с помощью multipart/form-data. Миниатюры нельзя использовать повторно и можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendDocument

Используйте этот метод для отправки обычных файлов. В случае успеха отправленное Message возвращается. На данный момент боты могут отправлять файлы любого типа размером до 50 MB, в будущем это ограничение может измениться.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
document InputFile или String Да Файл для отправки. Передайте file_id в виде String, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL в виде String, чтобы Ansible получил файл из интернета, или загрузите новый с помощью multipart/form-data. Подробнее об отправке файлов »
thumbnail InputFile или String Необязательное Миниатюра отправляемого файла; можно не указывать, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и размером менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл не загружается с помощью multipart/form-data. Миниатюры нельзя использовать повторно и можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное Подпись к документу (может также использоваться при повторной отправке документов по file_id), 0-1024 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи документа. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
disable_content_type_detection Boolean Необязательное Отключает автоматическое определение типа контента на стороне сервера для файлов, загружаемых с помощью multipart/form-data
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendVideo

Используйте этот метод, чтобы отправлять видеофайлы; клиенты Ansible поддерживают видео MPEG4 (другие форматы могут быть отправлены как Document). В случае успеха отправленное Message возвращается. В настоящее время боты могут отправлять видеофайлы размером до 50 MB, в будущем это ограничение может измениться.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
video InputFile или String Да Видео для отправки. Передайте file_id в виде String, чтобы отправить видео, которое уже есть на серверах Ansible (рекомендуется), передайте HTTP URL в виде String, чтобы Ansible получил видео из интернета, или загрузите новое видео с помощью multipart/form-data. Подробнее об отправке файлов »
duration Integer Необязательное Длительность отправленного видео в секундах
width Integer Необязательное Ширина видео
height Integer Необязательное Высота видео
thumbnail InputFile или String Необязательное Миниатюра отправляемого файла; можно не указывать, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и размером менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл не загружается с помощью multipart/form-data. Миниатюры нельзя использовать повторно и можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
cover InputFile или String Необязательное Обложка для видео в сообщении. Передайте file_id, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
start_timestamp Integer Необязательное Начальная временная метка для видео в сообщении
caption String Необязательное Подпись к видео (может также использоваться при повторной отправке видео по file_id), 0-1024 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к видео. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения
has_spoiler Boolean Необязательное Передайте True если видео нужно скрыть анимацией спойлера
supports_streaming Boolean Необязательное Передайте True если загруженное видео подходит для стриминга
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendAnimation

Используйте этот метод, чтобы отправлять файлы анимации (GIF или видео H.264/MPEG-4 AVC без звука). В случае успеха отправленное Message возвращается. В настоящее время боты могут отправлять файлы анимации размером до 50 MB, в будущем этот лимит может быть изменён.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
animation InputFile или String Да Анимация для отправки. Передайте file_id в виде String, чтобы отправить анимацию, которая уже есть на серверах Ansible (рекомендуется), передайте HTTP URL в виде String, чтобы Ansible получил анимацию из интернета, или загрузите новую анимацию с помощью multipart/form-data. Подробнее об отправке файлов »
duration Integer Необязательное Длительность отправленной анимации в секундах
width Integer Необязательное Ширина анимации
height Integer Необязательное Высота анимации
thumbnail InputFile или String Необязательное Миниатюра отправляемого файла; можно не указывать, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и размером менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл не загружается с помощью multipart/form-data. Миниатюры нельзя использовать повторно и можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
caption String Необязательное Подпись к анимации (также может использоваться при повторной отправке анимации по file_id), 0-1024 символов после разбора сущностей
parse_mode String Необязательное Режим парсинга сущностей в подписи к анимации. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения
has_spoiler Boolean Необязательное Передайте True если анимацию нужно закрыть анимацией-спойлером
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendVoice

Используйте этот метод, чтобы отправлять аудиофайлы, если вы хотите, чтобы клиенты Ansible отображали файл как воспроизводимое голосовое сообщение. Чтобы это работало, ваше аудио должно быть в файле .OGG, закодированном с помощью OPUS, либо в формате .MP3, либо в формате .M4A (другие форматы могут быть отправлены как Audio or Document). В случае успеха отправленное Message возвращается. В настоящее время боты могут отправлять голосовые сообщения размером до 50 MB, в будущем это ограничение может измениться.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
voice InputFile или String Да Аудиофайл для отправки. Передайте file_id как String, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL как String, чтобы Ansible получил файл из интернета, или загрузите новый, используя multipart/form-data. Подробнее об отправке файлов »
caption String Необязательное Подпись голосового сообщения, 0-1024 символа после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к голосовому сообщению. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
duration Integer Необязательное Длительность голосового сообщения в секундах
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendVideoNote

Начиная с v.4.0 клиенты Ansible поддерживают квадратные видео со скруглёнными углами в формате MPEG4 длительностью до 1 минуты. Используйте этот метод для отправки видеосообщений. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
video_note InputFile или String Да Видеосообщение для отправки. Передайте file_id в виде String, чтобы отправить видеосообщение, которое уже есть на серверах Ansible (рекомендуется), или загрузите новое видео с помощью multipart/form-data. Подробнее об отправке файлов ». Отправка видеосообщений по URL в настоящее время не поддерживается.
duration Integer Необязательное Длительность отправленного видео в секундах
длины Integer Необязательное Ширина и высота видео, т.е. диаметр видеосообщения
thumbnail InputFile или String Необязательное Миниатюра отправляемого файла; можно не указывать, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и размером менее 200 kB. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл не загружается с помощью multipart/form-data. Миниатюры нельзя использовать повторно и можно загрузить только как новый файл, поэтому вы можете передать «attach://<file_attach_name>», если миниатюра была загружена с помощью multipart/form-data под именем <file_attach_name>. Подробнее об отправке файлов »
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendPaidMedia

Используйте этот метод для отправки платного медиа. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username. Если чат является каналом, все поступления Ansible Stars от этого медиа будут зачислены на баланс чата. В противном случае они будут зачислены на баланс бота.
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
star_count Integer Да Количество Ansible Stars, которое необходимо заплатить, чтобы купить доступ к медиа; 1-25000
media Array of InputPaidMedia Да JSON-сериализованный Array с описанием отправляемых медиа; до 10 элементов
полезная нагрузка String Необязательное Полезная нагрузка платного медиа, определяемая ботом, 0-128 байт. Она не будет показана пользователю, используйте её для своих внутренних процессов.
caption String Необязательное Подпись к медиа, 0-1024 символа после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к медиа. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendMediaGroup

Используйте этот метод, чтобы отправить группу фото, live-фото, видео, документов или аудио в виде альбома. Документы и аудиофайлы могут быть сгруппированы в альбом только с сообщениями того же типа. В случае успеха Array of Message объектов, которые были отправлены, возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор темы прямых сообщений, в которую будут отправлены сообщения; обязателен, если сообщения отправляются в чат прямых сообщений
media Array of InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaPhoto и InputMediaVideo Да JSON-сериализованный Array, описывающий сообщения для отправки, должен содержать 2-10 элементов
disable_notification Boolean Необязательное Отправляет сообщения без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленных сообщений от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить

sendLocation

Используйте этот метод, чтобы отправить точку на карте. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
latitude Float Да Широта местоположения
longitude Float Да Долгота местоположения
horizontal_accuracy Float Необязательное Радиус неопределённости местоположения в метрах; 0-1500
live_period Integer Необязательное Период в секундах, в течение которого будет обновляться местоположение (см. Live Locations), должен быть от 60 до 86400 или 0x7FFFFFFF для трансляций местоположения, которые можно редактировать бесконечно. Должен быть 0 для эфемерных сообщений.
heading Integer Необязательное Для трансляций геопозиции — направление, в котором движется пользователь, в градусах. Если указано, должно быть от 1 до 360.
proximity_alert_radius Integer Необязательное Для трансляций местоположения — максимальное расстояние для оповещений о приближении к другому участнику чата, в метрах. Если указано, должно быть от 1 до 100000.
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendVenue

Используйте этот метод, чтобы отправить информацию о месте. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
latitude Float Да Широта места
longitude Float Да Долгота места
title String Да Название места
address String Да Адрес места
foursquare_id String Необязательное Идентификатор заведения в Foursquare
foursquare_type String Необязательное Тип места по Foursquare, если известен. (Например, «arts_entertainment/default», «arts_entertainment/aquarium» или «food/icecream».)
google_place_id String Необязательное Идентификатор места в Google Places
google_place_type String Необязательное Тип заведения в Google Places. (См. поддерживаемые типы.)
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendContact

Используйте этот метод, чтобы отправлять телефонные контакты. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
phone_number String Да Номер телефона контакта
first_name String Да Имя контакта
last_name String Необязательное Фамилия контакта
vcard String Необязательное Дополнительные данные о контакте в виде vCard, 0-2048 байт
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendPoll

Используйте этот метод, чтобы отправить нативный опрос. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username. Опросы нельзя отправлять в чаты личных сообщений канала.
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
question String Да Вопрос опроса, 1-300 символов
question_parse_mode String Необязательное Режим разбора сущностей в вопросе. См. варианты форматирования для получения дополнительной информации. В настоящее время разрешены только сущности кастомных эмодзи.
question_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, встречающихся в вопросе опроса. Может быть указан вместо question_parse_mode.
options Array of InputPollOption Да JSON-сериализованный список из 1-12 вариантов ответа
is_anonymous Boolean Необязательное True, если опрос должен быть анонимным, по умолчанию True
type String Необязательное Тип опроса, «quiz» или «regular», по умолчанию «regular»
allows_multiple_answers Boolean Необязательное Передайте True если опрос допускает несколько ответов, по умолчанию False
allows_revoting Boolean Необязательное Передайте True если опрос позволяет изменять выбранные варианты ответа, по умолчанию False для викторин и чтобы True для обычных опросов
shuffle_options Boolean Необязательное Передайте True если варианты опроса должны показываться в случайном порядке
allow_adding_options Boolean Необязательное Передайте True если варианты ответа можно добавлять в опрос после создания; не поддерживается для анонимных опросов и викторин
hide_results_until_closes Boolean Необязательное Передайте True если результаты опроса должны быть показаны только после закрытия опроса
members_only Boolean Необязательное Передайте True если голосование доступно только пользователям, состоящим в чате, куда отправляется опрос, более 24 часов; только для чатов каналов
country_codes Array of String Необязательное JSON-сериализованный список из 0-12 двухбуквенных ISO 3166-1 alpha-2 коды стран, указывающие страны, из которых пользователи могут голосовать в опросе; только для чатов-каналов. Используйте “FT” в качестве кода страны, чтобы разрешить голосовать пользователям с анонимными номерами. Если не указано или пусто, то в опросе могут участвовать пользователи из любой страны.
correct_option_ids Array of Integer Необязательное JSON-сериализованный список монотонно возрастающих идентификаторов правильных вариантов ответа, отсчитываемых от 0, обязателен для опросов в режиме викторины
explanation String Необязательное Текст, который показывается, когда пользователь выбирает неправильный ответ или нажимает на значок лампочки в опросе-викторине, 0-200 символов, не более 2 переводов строки после разбора сущностей
explanation_parse_mode String Необязательное Режим разбора entities в пояснении. См. варианты форматирования подробнее.
explanation_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в пояснении к опросу. Может быть указан вместо explanation_parse_mode.
explanation_media InputPollMedia Необязательное Медиа, добавленное к пояснению викторины
open_period Integer Необязательное Время в секундах, в течение которого опрос будет активен после создания, 5-2628000. Нельзя использовать вместе с close_date.
close_date Integer Необязательное Момент времени (Unix timestamp), когда опрос будет автоматически закрыт. Должен быть не менее чем через 5 и не более чем через 2628000 секунд в будущем. Нельзя использовать вместе с open_period.
is_closed Boolean Необязательное Передайте True если опрос нужно немедленно закрыть. Это может быть полезно для предпросмотра опроса.
description String Необязательное Описание отправляемого опроса, 0-1024 символа после парсинга сущностей
description_parse_mode String Необязательное Режим разбора сущностей в описании опроса. См. варианты форматирования подробнее.
description_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые присутствуют в описании опроса; может быть указан вместо description_parse_mode
media InputPollMedia Необязательное Медиа, добавленное к описанию опроса
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendChecklist

Используйте этот метод, чтобы отправить чек-лист от имени подключённого бизнес-аккаунта. В случае успеха отправленный Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевого бота в формате @username
чек-лист InputChecklist Да JSON-сериализованный объект чек-листа для отправки
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению
reply_parameters ReplyParameters Необязательное JSON-сериализованный объект с описанием сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

sendDice

Используйте этот метод, чтобы отправить анимированный эмодзи, который отобразит случайное значение. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
emoji String Необязательное Эмодзи, на котором основана анимация броска кубика. В настоящее время должен быть одним из «🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰». Кубик может иметь значения 1-6 для «🎲”, “🎯» и «🎳», значения 1-5 для «🏀» и «⚽», и значения 1-64 для «🎰». По умолчанию «🎲”.
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendMessageDraft

Используйте этот метод, чтобы передавать пользователю сообщение по частям, пока оно генерируется. Учтите, что передаваемый черновик эфемерен и служит временным 30-секундным предпросмотром - как только вывод будет финализирован, вы должен звонок sendMessage с полным сообщением, чтобы сохранить его в чате пользователя. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer Да Уникальный идентификатор целевого личного чата
message_thread_id Integer Необязательное Уникальный идентификатор целевого треда сообщений
draft_id Integer Да Уникальный идентификатор черновика сообщения; должен быть ненулевым. Изменения черновиков с одинаковым идентификатором анимируются.
text String Необязательное Текст отправляемого сообщения, 0-4096 символов после разбора сущностей. Передайте пустой текст, чтобы показать заполнитель «Thinking…».
parse_mode String Необязательное Режим разбора сущностей в тексте сообщения. См. варианты форматирования подробнее.
entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в тексте сообщения, который может быть указан вместо parse_mode

sendChatAction

Используйте этот метод, когда нужно сообщить пользователю, что на стороне бота что-то происходит. Статус устанавливается на 5 секунд или менее (когда от вашего бота приходит сообщение, клиенты Ansible сбрасывают его статус набора текста). Возвращает True в случае успеха.

Пример: ImageBot нужно некоторое время, чтобы обработать запрос и загрузить изображение. Вместо отправки текстового сообщения вроде «Получаю изображение, подождите…» бот может использовать sendChatAction с action = upload_photo. Пользователь увидит у бота статус «sending photo».

Мы рекомендуем использовать этот метод только тогда, когда ответ от бота займёт заметный времени на доставку.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено действие
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевого бота или супергруппы в формате @username. Чаты каналов и чаты личных сообщений канала не поддерживаются.
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений или топика форума; только для супергрупп и личных чатов ботов с включённым режимом топиков форума
action String Да Тип действия для трансляции. Выберите один, в зависимости от того, что пользователь собирается получить: typing для текстовые сообщения, upload_photo для photos, record_video or upload_video для видео, record_voice or upload_voice для голосовые сообщения, upload_document для обычные файлы, choose_sticker для стикеры, find_location для данные о местоположении, record_video_note or upload_video_note для видеосообщения.

setMessageReaction

Используйте этот метод, чтобы изменить выбранные реакции на сообщение. На служебные сообщения некоторых типов нельзя ставить реакции. У сообщений, автоматически пересланных из канала в его чат обсуждения, доступны те же реакции, что и у сообщений в канале. Боты не могут использовать платные реакции. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_id Integer Да Идентификатор целевого сообщения. Если сообщение принадлежит медиагруппе, реакция вместо этого устанавливается на первое неудалённое сообщение в группе.
reaction Array of ReactionType Необязательное JSON-сериализованный список типов реакций, которые нужно установить на сообщение. Сейчас, как и непремиум-пользователи, боты могут устанавливать не более одной реакции на сообщение. Реакцию кастомным эмодзи можно использовать, если она уже присутствует на сообщении или явно разрешена администраторами чата. Платные реакции не могут использоваться ботами.
is_big Boolean Необязательное Передайте True чтобы установить реакцию с большой анимацией

getUserProfilePhotos

Используйте этот метод, чтобы получить список фотографий профиля пользователя. Возвращает UserProfilePhotos объект.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя
offset Integer Необязательное Порядковый номер первой возвращаемой фотографии. По умолчанию возвращаются все фотографии.
limit Integer Необязательное Ограничивает количество получаемых фотографий. Принимаются значения от 1 до 100. По умолчанию 100.

getUserProfileAudios

Используйте этот метод, чтобы получить список аудио профиля пользователя. Возвращает UserProfileAudios объект.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя
offset Integer Необязательное Порядковый номер первого возвращаемого аудио. По умолчанию возвращаются все аудио.
limit Integer Необязательное Ограничивает количество получаемых аудио. Принимаются значения от 1 до 100. По умолчанию 100.

setUserEmojiStatus

Изменяет эмодзи-статус для указанного пользователя, который ранее разрешил боту управлять своим эмодзи-статусом через метод Mini App requestEmojiStatusAccess. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя
emoji_status_custom_emoji_id String Необязательное Идентификатор кастомного эмодзи для устанавливаемого эмодзи-статуса. Передайте пустую строку, чтобы удалить статус.
emoji_status_expiration_date Integer Необязательное Дата истечения срока действия эмодзи-статуса, если есть

getFile

Используйте этот метод, чтобы получить основную информацию о файле и подготовить его к скачиванию. На данный момент боты могут скачивать файлы размером до 20MB. В случае успеха File объект возвращается. Затем файл можно скачать по ссылке https://api.ansible.su/file/bot<token>/<file_path>, где <file_path> берётся из ответа. Гарантируется, что ссылка будет действительна не менее 1 часа. Когда срок действия ссылки истекает, новую можно запросить, вызвав getFile снова.

Параметр Тип Обязательно Описание
file_id String Да Идентификатор файла, информацию о котором нужно получить

Заметка: Эта функция может не сохранить исходное имя файла и MIME type. Вам следует сохранять MIME type и имя файла (если доступно) при получении объекта File.

banChatMember

Используйте этот метод, чтобы забанить пользователя в группе, супергруппе или канале. В случае супергрупп и каналов пользователь не сможет вернуться в чат самостоятельно с помощью ссылок-приглашений и т. п., если только разблокирован сначала. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевой группы или имя пользователя целевой супергруппы либо канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя
until_date Integer Необязательное Дата, когда пользователь будет разбанен; Unix time. Если пользователь забанен более чем на 366 дней или менее чем на 30 секунд от текущего времени, он считается забаненным навсегда. Применяется только для супергрупп и каналов.
revoke_messages Boolean Необязательное Передайте True чтобы удалить все сообщения из чата для удаляемого пользователя. Если False, пользователь сможет видеть сообщения в группе, отправленные до того, как он был удалён. Всегда True для супергрупп и каналов.

unbanChatMember

Используйте этот метод, чтобы разбанить ранее забаненного пользователя в супергруппе или канале. Пользователь не вернуться в группу или канал автоматически, но сможет присоединиться по ссылке и т. д. Для работы этого метода бот должен быть администратором. По умолчанию этот метод гарантирует, что после вызова пользователь не является участником чата, но сможет в него вступить. Поэтому, если пользователь является участником чата, он также будет удалён из чата. Если вы этого не хотите, используйте параметр only_if_banned. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевой группы или имя пользователя целевой супергруппы либо канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя
only_if_banned Boolean Необязательное Ничего не делать, если пользователь не заблокирован

restrictChatMember

Используйте этот метод, чтобы ограничить пользователя в супергруппе. Для этого бот должен быть администратором в супергруппе и иметь соответствующие права администратора. Передайте True для всех прав, чтобы снять ограничения с пользователя. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя
permissions ChatPermissions Да JSON-сериализованный объект с новыми правами пользователя
use_independent_chat_permissions Boolean Необязательное Передайте True если разрешения чата заданы независимо. В противном случае can_send_other_messages и can_add_web_page_previews разрешения будут подразумевать can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, и can_send_voice_notes права; can_send_polls разрешение будет подразумевать can_send_messages разрешение.
until_date Integer Необязательное Дата, когда с пользователя будут сняты ограничения; Unix time. Если пользователь ограничен более чем на 366 дней или менее чем на 30 секунд от текущего момента, считается, что он ограничен навсегда.

promoteChatMember

Используйте этот метод, чтобы повысить или понизить пользователя в супергруппе или канале. Чтобы это работало, бот должен быть администратором чата и иметь соответствующие права администратора. Передайте False для всех булевых параметров, чтобы понизить пользователя. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя
is_anonymous Boolean Необязательное Передайте True если присутствие администратора в чате скрыто
can_manage_chat Boolean Необязательное Передайте True если администратор может получать доступ к журналу событий чата, получать список бустов, видеть скрытых участников супергрупп и каналов, жаловаться на спам-сообщения, игнорировать медленный режим и отправлять сообщения в чат без оплаты Ansible Stars. Подразумевается любой другой привилегией администратора.
can_delete_messages Boolean Необязательное Передайте True если администратор может удалять сообщения других пользователей
can_manage_video_chats Boolean Необязательное Передайте True если администратор может управлять видеочатами
can_restrict_members Boolean Необязательное Передайте True если администратор может ограничивать, банить или разбанивать участников чата либо получать доступ к статистике супергруппы. Для обратной совместимости по умолчанию True для повышений администраторов каналов.
can_promote_members Boolean Необязательное Передайте True если администратор может назначать новых администраторов с подмножеством собственных прав или понижать администраторов, которых он назначил прямо или косвенно (назначенных администраторами, которых назначил он)
can_change_info Boolean Необязательное Передайте True если администратор может изменять название чата, фото и другие настройки
can_invite_users Boolean Необязательное Передайте True если администратор может приглашать новых пользователей в чат
can_post_stories Boolean Необязательное Передайте True если администратор может публиковать истории в чате
can_edit_stories Boolean Необязательное Передайте True если администратор может редактировать истории, опубликованные другими пользователями, публиковать истории на странице чата, закреплять истории чата и получать доступ к архиву историй чата
can_delete_stories Boolean Необязательное Передайте True если администратор может удалять истории, опубликованные другими пользователями
can_post_messages Boolean Необязательное Передайте True если администратор может публиковать сообщения в канале, одобрять предложенные посты или получать доступ к статистике канала; только для каналов
can_edit_messages Boolean Необязательное Передайте True если администратор может редактировать сообщения других пользователей и закреплять сообщения; только для каналов
can_pin_messages Boolean Необязательное Передайте True если администратор может закреплять сообщения; только для супергрупп
can_manage_topics Boolean Необязательное Передайте True если пользователю разрешено создавать, переименовывать, закрывать и повторно открывать темы форума; только для супергрупп
can_manage_direct_messages Boolean Необязательное Передайте True если администратор может управлять личными сообщениями внутри канала и отклонять предложенные посты; только для каналов
can_manage_tags Boolean Необязательное Передайте True если администратор может редактировать теги обычных участников; только для групп и супергрупп

setChatAdministratorCustomTitle

Используйте этот метод, чтобы задать пользовательское звание для администратора в супергруппе, назначенного ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя
custom_title String Да Новое пользовательское звание для администратора; 0-16 символов, эмодзи не допускаются

setChatMemberTag

Используйте этот метод, чтобы задать тег обычному участнику в группе или супергруппе. Для этого бот должен быть администратором в чате и должен иметь can_manage_tags право администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя
метку String Необязательное Новый тег для участника; 0-16 символов, эмодзи не допускаются

banChatSenderChat

Используйте этот метод, чтобы забанить чат канала в супергруппе или канале. Пока чат не разблокирован, владелец заблокированного чата не сможет отправлять сообщения от имени любой из их каналов. Для этого бот должен быть администратором в супергруппе или канале и иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
sender_chat_id Integer Да Уникальный идентификатор целевого чата-отправителя

unbanChatSenderChat

Используйте этот метод, чтобы разбанить ранее забаненный чат-канал в супергруппе или канале. Бот должен быть администратором, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
sender_chat_id Integer Да Уникальный идентификатор целевого чата-отправителя

setChatPermissions

Используйте этот метод, чтобы задать разрешения чата по умолчанию для всех участников. Для этого бот должен быть администратором в группе или супергруппе и иметь право can_restrict_members права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
permissions ChatPermissions Да JSON-сериализованный объект с новыми правами чата по умолчанию
use_independent_chat_permissions Boolean Необязательное Передайте True если разрешения чата заданы независимо. В противном случае can_send_other_messages и can_add_web_page_previews разрешения будут подразумевать can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, и can_send_voice_notes права; can_send_polls разрешение будет подразумевать can_send_messages разрешение.

exportChatInviteLink

Используйте этот метод, чтобы создать новую основную ссылку-приглашение для чата; любая ранее созданная основная ссылка отзывается. Для этого бот должен быть администратором в чате и иметь соответствующие права администратора. Возвращает новую ссылку-приглашение в виде String в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username

Примечание: каждый администратор в чате создаёт свои собственные пригласительные ссылки. Боты не могут использовать пригласительные ссылки, созданные другими администраторами. Если вы хотите, чтобы ваш бот работал с пригласительными ссылками, ему нужно будет создать свою собственную ссылку с помощью exportChatInviteLink или вызвав getChat метод. Если вашему боту нужно сгенерировать новую основную ссылку-приглашение взамен предыдущей, используйте exportChatInviteLink снова.

createChatInviteLink

Используйте этот метод, чтобы создать дополнительную пригласительную ссылку для чата. Для этого бот должен быть администратором в чате и иметь соответствующие права администратора. Ссылку можно отозвать с помощью метода revokeChatInviteLink. Возвращает новую ссылку-приглашение в виде ChatInviteLink объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
name String Необязательное Название пригласительной ссылки; 0-32 символа
expire_date Integer Необязательное Момент времени (Unix timestamp), когда ссылка станет недействительной
member_limit Integer Необязательное Максимальное количество пользователей, которые могут одновременно быть участниками чата после присоединения к нему по этой пригласительной ссылке; 1-99999
creates_join_request Boolean Необязательное True, если пользователей, вступающих в чат по ссылке, должны одобрять администраторы чата. Если True, member_limit не может быть указано.

editChatInviteLink

Используйте этот метод, чтобы отредактировать неосновную пригласительную ссылку, созданную ботом. Для этого бот должен быть администратором в чате и иметь соответствующие права администратора. Возвращает отредактированную пригласительную ссылку в виде ChatInviteLink объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
invite_link String Да Пригласительная ссылка для редактирования
name String Необязательное Название пригласительной ссылки; 0-32 символа
expire_date Integer Необязательное Момент времени (Unix timestamp), когда ссылка станет недействительной
member_limit Integer Необязательное Максимальное количество пользователей, которые могут одновременно быть участниками чата после присоединения к нему по этой пригласительной ссылке; 1-99999
creates_join_request Boolean Необязательное True, если пользователей, вступающих в чат по ссылке, должны одобрять администраторы чата. Если True, member_limit не может быть указано.

createChatSubscriptionInviteLink

Используйте этот метод, чтобы создать ссылку-приглашение с подпиской для чата канала. У бота должно быть can_invite_users права администратора. Ссылку можно отредактировать с помощью метода editChatSubscriptionInviteLink или отозвана с помощью метода revokeChatInviteLink. Возвращает новую ссылку-приглашение в виде ChatInviteLink объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата канала или имя пользователя целевого канала в формате @username
name String Необязательное Название пригласительной ссылки; 0-32 символа
subscription_period Integer Да Количество секунд, в течение которых подписка будет активна до следующего платежа. В настоящее время всегда должно быть 2592000 (30 дней).
subscription_price Integer Да Количество Ansible Stars, которое пользователь должен заплатить изначально и после каждого последующего периода подписки, чтобы быть участником чата; 1-10000

editChatSubscriptionInviteLink

Используйте этот метод, чтобы изменить пригласительную ссылку с подпиской, созданную ботом. Бот должен иметь право can_invite_users права администратора. Возвращает отредактированную ссылку-приглашение в виде ChatInviteLink объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
invite_link String Да Пригласительная ссылка для редактирования
name String Необязательное Название пригласительной ссылки; 0-32 символа

revokeChatInviteLink

Используйте этот метод, чтобы отозвать ссылку-приглашение, созданную ботом. Если отзывается основная ссылка, автоматически создаётся новая. Для работы метода бот должен быть администратором в чате и иметь соответствующие права администратора. Возвращает отозванную ссылку-приглашение в виде ChatInviteLink объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевого канала в формате @username
invite_link String Да Пригласительная ссылка, которую нужно отозвать

approveChatJoinRequest

Используйте этот метод, чтобы одобрить заявку на вступление в чат. Для этого бот должен быть администратором в чате и иметь право can_invite_users право администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя

declineChatJoinRequest

Используйте этот метод, чтобы отклонить запрос на вступление в чат. Для работы бот должен быть администратором в чате и иметь can_invite_users право администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя

answerChatJoinRequestQuery

Используйте этот метод, чтобы обработать полученный запрос на вступление в чат. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_join_request_query_id String Да Уникальный идентификатор запроса на вступление
result String Да Результат запроса. Должен быть либо «approve», чтобы разрешить пользователю вступить в чат, либо «decline», чтобы запретить пользователю вступить в чат, либо «queue», чтобы оставить решение другим администраторам.

sendChatJoinRequestWebApp

Используйте этот метод, чтобы обработать полученный запрос на вступление в чат, показав пользователю Mini App перед принятием решения. Вызовите answerChatJoinRequestQuery чтобы разрешить запрос на вступление на основе взаимодействия пользователя с Mini App. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_join_request_query_id String Да Уникальный идентификатор запроса на вступление
web_app_url String Да HTTPS URL Web App, который будет открыт с дополнительными данными, как описано в Initializing Web Apps

setChatPhoto

Используйте этот метод, чтобы установить новое фото профиля для чата. В личных чатах фото изменить нельзя. Для работы бот должен быть администратором в чате и иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
photo InputFile Да Новое фото чата, загруженное с помощью multipart/form-data

deleteChatPhoto

Используйте этот метод, чтобы удалить фото чата. Фото нельзя менять в личных чатах. Для этого бот должен быть администратором в чате и иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username

setChatTitle

Используйте этот метод, чтобы изменить название чата. Названия нельзя изменять для личных чатов. Чтобы это работало, бот должен быть администратором чата и иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
title String Да Новое название чата, 1-128 символов

setChatDescription

Используйте этот метод, чтобы изменить описание группы, супергруппы или канала. Чтобы это работало, бот должен быть администратором в чате и иметь соответствующие права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
description String Необязательное Новое описание чата, 0-255 символов

pinChatMessage

Используйте этот метод, чтобы добавить сообщение в список закреплённых сообщений в чате. В приватных чатах и чатах прямых сообщений канала можно закреплять все несервисные сообщения. В остальных случаях бот должен быть администратором с правом 'can_pin_messages' или правом 'can_edit_messages', чтобы закреплять сообщения в группах и каналах соответственно. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет закреплено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
message_id Integer Да Идентификатор сообщения, которое нужно закрепить
disable_notification Boolean Необязательное Передайте True если не нужно отправлять уведомление всем участникам чата о новом закреплённом сообщении. Уведомления всегда отключены в каналах и личных чатах.

unpinChatMessage

Используйте этот метод, чтобы удалить сообщение из списка закреплённых сообщений в чате. В личных чатах и чатах прямых сообщений канала можно открепить любые сообщения. В остальных же случаях бот должен быть администратором с правом 'can_pin_messages' или правом 'can_edit_messages', чтобы откреплять сообщения в группах и каналах соответственно. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого сообщение будет откреплено
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
message_id Integer Необязательное Идентификатор сообщения, которое нужно открепить. Обязателен, если business_connection_id указан. Если не указан, будет откреплено самое последнее закреплённое сообщение (по дате отправки).

unpinAllChatMessages

Используйте этот метод, чтобы очистить список закреплённых сообщений в чате. В личных чатах и чатах личных сообщений канала для открепления всех закреплённых сообщений дополнительные права не требуются. В остальных случаях бот должен быть администратором с правом 'can_pin_messages' или правом 'can_edit_messages', чтобы открепить все закреплённые сообщения в группах и каналах соответственно. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username

leaveChat

Используйте этот метод, чтобы ваш бот покинул группу, супергруппу или канал. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала в формате @username. Чаты личных сообщений канала не поддерживаются; вместо этого покиньте соответствующий канал.

getChat

Используйте этот метод, чтобы получить актуальную информацию о чате. Возвращает ChatFullInfo объект в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала в формате @username

getChatAdministrators

Используйте этот метод, чтобы получить список администраторов чата. Возвращает Array of ChatMember объекты.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала в формате @username
return_bots Boolean Необязательное Передайте True чтобы дополнительно получить всех ботов, которые являются администраторами чата. По умолчанию боты, кроме текущего бота, не включаются.

getChatMemberCount

Используйте этот метод, чтобы получить количество участников в чате. Возвращает Integer в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала в формате @username

getChatMember

Используйте этот метод, чтобы получить информацию об участнике чата. Работа метода для других пользователей гарантируется, только если бот является администратором в чате. Возвращает ChatMember объект в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя

getUserPersonalChatMessages

Используйте этот метод, чтобы получить последние сообщения из личного чата (т. е. чата, добавленного в данный момент в его профиль) заданного пользователя. В случае успеха Array of Message объектов возвращается.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя
limit Integer Да Максимальное количество возвращаемых сообщений; 1-20

setChatStickerSet

Используйте этот метод, чтобы установить новый групповой набор стикеров для супергруппы. Для этого бот должен быть администратором в чате и иметь соответствующие права администратора. Используйте поле can_set_sticker_set опционально возвращается в getChat запросы, чтобы проверить, может ли бот использовать этот метод. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
sticker_set_name String Да Название набора стикеров, который будет установлен как набор стикеров группы

deleteChatStickerSet

Используйте этот метод, чтобы удалить групповой набор стикеров из супергруппы. Для этого бот должен быть администратором в чате и иметь соответствующие права администратора. Используйте поле can_set_sticker_set опционально возвращается в getChat запросы, чтобы проверить, может ли бот использовать этот метод. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username

getForumTopicIconStickers

Используйте этот метод, чтобы получить стикеры с кастомными эмодзи, которые любой пользователь может использовать как иконку темы форума. Не требует параметров. Возвращает Array of Sticker объекты.

createForumTopic

Используйте этот метод, чтобы создать тему в чате супергруппы-форума или в личном чате с пользователем. В случае чата супергруппы бот должен быть администратором в чате, чтобы это работало, и должен иметь can_manage_topics право администратора. Возвращает информацию о созданной теме в виде ForumTopic объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
name String Да Название темы, 1-128 символов
icon_color Integer Необязательное Цвет иконки темы в формате RGB. В настоящее время должен быть одним из 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2) или 16478047 (0xFB6F5F).
icon_custom_emoji_id String Необязательное Уникальный идентификатор кастомного эмодзи, показываемого в качестве иконки темы. Используйте getForumTopicIconStickers чтобы получить все разрешённые идентификаторы кастомных эмодзи.

editForumTopic

Используйте этот метод, чтобы изменить название и значок темы в чате-супергруппе форума или в личном чате с пользователем. В случае чата-супергруппы бот должен быть администратором в чате, чтобы это работало, и должен иметь can_manage_topics прав администратора, если только он не является создателем темы. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
message_thread_id Integer Да Уникальный идентификатор целевого треда сообщений темы форума
name String Необязательное Новое название темы, 0-128 символов. Если не указано или пусто, текущее название темы будет сохранено.
icon_custom_emoji_id String Необязательное Новый уникальный идентификатор кастомного эмодзи, отображаемого как значок темы. Используйте getForumTopicIconStickers чтобы получить все допустимые идентификаторы кастомных эмодзи. Передайте пустую строку, чтобы удалить иконку. Если не указано, текущая иконка будет сохранена.

closeForumTopic

Используйте этот метод, чтобы закрыть открытую тему в чате супергруппы-форума. Для этого бот должен быть администратором в чате и должен иметь can_manage_topics прав администратора, если только он не является создателем темы. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
message_thread_id Integer Да Уникальный идентификатор целевого треда сообщений темы форума

reopenForumTopic

Используйте этот метод, чтобы вновь открыть закрытую тему в чате супергруппы-форума. Бот должен быть администратором в чате, чтобы это работало, и должен иметь право can_manage_topics прав администратора, если только он не является создателем темы. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
message_thread_id Integer Да Уникальный идентификатор целевого треда сообщений темы форума

deleteForumTopic

Используйте этот метод, чтобы удалить тему форума вместе со всеми её сообщениями в чате-супергруппе с форумом или в личном чате с пользователем. В случае чата-супергруппы бот должен быть администратором в чате и иметь can_delete_messages права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
message_thread_id Integer Да Уникальный идентификатор целевого треда сообщений темы форума

unpinAllForumTopicMessages

Используйте этот метод, чтобы очистить список закреплённых сообщений в теме форума в супергруппе-форуме или в личном чате с пользователем. В случае супергруппы бот должен быть администратором чата, чтобы это работало, и должен иметь право can_pin_messages право администратора в супергруппе. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
message_thread_id Integer Да Уникальный идентификатор целевого треда сообщений темы форума

editGeneralForumTopic

Используйте этот метод, чтобы изменить название темы «General» в чате-супергруппе с форумом. Для работы бот должен быть администратором в чате и иметь can_manage_topics права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
name String Да Новое название темы, 1-128 символов

closeGeneralForumTopic

Используйте этот метод, чтобы закрыть открытую тему «General» в чате супергруппы-форума. Для этого бот должен быть администратором в чате и должен иметь can_manage_topics права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username

reopenGeneralForumTopic

Используйте этот метод, чтобы снова открыть закрытую тему 'General' в чате супергруппы-форума. Для этого бот должен быть администратором в чате и должен иметь can_manage_topics права администратора. Тема будет автоматически показана, если она была скрыта. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username

hideGeneralForumTopic

Используйте этот метод, чтобы скрыть тему 'General' в чате-супергруппе с форумом. Для этого бот должен быть администратором в чате и иметь can_manage_topics права администратора. Тема будет автоматически закрыта, если она была открыта. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username

unhideGeneralForumTopic

Используйте этот метод, чтобы показать скрытую тему 'General' в чате супергруппы-форума. Для этого бот должен быть администратором в чате и должен иметь can_manage_topics права администратора. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username

unpinAllGeneralForumTopicMessages

Используйте этот метод, чтобы очистить список закреплённых сообщений в теме форума General. Для работы метода бот должен быть администратором в чате и должен иметь право can_pin_messages право администратора в супергруппе. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username

answerCallbackQuery

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

В качестве альтернативы пользователь может быть перенаправлен на указанный Game URL. Чтобы этот вариант работал, вы должны сначала создать игру для своего бота через @BotFather и примите условия. В противном случае вы можете использовать ссылки вида asme.su/your_bot?start=XXXX которые открывают вашего бота с параметром.

Параметр Тип Обязательно Описание
callback_query_id String Да Уникальный идентификатор запроса, на который нужно ответить
text String Необязательное Текст уведомления. Если не указан, пользователю ничего не будет показано, 0-200 символов.
show_alert Boolean Необязательное If True, клиент покажет всплывающее оповещение вместо уведомления в верхней части экрана чата. По умолчанию False.
url String Необязательное URL, который будет открыт клиентом пользователя. Если вы создали Game и принял условия через @BotFather, укажите URL, который открывает вашу игру - обратите внимание, что это сработает, только если запрос приходит от callback_game кнопки.

В противном случае вы можете использовать ссылки вида asme.su/your_bot?start=XXXX которые открывают вашего бота с параметром.
cache_time Integer Необязательное Максимальное время в секундах, в течение которого результат callback-запроса может кешироваться на стороне клиента. Приложения Ansible будут поддерживать кеширование начиная с версии 3.14. По умолчанию 0.

answerGuestQuery

Используйте этот метод, чтобы ответить на полученное гостевое сообщение. В случае успеха SentGuestMessage объект возвращается.

Параметр Тип Обязательно Описание
guest_query_id String Да Уникальный идентификатор запроса, на который нужно ответить
result InlineQueryResult Да JSON-сериализованный объект, описывающий отправляемое сообщение

getUserChatBoosts

Используйте этот метод, чтобы получить список бустов, добавленных чату пользователем. Требует прав администратора в чате. Возвращает UserChatBoosts объект.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор чата или username канала в формате @username
user_id Integer Да Уникальный идентификатор целевого пользователя

getBusinessConnection

Используйте этот метод, чтобы получить информацию о подключении бота к бизнес-аккаунту. Возвращает BusinessConnection объект в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения

getManagedBotToken

Используйте этот метод, чтобы получить токен управляемого бота. Возвращает токен в виде String в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя управляемого бота, токен которого будет возвращён

replaceManagedBotToken

Используйте этот метод, чтобы отозвать текущий токен управляемого бота и сгенерировать новый. Возвращает новый токен в виде String в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя управляемого бота, чей токен будет заменён

getManagedBotAccessSettings

Используйте этот метод, чтобы получить настройки доступа управляемого бота. Возвращает BotAccessSettings объект в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя управляемого бота, настройки доступа которого будут возвращены

setManagedBotAccessSettings

Используйте этот метод, чтобы изменить настройки доступа управляемого бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя управляемого бота, настройки доступа которого будут изменены
is_access_restricted Boolean Да Передайте True если доступ к боту есть только у выбранных пользователей. Владелец бота всегда имеет к нему доступ.
added_user_ids Array of Integer Необязательное JSON-сериализованный список не более чем из 10 идентификаторов пользователей, которые получат доступ к боту помимо его владельца. Игнорируется, если is_access_restricted is False.

setMyCommands

Используйте этот метод, чтобы изменить список команд бота. См. это руководство для получения подробностей о командах ботов. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
commands Array of BotCommand Да JSON-сериализованный список команд бота, который будет установлен как список команд бота. Может быть указано не более 100 команд.
scope BotCommandScope Необязательное JSON-сериализованный объект, описывающий круг пользователей, для которых актуальны команды. По умолчанию BotCommandScopeDefault.
language_code String Необязательное Двухбуквенный код языка ISO 639-1. Если пусто, команды будут применены ко всем пользователям из данной области, для языка которых нет отдельных команд.

deleteMyCommands

Используйте этот метод, чтобы удалить список команд бота для заданной области и языка пользователя. После удаления команды более высокого уровня будет показано затронутым пользователям. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
scope BotCommandScope Необязательное JSON-сериализованный объект, описывающий круг пользователей, для которых актуальны команды. По умолчанию BotCommandScopeDefault.
language_code String Необязательное Двухбуквенный код языка ISO 639-1. Если пусто, команды будут применены ко всем пользователям из данной области, для языка которых нет отдельных команд.

getMyCommands

Используйте этот метод, чтобы получить текущий список команд бота для заданной области видимости и языка пользователя. Возвращает Array of BotCommand объектов. Если команды не заданы, возвращается пустой список.

Параметр Тип Обязательно Описание
scope BotCommandScope Необязательное JSON-сериализованный объект, описывающий круг пользователей. По умолчанию BotCommandScopeDefault.
language_code String Необязательное Двухбуквенный код языка ISO 639-1 или пустая строка

setMyName

Используйте этот метод, чтобы изменить имя бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
name String Необязательное Новое имя бота; 0-64 символа. Передайте пустую строку, чтобы удалить отдельное имя для данного языка.
language_code String Необязательное Двухбуквенный код языка ISO 639-1. Если пусто, имя будет показано всем пользователям, для языка которых нет отдельного имени.

getMyName

Используйте этот метод, чтобы получить текущее имя бота для заданного языка пользователя. Возвращает BotName в случае успеха.

Параметр Тип Обязательно Описание
language_code String Необязательное Двухбуквенный код языка ISO 639-1 или пустая строка

setMyDescription

Используйте этот метод, чтобы изменить описание бота, которое показывается в чате с ботом, если чат пуст. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
description String Необязательное Новое описание бота; 0-512 символов. Передайте пустую строку, чтобы удалить отдельное описание для данного языка.
language_code String Необязательное Двухбуквенный код языка ISO 639-1. Если пусто, описание будет применено ко всем пользователям, для языка которых нет отдельного описания.

getMyDescription

Используйте этот метод, чтобы получить текущее описание бота для заданного языка пользователя. Возвращает BotDescription в случае успеха.

Параметр Тип Обязательно Описание
language_code String Необязательное Двухбуквенный код языка ISO 639-1 или пустая строка

setMyShortDescription

Используйте этот метод, чтобы изменить краткое описание бота, которое отображается на странице профиля бота и отправляется вместе со ссылкой, когда пользователи делятся ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
short_description String Необязательное Новое краткое описание бота; 0-120 символов. Передайте пустую строку, чтобы удалить отдельное краткое описание для данного языка.
language_code String Необязательное Двухбуквенный код языка ISO 639-1. Если пусто, краткое описание будет применено ко всем пользователям, для языка которых нет отдельного краткого описания.

getMyShortDescription

Используйте этот метод, чтобы получить текущее краткое описание бота для данного языка пользователя. Возвращает BotShortDescription в случае успеха.

Параметр Тип Обязательно Описание
language_code String Необязательное Двухбуквенный код языка ISO 639-1 или пустая строка

setMyProfilePhoto

Изменяет фото профиля бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
photo InputProfilePhoto Да Новое фото профиля, которое нужно установить

removeMyProfilePhoto

Удаляет фото профиля бота. Не требует параметров. Возвращает True в случае успеха.

setChatMenuButton

Используйте этот метод, чтобы изменить кнопку меню бота в приватном чате или кнопку меню по умолчанию. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer Необязательное Уникальный идентификатор целевого личного чата. Если не указан, будет изменена кнопка меню бота по умолчанию.
menu_button MenuButton Необязательное JSON-сериализованный объект новой кнопки меню бота. По умолчанию MenuButtonDefault.

getChatMenuButton

Используйте этот метод, чтобы получить текущее значение кнопки меню бота в личном чате или кнопку меню по умолчанию. Возвращает MenuButton в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer Необязательное Уникальный идентификатор целевого личного чата. Если не указан, будет возвращена кнопка меню бота по умолчанию.

setMyDefaultAdministratorRights

Используйте этот метод, чтобы изменить права администратора по умолчанию, запрашиваемые ботом, когда его добавляют администратором в группы или каналы. Эти права будут предложены пользователям, но они вправе изменить список перед добавлением бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
rights ChatAdministratorRights Необязательное JSON-сериализованный объект, описывающий новые права администратора по умолчанию. Если не указан, права администратора по умолчанию будут очищены.
for_channels Boolean Необязательное Передайте True чтобы изменить права администратора бота по умолчанию в каналах. В противном случае будут изменены права администратора бота по умолчанию для групп и супергрупп.

getMyDefaultAdministratorRights

Используйте этот метод, чтобы получить текущие права администратора бота по умолчанию. Возвращает ChatAdministratorRights в случае успеха.

Параметр Тип Обязательно Описание
for_channels Boolean Необязательное Передайте True чтобы получить права администратора по умолчанию для бота в каналах. В противном случае будут возвращены права администратора по умолчанию для бота в группах и супергруппах.

getAvailableGifts

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

sendGift

Отправляет подарок указанному пользователю или чату канала. Получатель не может конвертировать подарок в Ansible Stars. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Необязательное Обязательно, если chat_id не указан. Уникальный идентификатор целевого пользователя, который получит подарок.
chat_id Integer или String Необязательное Обязательно, если user_id не указан. Уникальный идентификатор чата или имя пользователя канала (в формате @username) который получит подарок.
gift_id String Да Идентификатор подарка; лимитированные подарки нельзя отправлять в чаты каналов
pay_for_upgrade Boolean Необязательное Передайте True чтобы оплатить улучшение подарка с баланса бота, тем самым сделав улучшение бесплатным для получателя
text String Необязательное Текст, который будет показан вместе с подарком; 0-128 символов
text_parse_mode String Необязательное Режим разбора сущностей в тексте. См. варианты форматирования подробнее. Сущности, отличные от “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji” и “date_time”, игнорируются.
text_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, встречающихся в тексте подарка. Может быть указан вместо text_parse_mode. Сущности, кроме «bold», «italic», «underline», «strikethrough», «spoiler», «custom_emoji» и «date_time», игнорируются.

giftPremiumSubscription

Дарит подписку Ansible Premium указанному пользователю. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя, который получит подписку Ansible Premium
month_count Integer Да Количество месяцев, в течение которых подписка Ansible Premium будет активна для пользователя; должно быть одним из значений 3, 6 или 12
star_count Integer Да Количество Ansible Stars для оплаты подписки Ansible Premium; должно быть 1000 за 3 месяца, 1500 за 6 месяцев и 2500 за 12 месяцев
text String Необязательное Текст, который будет показан вместе со служебным сообщением о подписке; 0-128 символов
text_parse_mode String Необязательное Режим разбора сущностей в тексте. См. варианты форматирования подробнее. Сущности, отличные от “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji” и “date_time”, игнорируются.
text_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, встречающихся в тексте подарка. Может быть указан вместо text_parse_mode. Сущности, кроме «bold», «italic», «underline», «strikethrough», «spoiler», «custom_emoji» и «date_time», игнорируются.

verifyUser

Верифицирует пользователя от имени организации, которую представляет бот. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя
custom_description String Необязательное Пользовательское описание для верификации; 0-70 символов. Должно быть пустым, если организации не разрешено предоставлять пользовательское описание верификации.

verifyChat

Верифицирует чат от имени организации, которую представляет бот. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username. Чаты личных сообщений канала не могут быть верифицированы.
custom_description String Необязательное Пользовательское описание для верификации; 0-70 символов. Должно быть пустым, если организации не разрешено предоставлять пользовательское описание верификации.

removeUserVerification

Снимает верификацию с пользователя, который в данный момент верифицирован от имени организации, представляемой ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя

removeChatVerification

Снимает верификацию с чата, который в настоящее время верифицирован от имени организации, представляемой ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота или канала в формате @username

readBusinessMessage

Отмечает входящее сообщение как прочитанное от имени бизнес-аккаунта. Требует can_read_messages право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения, от имени которого нужно прочитать сообщение
chat_id Integer Да Уникальный идентификатор чата, в котором было получено сообщение. Чат должен был быть активен в последние 24 часа.
message_id Integer Да Уникальный идентификатор сообщения, которое нужно отметить как прочитанное

deleteBusinessMessages

Удаляет сообщения от имени бизнес-аккаунта. Требуется can_delete_sent_messages право бизнес-бота удалять сообщения, отправленные самим ботом, или can_delete_all_messages право бизнес-бота удалять любое сообщение. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения, от имени которого нужно удалить сообщения
message_ids Array of Integer Да JSON-сериализованный список из 1-100 идентификаторов сообщений для удаления. Все сообщения должны быть из одного чата. См. deleteMessage об ограничениях на то, какие сообщения могут быть удалены.

setBusinessAccountName

Изменяет имя и фамилию управляемого бизнес-аккаунта. Требует can_change_name право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
first_name String Да Новое значение имени для бизнес-аккаунта; 1-64 символа
last_name String Необязательное Новое значение фамилии для бизнес-аккаунта; 0-64 символа

setBusinessAccountUsername

Изменяет имя пользователя управляемого бизнес-аккаунта. Требует can_change_username право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
username String Необязательное Новое значение имени пользователя для бизнес-аккаунта; 0-32 символа

setBusinessAccountBio

Изменяет биографию управляемого бизнес-аккаунта. Требует can_change_bio право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
bio String Необязательное Новое значение био для бизнес-аккаунта; 0-140 символов

setBusinessAccountProfilePhoto

Изменяет фото профиля управляемого бизнес-аккаунта. Требует can_edit_profile_photo право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
photo InputProfilePhoto Да Новое фото профиля, которое нужно установить
is_public Boolean Необязательное Передайте True чтобы установить публичное фото, которое будет видно, даже если основное фото скрыто настройками приватности бизнес-аккаунта. У аккаунта может быть только одно публичное фото.

removeBusinessAccountProfilePhoto

Удаляет текущее фото профиля управляемого бизнес-аккаунта. Требует can_edit_profile_photo право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
is_public Boolean Необязательное Передайте True чтобы удалить публичное фото, которое видно, даже если основное фото скрыто настройками приватности бизнес-аккаунта. После удаления основного фото предыдущее фото профиля (если есть) становится основным.

setBusinessAccountGiftSettings

Изменяет настройки приватности, относящиеся к входящим подаркам в управляемом бизнес-аккаунте. Требует can_change_gift_settings право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
show_gift_button Boolean Да Передайте True если кнопка отправки подарка пользователю или от имени бизнес-аккаунта должна всегда показываться в поле ввода
accepted_gift_types AcceptedGiftTypes Да Типы подарков, принимаемых бизнес-аккаунтом

getBusinessAccountStarBalance

Возвращает количество Ansible Stars, принадлежащих управляемому бизнес-аккаунту. Требует can_view_gifts_and_stars право бизнес-бота. Возвращает StarAmount в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения

transferBusinessAccountStars

Переводит Ansible Stars с баланса бизнес-аккаунта на баланс бота. Требует права can_transfer_stars право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
star_count Integer Да Количество Ansible Stars для перевода; 1-10000

getBusinessAccountGifts

Возвращает подарки, полученные и принадлежащие управляемому бизнес-аккаунту. Требует can_view_gifts_and_stars право бизнес-бота. Возвращает OwnedGifts в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
exclude_unsaved Boolean Необязательное Передайте True чтобы исключить подарки, которые не сохранены на странице профиля аккаунта
exclude_saved Boolean Необязательное Передайте True чтобы исключить подарки, сохранённые на странице профиля аккаунта
exclude_unlimited Boolean Необязательное Передайте True чтобы исключить подарки, которые можно приобрести неограниченное количество раз
exclude_limited_upgradable Boolean Необязательное Передайте True чтобы исключить подарки, которые можно купить ограниченное число раз и которые могут быть улучшены до уникальных
exclude_limited_non_upgradable Boolean Необязательное Передайте True чтобы исключить подарки, которые можно купить ограниченное число раз и которые нельзя улучшить до уникальных
exclude_unique Boolean Необязательное Передайте True чтобы исключить уникальные подарки
exclude_from_blockchain Boolean Необязательное Передайте True чтобы исключить подарки, которые были присвоены из блокчейна TON и не могут быть перепроданы или переданы в Ansible
sort_by_price Boolean Необязательное Передайте True чтобы отсортировать результаты по цене подарка, а не по дате отправки. Сортировка применяется до пагинации.
offset String Необязательное Смещение первой возвращаемой записи, полученное из предыдущего запроса; используйте пустую строку, чтобы получить первую порцию результатов
limit Integer Необязательное Максимальное количество возвращаемых подарков; 1-100. По умолчанию 100.

getUserGifts

Возвращает подарки, которыми владеет и которые размещает пользователь. Возвращает OwnedGifts в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор пользователя
exclude_unlimited Boolean Необязательное Передайте True чтобы исключить подарки, которые можно приобрести неограниченное количество раз
exclude_limited_upgradable Boolean Необязательное Передайте True чтобы исключить подарки, которые можно купить ограниченное число раз и которые могут быть улучшены до уникальных
exclude_limited_non_upgradable Boolean Необязательное Передайте True чтобы исключить подарки, которые можно купить ограниченное число раз и которые нельзя улучшить до уникальных
exclude_from_blockchain Boolean Необязательное Передайте True чтобы исключить подарки, которые были присвоены из блокчейна TON и не могут быть перепроданы или переданы в Ansible
exclude_unique Boolean Необязательное Передайте True чтобы исключить уникальные подарки
sort_by_price Boolean Необязательное Передайте True чтобы отсортировать результаты по цене подарка, а не по дате отправки. Сортировка применяется до пагинации.
offset String Необязательное Смещение первой возвращаемой записи, полученное из предыдущего запроса; используйте пустую строку, чтобы получить первую порцию результатов
limit Integer Необязательное Максимальное количество возвращаемых подарков; 1-100. По умолчанию 100.

getChatGifts

Возвращает подарки, принадлежащие чату. Возвращает OwnedGifts в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого канала в формате @username
exclude_unsaved Boolean Необязательное Передайте True чтобы исключить подарки, которые не сохранены на странице профиля чата. Всегда True, если только у бота нет can_post_messages право администратора в канале.
exclude_saved Boolean Необязательное Передайте True чтобы исключить подарки, сохранённые на странице профиля чата. Всегда False, если только у бота нет can_post_messages право администратора в канале.
exclude_unlimited Boolean Необязательное Передайте True чтобы исключить подарки, которые можно приобрести неограниченное количество раз
exclude_limited_upgradable Boolean Необязательное Передайте True чтобы исключить подарки, которые можно купить ограниченное число раз и которые могут быть улучшены до уникальных
exclude_limited_non_upgradable Boolean Необязательное Передайте True чтобы исключить подарки, которые можно купить ограниченное число раз и которые нельзя улучшить до уникальных
exclude_from_blockchain Boolean Необязательное Передайте True чтобы исключить подарки, которые были присвоены из блокчейна TON и не могут быть перепроданы или переданы в Ansible
exclude_unique Boolean Необязательное Передайте True чтобы исключить уникальные подарки
sort_by_price Boolean Необязательное Передайте True чтобы отсортировать результаты по цене подарка, а не по дате отправки. Сортировка применяется до пагинации.
offset String Необязательное Смещение первой возвращаемой записи, полученное из предыдущего запроса; используйте пустую строку, чтобы получить первую порцию результатов
limit Integer Необязательное Максимальное количество возвращаемых подарков; 1-100. По умолчанию 100.

convertGiftToStars

Преобразует указанный обычный подарок в Ansible Stars. Требует can_convert_gifts_to_stars право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
owned_gift_id String Да Уникальный идентификатор обычного подарка, который должен быть конвертирован в Ansible Stars

upgradeGift

Улучшает заданный обычный подарок до уникального подарка. Требует can_transfer_and_upgrade_gifts право бизнес-бота. Дополнительно требуется can_transfer_stars право бизнес-бота, если улучшение платное. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
owned_gift_id String Да Уникальный идентификатор обычного подарка, который нужно улучшить до уникального
keep_original_details Boolean Необязательное Передайте True чтобы сохранить исходный текст подарка, отправителя и получателя в улучшенном подарке
star_count Integer Необязательное Количество Ansible Stars, которое будет списано за улучшение с баланса бизнес-аккаунта. Если gift.prepaid_upgrade_star_count > 0, то передайте 0, в противном случае can_transfer_stars право бизнес-бота обязательно, и gift.upgrade_star_count должен быть передан.

transferGift

Передаёт принадлежащий вам уникальный подарок другому пользователю. Требует can_transfer_and_upgrade_gifts право бизнес-бота. Требует can_transfer_stars право бизнес-бота, если передача платная. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
owned_gift_id String Да Уникальный идентификатор обычного подарка, который должен быть передан
new_owner_chat_id Integer Да Уникальный идентификатор чата, которому будет принадлежать подарок. Чат должен быть активен в последние 24 часа.
star_count Integer Необязательное Количество Ansible Stars, которое будет уплачено за перевод с баланса бизнес-аккаунта. Если положительное, то can_transfer_stars требуется право бизнес-бота.

postStory

Публикует историю от имени управляемого бизнес-аккаунта. Требуется can_manage_stories право бизнес-бота. Возвращает Story в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
content InputStoryContent Да Содержимое истории
active_period Integer Да Период, через который история перемещается в архив, в секундах; должен быть одним из 6 * 3600, 12 * 3600, 86400, or 2 * 86400
caption String Необязательное Подпись истории, 0-2048 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к истории. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
areas Array of StoryArea Необязательное JSON-сериализованный список кликабельных областей, которые будут показаны в истории
post_to_chat_page Boolean Необязательное Передайте True чтобы история оставалась доступной после истечения срока её действия
protect_content Boolean Необязательное Передайте True если содержимое истории должно быть защищено от пересылки и снятия скриншотов

repostStory

Репостит историю от имени бизнес-аккаунта из другого бизнес-аккаунта. Оба бизнес-аккаунта должны управляться одним и тем же ботом, а история в исходном аккаунте должна быть опубликована (или репостнута) этим ботом. Требует can_manage_stories право бизнес-бота для обоих бизнес-аккаунтов. Возвращает Story в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
from_chat_id Integer Да Уникальный идентификатор чата, опубликовавшего историю, которую нужно репостнуть
from_story_id Integer Да Уникальный идентификатор истории, которую нужно репостнуть
active_period Integer Да Период, через который история перемещается в архив, в секундах; должен быть одним из 6 * 3600, 12 * 3600, 86400, or 2 * 86400
post_to_chat_page Boolean Необязательное Передайте True чтобы история оставалась доступной после истечения срока её действия
protect_content Boolean Необязательное Передайте True если содержимое истории должно быть защищено от пересылки и снятия скриншотов

editStory

Изменяет историю, ранее опубликованную ботом от имени управляемого бизнес-аккаунта. Требует can_manage_stories право бизнес-бота. Возвращает Story в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
story_id Integer Да Уникальный идентификатор редактируемой истории
content InputStoryContent Да Содержимое истории
caption String Необязательное Подпись истории, 0-2048 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к истории. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
areas Array of StoryArea Необязательное JSON-сериализованный список кликабельных областей, которые будут показаны в истории

deleteStory

Удаляет историю, ранее опубликованную ботом от имени управляемого бизнес-аккаунта. Требует can_manage_stories право бизнес-бота. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения
story_id Integer Да Уникальный идентификатор истории для удаления

answerWebAppQuery

Используйте этот метод, чтобы задать результат взаимодействия с Web App и отправить соответствующее сообщение от имени пользователя в чат, из которого поступил запрос. В случае успеха SentWebAppMessage объект возвращается.

Параметр Тип Обязательно Описание
web_app_query_id String Да Уникальный идентификатор запроса, на который нужно ответить
result InlineQueryResult Да JSON-сериализованный объект, описывающий отправляемое сообщение

savePreparedInlineMessage

Сохраняет сообщение, которое может быть отправлено пользователем Mini App. Возвращает PreparedInlineMessage объект.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя, который может использовать подготовленное сообщение
result InlineQueryResult Да JSON-сериализованный объект, описывающий отправляемое сообщение
allow_user_chats Boolean Необязательное Передайте True если сообщение можно отправлять в личные чаты с пользователями
allow_bot_chats Boolean Необязательное Передайте True если сообщение можно отправить в личные чаты с ботами
allow_group_chats Boolean Необязательное Передайте True если сообщение можно отправить в группы и супергруппы
allow_channel_chats Boolean Необязательное Передайте True если сообщение может быть отправлено в чаты каналов

savePreparedKeyboardButton

Сохраняет кнопку клавиатуры, которую пользователь может использовать внутри Mini App. Возвращает PreparedKeyboardButton объект.

Параметр Тип Обязательно Описание
user_id Integer Да Уникальный идентификатор целевого пользователя, который может использовать кнопку
кнопка KeyboardButton Да JSON-сериализованный объект, описывающий сохраняемую кнопку. Кнопка должна быть типа request_users, request_chat, or request_managed_bot.

Методы inline-режима

Методы и объекты, используемые в inline-режиме, описаны в Раздел inline-режима.

Обновление сообщений

Следующие методы позволяют изменить существующее сообщение в истории сообщений вместо отправки нового с результатом действия. Это особенно полезно для сообщений с инлайн-клавиатуры с помощью callback-запросов, но также может помочь уменьшить беспорядок в переписках с обычными чат-ботами.

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

editMessageText

Используйте этот метод, чтобы редактировать текстовые, rich- и game сообщения. В случае успеха, если отредактированное сообщение не является инлайн-сообщением, отредактированное Message возвращается, иначе True возвращается. Обратите внимание, что бизнес-сообщения, которые были отправлены не ботом и не содержат inline-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор сообщения для редактирования.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.
text String Необязательное Новый текст сообщения, 1-4096 символов после разбора сущностей; обязателен, если rich_message не указан
parse_mode String Необязательное Режим разбора сущностей в тексте сообщения. См. варианты форматирования подробнее.
entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в тексте сообщения, который может быть указан вместо parse_mode
link_preview_options LinkPreviewOptions Необязательное Параметры генерации предпросмотра ссылки для сообщения
rich_message InputRichMessage Необязательное Новое форматированное содержимое сообщения; обязательно, если text не указан. Прямая загрузка новых файлов не поддерживается при редактировании inline-сообщения.
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

editMessageCaption

Используйте этот метод, чтобы изменять подписи сообщений. В случае успеха, если изменённое сообщение не является inline-сообщением, изменённое Message возвращается, иначе True возвращается. Обратите внимание, что бизнес-сообщения, которые были отправлены не ботом и не содержат inline-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор сообщения для редактирования.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.
caption String Необязательное Новая подпись сообщения, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к сообщению. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
show_caption_above_media Boolean Необязательное Передайте True если подпись должна отображаться над медиа сообщения. Поддерживается только для сообщений с анимацией, фотографией и видео.
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

editMessageMedia

Используйте этот метод, чтобы редактировать сообщения с анимацией, аудио, документом, live-фото, фото или видео либо чтобы заменить текстовое или rich-сообщение на медиа. Если сообщение является частью альбома сообщений, то оно может быть изменено только на аудио для аудиоальбомов, только на документ для альбомов документов и на фото, live-фото или видео в остальных случаях. При редактировании inline-сообщения новый файл загрузить нельзя; используйте ранее загруженный файл через его file_id или укажите URL. В случае успеха, если отредактированное сообщение не является inline-сообщением, отредактированное Message возвращается, иначе True возвращается. Обратите внимание, что бизнес-сообщения, которые были отправлены не ботом и не содержат inline-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор сообщения для редактирования.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.
media InputMedia Да JSON-сериализованный объект нового медиасодержимого сообщения
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для нового inline-клавиатура

editMessageLiveLocation

Используйте этот метод для редактирования сообщений с трансляцией местоположения. Местоположение можно редактировать, пока не истекло его live_period истекает или редактирование явно отключено вызовом stopMessageLiveLocation. В случае успеха, если отредактированное сообщение не является inline-сообщением, отредактированное Message возвращается, иначе True возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор сообщения для редактирования.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.
latitude Float Да Широта новой локации
longitude Float Да Долгота нового местоположения
live_period Integer Необязательное Новый период в секундах, в течение которого можно обновлять локацию, начиная с даты отправки сообщения. Если указано 0x7FFFFFFF, то локацию можно обновлять бесконечно. В противном случае новое значение не должно превышать текущий live_period более чем на день, и срок истечения трансляции местоположения должен оставаться в пределах ближайших 90 дней. Если не указано, то live_period остаётся без изменений.
horizontal_accuracy Float Необязательное Радиус неопределённости местоположения в метрах; 0-1500
heading Integer Необязательное Направление, в котором движется пользователь, в градусах. Если указано, должно быть от 1 до 360.
proximity_alert_radius Integer Необязательное Максимальное расстояние для оповещений о приближении к другому участнику чата, в метрах. Если указано, должно быть от 1 до 100000.
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для нового inline-клавиатура

stopMessageLiveLocation

Используйте этот метод, чтобы прекратить обновление сообщения с трансляцией геопозиции до истечения live_period истекает. В случае успеха, если сообщение не является inline-сообщением, отредактированное Message возвращается, иначе True возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор сообщения с трансляцией местоположения, которую нужно остановить.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для нового inline-клавиатура

editMessageChecklist

Используйте этот метод, чтобы отредактировать чек-лист от имени подключённого бизнес-аккаунта. В случае успеха отредактированное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Да Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевого бота в формате @username
message_id Integer Да Уникальный идентификатор целевого сообщения
чек-лист InputChecklist Да JSON-сериализованный объект для нового чек-листа
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для нового inline-клавиатура для сообщения

editMessageReplyMarkup

Используйте этот метод, чтобы отредактировать только reply markup сообщений. В случае успеха, если отредактированное сообщение не является инлайн-сообщением, возвращается отредактированное Message возвращается, иначе True возвращается. Обратите внимание, что бизнес-сообщения, которые были отправлены не ботом и не содержат inline-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор сообщения для редактирования.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

stopPoll

Используйте этот метод, чтобы остановить опрос, отправленный ботом. В случае успеха остановленный Poll возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого было отправлено редактируемое сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_id Integer Да Идентификатор исходного сообщения с опросом
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для нового сообщения inline-клавиатура

editEphemeralMessageText

Используйте этот метод для редактирования эфемерного текстового сообщения. Учтите, что не гарантируется, что пользователь получит событие редактирования сообщения, особенно если он офлайн. В случае успеха True возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
receiver_user_id Integer Да Идентификатор пользователя, получившего сообщение
ephemeral_message_id Integer Да Идентификатор временного сообщения для редактирования
text String Да Новый текст сообщения, 1-4096 символов после разбора сущностей
parse_mode String Необязательное Режим разбора сущностей в тексте сообщения. См. варианты форматирования подробнее.
entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в тексте сообщения, который может быть указан вместо parse_mode
link_preview_options LinkPreviewOptions Необязательное Параметры генерации предпросмотра ссылки для сообщения
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

editEphemeralMessageMedia

Используйте этот метод, чтобы изменить медиа эфемерного сообщения. Обратите внимание, что получение пользователем события редактирования сообщения не гарантируется, особенно если он офлайн. В случае успеха True возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
receiver_user_id Integer Да Идентификатор пользователя, получившего сообщение
ephemeral_message_id Integer Да Идентификатор временного сообщения для редактирования
media InputMedia Да JSON-сериализованный объект нового медиаконтента сообщения. Новый файл загрузить нельзя; используйте ранее загруженный файл по его file_id или укажите URL.
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

editEphemeralMessageCaption

Используйте этот метод, чтобы отредактировать подпись эфемерного сообщения. Обратите внимание, что не гарантируется, что пользователь получит событие редактирования сообщения, особенно если он не в сети. В случае успеха True возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
receiver_user_id Integer Да Идентификатор пользователя, получившего сообщение
ephemeral_message_id Integer Да Идентификатор временного сообщения для редактирования
caption String Необязательное Новая подпись сообщения, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное Режим разбора сущностей в подписи к сообщению. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное JSON-сериализованный список специальных сущностей, которые встречаются в подписи; его можно указать вместо parse_mode
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

editEphemeralMessageReplyMarkup

Используйте этот метод, чтобы отредактировать только reply markup эфемерного сообщения. Учтите, что получение пользователем события редактирования сообщения не гарантируется, особенно если он не в сети. В случае успеха True возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
receiver_user_id Integer Да Идентификатор пользователя, получившего сообщение
ephemeral_message_id Integer Да Идентификатор временного сообщения для редактирования
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура

approveSuggestedPost

Используйте этот метод, чтобы одобрить предложенный пост в чате личных сообщений. Бот должен иметь право администратора 'can_post_messages' в соответствующем чате канала. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer Да Уникальный идентификатор целевого чата прямых сообщений
message_id Integer Да Идентификатор сообщения предложенного поста, который нужно одобрить
send_date Integer Необязательное Момент времени (Unix timestamp), когда ожидается публикация поста; опустите, если дата уже была указана при создании предложенного поста. Если указано, то дата должна быть не более чем на 2678400 секунд (30 дней) в будущем.

declineSuggestedPost

Используйте этот метод, чтобы отклонить предложенный пост в чате прямых сообщений. Бот должен иметь право администратора 'can_manage_direct_messages' в соответствующем чате канала. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer Да Уникальный идентификатор целевого чата прямых сообщений
message_id Integer Да Идентификатор сообщения предложенного поста, который нужно отклонить
comment String Необязательное Комментарий для создателя предложенного поста; 0-128 символов

deleteMessage

Используйте этот метод, чтобы удалить сообщение, включая служебные сообщения, со следующими ограничениями:
- Сообщение может быть удалено, только если оно было отправлено менее 48 часов назад.
- Служебные сообщения о создании супергруппы, канала или темы форума удалить нельзя.
- Сообщение с кубиком в личном чате можно удалить, только если оно было отправлено более 24 часов назад.
- Боты могут удалять исходящие сообщения в личных чатах, группах и супергруппах.
- Боты могут удалять входящие сообщения в личных чатах.
- Боты, которым предоставлено can_post_messages разрешениями могут удалять исходящие сообщения в каналах.
- Если бот является администратором группы, он может удалить в ней любое сообщение.
- Если у бота есть can_delete_messages право администратора в супергруппе или канале, он может удалить там любое сообщение.
- Если у бота есть can_manage_direct_messages право администратора в канале, он может удалить любое сообщение в соответствующем чате личных сообщений.
Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_id Integer Да Идентификатор сообщения для удаления

deleteMessages

Используйте этот метод, чтобы удалить несколько сообщений одновременно. Если какие-то из указанных сообщений не найдены, они пропускаются. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_ids Array of Integer Да JSON-сериализованный список из 1-100 идентификаторов сообщений для удаления. См. deleteMessage об ограничениях на то, какие сообщения могут быть удалены.

deleteEphemeralMessage

Используйте этот метод, чтобы удалить временное сообщение. Обратите внимание, что не гарантируется, что пользователь получит событие удаления сообщения, особенно если он не в сети. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
receiver_user_id Integer Да Идентификатор пользователя, получившего сообщение
ephemeral_message_id Integer Да Идентификатор эфемерного сообщения, которое нужно удалить

deleteMessageReaction

Используйте этот метод, чтобы удалить реакцию с сообщения в группе или супергруппе. Бот должен иметь право администратора 'can_delete_messages' в этом чате. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
message_id Integer Да Идентификатор целевого сообщения
user_id Integer Необязательное Идентификатор пользователя, чья реакция будет удалена, если реакция была добавлена пользователем
actor_chat_id Integer Необязательное Идентификатор чата, реакция которого будет удалена, если реакция была добавлена чатом

deleteAllMessageReactions

Используйте этот метод, чтобы удалить до 10000 недавних реакций в группе или супергруппе, добавленных данным пользователем или чатом. Бот должен иметь право администратора 'can_delete_messages' в этом чате. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевой супергруппы в формате @username
user_id Integer Необязательное Идентификатор пользователя, реакции которого будут удалены, если реакции были добавлены пользователем
actor_chat_id Integer Необязательное Идентификатор чата, реакции которого будут удалены, если реакции были добавлены чатом

Стикеры

Следующие методы и объекты позволяют вашему боту работать со стикерами и наборами стикеров.

Sticker

Этот объект представляет стикер.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
type String Тип стикера, в настоящее время один из «regular», «mask», «custom_emoji». Тип стикера не зависит от его формата, который определяется полями is_animated и is_video.
width Integer Ширина стикера
height Integer Высота стикера
is_animated Boolean True, если стикер анимированный
is_video Boolean True, если стикер является видеостикером
thumbnail PhotoSize Необязательное. Миниатюра стикера в формате .WEBP или .JPG
emoji String Необязательное. Эмодзи, связанный со стикером
set_name String Необязательное. Название набора стикеров, которому принадлежит стикер
premium_animation File Необязательное. Для обычных премиум-стикеров — премиум-анимация стикера
mask_position MaskPosition Необязательное. Для стикеров-масок — позиция, в которой должна располагаться маска
custom_emoji_id String Необязательное. Для стикеров с пользовательскими эмодзи — уникальный идентификатор пользовательского эмодзи
needs_repainting True Необязательное. True, если стикер должен быть перекрашен в цвет текста в сообщениях, в цвет значка Ansible Premium в эмодзи-статусе, в белый цвет на фотографиях чатов или в другой подходящий цвет в остальных местах
file_size Integer Необязательное. Размер файла в байтах

StickerSet

Этот объект представляет набор стикеров.

Поле Тип Описание
name String Название набора стикеров
title String Название набора стикеров
sticker_type String Тип стикеров в наборе, в настоящее время один из «regular», «mask», «custom_emoji»
стикеры Array of Sticker Список всех стикеров набора
thumbnail PhotoSize Необязательное. Миниатюра набора стикеров в формате .WEBP, .TGS или .WEBM

MaskPosition

Этот объект описывает положение на лицах, где по умолчанию должна размещаться маска.

Поле Тип Описание
point String Часть лица, относительно которой должна располагаться маска. Одно из «forehead», «eyes», «mouth» или «chin».
x_shift Float Сдвиг по оси X, измеряемый в ширинах маски, масштабированной под размер лица, слева направо. Например, значение -1.0 разместит маску сразу слева от позиции маски по умолчанию.
y_shift Float Сдвиг по оси Y, измеряемый в высотах маски, масштабированной под размер лица, сверху вниз. Например, 1.0 разместит маску сразу под позицией маски по умолчанию.
scale Float Коэффициент масштабирования маски. Например, 2.0 означает двойной размер.

InputSticker

Этот объект описывает стикер, который будет добавлен в набор стикеров.

Поле Тип Описание
sticker String Добавленный стикер. Передайте file_id как String, чтобы отправить файл, который уже есть на серверах Ansible, передайте HTTP URL как String, чтобы Ansible получил файл из интернета, или передайте «attach://<file_attach_name>», чтобы загрузить новый файл с помощью multipart/form-data под именем <file_attach_name>. Анимированные и видеостикеры нельзя загрузить по HTTP URL. Подробнее об отправке файлов »
format String Формат добавляемого стикера, должен быть одним из: “static” для .WEBP or .PNG изображение, «animated» для .TGS анимации, «video» для .WEBM video
emoji_list Array of String Список из 1-20 эмодзи, связанных со стикером
mask_position MaskPosition Необязательное. Позиция, в которую маска должна помещаться на лицах. Только для стикеров «mask».
keywords Array of String Необязательное. Список из 0-20 ключевых слов для поиска стикера общей длиной до 64 символов. Только для стикеров «regular» и «custom_emoji».

sendSticker

Используйте этот метод, чтобы отправлять статичные .WEBP, анимированные .TGS или видео .WEBM стикеры. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
receiver_user_id Integer Необязательное Для исходящих эфемерных сообщений — уникальный идентификатор пользователя, который получит сообщение; только для групповых чатов и супергрупп. Не гарантируется, что пользователь получит сообщение, особенно если он не в сети. См. отправка эфемерных сообщений подробнее.
callback_query_id String Необязательное Для исходящих эфемерных сообщений — идентификатор callback query, который вызвал сообщение, если он есть
sticker InputFile или String Да Стикер для отправки. Передайте file_id в виде String, чтобы отправить файл, который уже есть на серверах Ansible (рекомендуется), передайте HTTP URL в виде String, чтобы Ansible получил стикер .WEBP из интернета, или загрузите новый стикер .WEBP, .TGS или .WEBM с помощью multipart/form-data. Подробнее об отправке файлов ». Видео- и анимированные стикеры нельзя отправить по HTTP URL.
emoji String Необязательное Эмодзи, связанные со стикером; только для только что загруженных стикеров
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

getStickerSet

Используйте этот метод, чтобы получить набор стикеров. В случае успеха StickerSet объект возвращается.

Параметр Тип Обязательно Описание
name String Да Название стикерпака

getCustomEmojiStickers

Используйте этот метод, чтобы получить информацию о стикерах с кастомными эмодзи по их идентификаторам. Возвращает Array of Sticker объекты.

Параметр Тип Обязательно Описание
custom_emoji_ids Array of String Да JSON-сериализованный список идентификаторов кастомных эмодзи. Можно указать не более 200 идентификаторов кастомных эмодзи.

uploadStickerFile

Используйте этот метод, чтобы загрузить файл со стикером для последующего использования в createNewStickerSet, addStickerToSet, or replaceStickerInSet методы (файл можно использовать несколько раз). Возвращает загруженный File в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя — владельца файла стикера
sticker InputFile Да Файл со стикером в формате .WEBP, .PNG, .TGS или .WEBM. См. https://core.ansible.su/stickers с техническими требованиями. Подробнее об отправке файлов »
sticker_format String Да Формат стикера, должен быть одним из “static”, “animated”, “video”

createNewStickerSet

Используйте этот метод, чтобы создать новый набор стикеров, принадлежащий пользователю. Бот сможет редактировать созданный таким образом набор стикеров. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя — владельца создаваемого стикерпака
name String Да Короткое имя набора стикеров, которое будет использоваться в asme.su/addstickers/ URL (например, животные). Может содержать только английские буквы, цифры и знаки подчёркивания. Должно начинаться с буквы, не может содержать идущие подряд знаки подчёркивания и должно заканчиваться на "_by_<bot_username>". <bot_username> нечувствительно к регистру. 1-64 символа.
title String Да Название набора стикеров, 1-64 символа
стикеры Array of InputSticker Да JSON-сериализованный список из 1-50 начальных стикеров, которые будут добавлены в набор стикеров
sticker_type String Необязательное Тип стикеров в наборе, передайте «regular», «mask» или «custom_emoji». По умолчанию создаётся обычный набор стикеров.
needs_repainting Boolean Необязательное Передайте True если стикеры в наборе должны перекрашиваться в цвет текста при использовании в сообщениях, в акцентный цвет при использовании в качестве эмодзи-статуса, в белый на фото чатов или в другой подходящий цвет в зависимости от контекста; только для наборов кастомных эмодзи-стикеров

addStickerToSet

Используйте этот метод, чтобы добавить новый стикер в набор, созданный ботом. Наборы эмодзи-стикеров могут содержать до 200 стикеров. Другие наборы стикеров могут содержать до 120 стикеров. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя — владельца набора стикеров
name String Да Название набора стикеров
sticker InputSticker Да JSON-сериализованный объект с информацией о добавляемом стикере. Если точно такой же стикер уже был добавлен в набор, то набор не изменяется.

setStickerPositionInSet

Используйте этот метод, чтобы переместить стикер в наборе, созданном ботом, на определённую позицию. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
sticker String Да Идентификатор файла стикера
position Integer Да Новая позиция стикера в наборе, отсчёт с нуля

deleteStickerFromSet

Используйте этот метод, чтобы удалить стикер из набора, созданного ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
sticker String Да Идентификатор файла стикера

replaceStickerInSet

Используйте этот метод, чтобы заменить существующий стикер в наборе стикеров на новый. Метод эквивалентен вызову deleteStickerFromSet, затем addStickerToSet, затем setStickerPositionInSet. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя — владельца набора стикеров
name String Да Название набора стикеров
old_sticker String Да Идентификатор файла заменяемого стикера
sticker InputSticker Да JSON-сериализованный объект с информацией о добавленном стикере. Если точно такой же стикер уже был добавлен в набор, то набор остаётся без изменений.

setStickerEmojiList

Используйте этот метод, чтобы изменить список эмодзи, назначенных обычному стикеру или стикеру с кастомным эмодзи. Стикер должен принадлежать набору стикеров, созданному ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
sticker String Да Идентификатор файла стикера
emoji_list Array of String Да JSON-сериализованный список из 1-20 эмодзи, связанных со стикером

setStickerKeywords

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

Параметр Тип Обязательно Описание
sticker String Да Идентификатор файла стикера
keywords Array of String Необязательное JSON-сериализованный список из 0-20 поисковых ключевых слов для стикера общей длиной до 64 символов

setStickerMaskPosition

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

Параметр Тип Обязательно Описание
sticker String Да Идентификатор файла стикера
mask_position MaskPosition Необязательное JSON-сериализованный объект с позицией, в которой маска должна быть размещена на лицах. Опустите параметр, чтобы удалить позицию маски.

setStickerSetTitle

Используйте этот метод, чтобы задать название созданного набора стикеров. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
name String Да Название набора стикеров
title String Да Название набора стикеров, 1-64 символа

setStickerSetThumbnail

Используйте этот метод, чтобы задать миниатюру обычного набора стикеров или набора масок. Формат файла миниатюры должен соответствовать формату стикеров в наборе. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
name String Да Название набора стикеров
user_id Integer Да Идентификатор пользователя — владельца набора стикеров
thumbnail InputFile или String Необязательное A .WEBP or .PNG изображение с миниатюрой, размер должен быть не более 128 килобайт, а ширина и высота — ровно 100px, либо .TGS анимация с миниатюрой размером до 32 килобайт (см. https://core.ansible.su/stickers#animation-requirements с техническими требованиями к анимированным стикерам), или .WEBM видео с миниатюрой размером до 32 килобайт; см. https://core.ansible.su/stickers#video-requirements о технических требованиях к видеостикерам. Передайте file_id в виде String, чтобы отправить файл, который уже есть на серверах Ansible, передайте HTTP URL в виде String, чтобы Ansible получил файл из интернета, или загрузите новый с помощью multipart/form-data. Подробнее об отправке файлов ». Миниатюры анимированных и видеонаборов стикеров нельзя загрузить по HTTP URL. Если не указано, миниатюра удаляется и в качестве миниатюры используется первый стикер.
format String Да Формат миниатюры, должен быть одним из “static” для .WEBP or .PNG изображение, «animated» для .TGS анимации, или “video” для .WEBM video

setCustomEmojiStickerSetThumbnail

Используйте этот метод, чтобы задать миниатюру набора кастомных эмодзи-стикеров. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
name String Да Название набора стикеров
custom_emoji_id String Необязательное Идентификатор пользовательского эмодзи стикера из набора стикеров; передайте пустую строку, чтобы убрать миниатюру и использовать в качестве миниатюры первый стикер

deleteStickerSet

Используйте этот метод, чтобы удалить набор стикеров, созданный ботом. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
name String Да Название набора стикеров

Rich-сообщения

Следующие методы и объекты позволяют вашему боту обрабатывать и отправлять расширенные сообщения.

Параметры форматирования расширенных сообщений

Rich-сообщения поддерживают расширенные возможности структурированного форматирования, такие как заголовки, списки, таблицы, медиа, блочные цитаты, сворачиваемые блоки, сноски и формулы. Клиенты Ansible будут отображать их соответствующим образом. Вы можете задать содержимое rich-сообщения с помощью в стиле Markdown or HTML-стиль форматирование или явные blocks.

Обычные URL, адреса электронной почты, упоминания имён пользователей, хештеги, кештеги, команды ботов, номера телефонов и номера банковских карт определяются автоматически. Чтобы отключить автоматическое определение сущностей, передайте True в skip_entity_detection поле. Обратите внимание, что клиенты Ansible покажут пользователю предупреждение перед открытием inline-ссылки («Открыть эту ссылку?» вместе с полным URL).

Когда в стиле Markdown or HTML-стиль используется форматирование, вы можете использовать ссылки вида as://photo?id=..., as://video?id=..., и as://audio?id=... вместо HTTP URL, чтобы переиспользовать ранее загруженные файлы или загрузить новый файл.

Ограничения Rich Message

На rich-сообщения распространяются следующие ограничения:

  • Up to 32768 символов UTF-8 в тексте rich-сообщения, включая альтернативный текст кастомных эмодзи и исходный код формулы.
  • Up to 500 блоков, включая вложенные блоки, элементы списка, элементы нумерованного списка, строки таблицы, блоки цитат и блоки details.
  • Up to 16 уровней вложенного форматирования и блоков.
  • Up to 50 медиавложений в общей сложности, включая фотографии, видео и аудиофайлы.
  • Up to 20 столбцов в таблице.
Стиль Rich Markdown

Чтобы использовать этот режим, передайте rich-содержимое сообщения в markdown поле. Используйте в своём сообщении следующий синтаксис:

**bold text** __bold text__ *italic text* _italic text_ ~~strikethrough text~~ `inline fixed-width code` ==marked text== ||spoiler|| [inline URL](https://asme.su/) [inline e-mail](mailto:user@example.com) [inline phone number](tel:+123456789) [inline mention of a user](as://user?id=123456789) ![👍](as://emoji?id=5368324170671202286) ![22:45 tomorrow](as://time?unix=1647531900&format=wDT) $x^2 + y^2$ \#hashtag $USD +12345678901, card: 4242 4242 4242 4242, https://asme.su asme.su a@asme.su /command @username all the text above was on the same line # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6 Paragraph text ```python print('pre-formatted fixed-width code block written in the Python programming language') ``` --- - unordered list item * unordered list item + unordered list item 1. ordered list item 2. ordered list item - [ ] task list item - [x] completed task list item >Block quotation started > >Block quotation continued on the next line >Block quotation continued on the same line > >The last line of the block quotation ![](https://ansible.su/example/photo.jpg) ![](https://ansible.su/example/video.mp4) ![](https://ansible.su/example/audio.mp3) ![](https://ansible.su/example/audio.ogg) ![](https://ansible.su/example/animation.gif) ![](https://ansible.su/example/photo.jpg "Photo caption") ![](https://ansible.su/example/video.mp4 "Video caption") ![](https://ansible.su/example/audio.mp3 "Audio caption") ![](https://ansible.su/example/audio.ogg "Voice note caption") ![](https://ansible.su/example/animation.gif "Animation caption") | Header 1 | Header 2 | |:---------|:--------:| | left | center | Text with a reference[^id1] and another one[^id2]. [^id1]: Definition of the first footnote. [^id2]: Definition of the second footnote. $$E = mc^2$$ ```math E = mc^2 ``` ## Example Nested Syntax Report for _Q1_ Intro with <u>underlined text</u>, ==marked text==, and $x^2 + y^2$. **Bold _italic <u>underlined italic bold</u> italic_ bold** <u>In inline tags, nested **markdown** is parsed</u> >Quote with **bold text, ~~strikethrough, and <tg-spoiler>spoiler</tg-spoiler>~~**, plus [a link](https://asme.su/). - List item with `code`, <sup>superscript</sup>, <sub>subscript</sub>, and a footnote[^note] - Another item with **bold <tg-spoiler><code>spoiler code</code></tg-spoiler>** - Another item with ~~strikethrough and <ins>inserted text</ins>~~ | Metric | Value | |:-------|------:| | Speed | **42** <sup>ms</sup> | | Status | <tg-spoiler>ready</tg-spoiler> | [^note]: Footnote with _italic text_ and <u>HTML underline</u>. --- # Details blocks can contain Markdown content: <details open><summary>Summary with **bold text**</summary> ### Details heading - List item with _italic text_ - List item with <tg-spoiler>spoiler</tg-spoiler> </details> # Collages and slideshows can contain Markdown media blocks: <tg-collage> ![](https://ansible.su/example/photo.jpg) ![](https://ansible.su/example/video.mp4) </tg-collage> <tg-slideshow> ![](https://ansible.su/example/photo.jpg) ![](https://ansible.su/example/video.mp4) </tg-slideshow>

Для возможностей форматирования, у которых нет синтаксиса Markdown, используйте HTML-теги:

<u>underlined text</u>, <ins>underlined text</ins> <sub>subscript text</sub> <sup>superscript text</sup> <a name="chapter-1"></a> <aside>Pull quote<cite>The Author</cite></aside> <details open><summary>Title</summary>Content</details> <tg-map lat="41.9" long="12.5" zoom="14"/> <tg-collage><img src="https://ansible.su/example/photo.jpg"/><figcaption>Caption<cite>The Author</cite></figcaption></tg-collage> <tg-slideshow><img src="https://ansible.su/example/photo.jpg"/><video src="https://ansible.su/example/video.mp4"/><figcaption>Slideshow caption<cite>The Author</cite></figcaption></tg-slideshow>

Кроме того, вы можете использовать следующий тег в sendRichMessageDraft:

<tg-thinking>Размышление...</tg-thinking>

Обратите внимание:

  • Rich Markdown по возможности совместим с GitHub Flavored Markdown и может содержать произвольный HTML. Поддерживаемые HTML-теги форматированных сообщений разбираются так, как описано в Расширенный HTML-стиль.
  • Медиа можно указать только в виде отдельного блока.
  • Медиаблоки поддерживают только HTTP и HTTPS URL.
  • Тип медиа определяется по MIME-типу и URL медиа.
  • В синтаксисе медиа необязательный заголовок после URL используется как подпись; например, <img class="icon" src="url" alt="" title="Photo caption"> отображает “Photo caption” под медиа.
  • Ячейки таблицы могут содержать только строчное форматирование.
  • Исходный код формулы обрабатывается как чистый LaTeX.
  • Markdown не разбирается внутри блочных HTML-тегов, кроме <details>, <tg-collage> и <tg-slideshow>, поэтому там можно использовать только HTML-теги.
  • См. форматирование сущности даты и времени для получения подробностей о поддерживаемых форматах даты и времени.
Расширенный HTML-стиль

Чтобы использовать этот режим, передайте rich-содержимое сообщения в html поле. В настоящее время поддерживаются следующие теги:

<a name="chapter-0"></a> <b>bold text</b>, <strong>bold text</strong> <i>italic text</i>, <em>italic text</em> <u>underlined text</u>, <ins>underlined text</ins> <s>strikethrough text</s>, <strike>strikethrough text</strike>, <del>strikethrough text</del> <code>inline fixed-width code</code> <mark>marked text</mark> <sub>subscript text</sub> <sup>superscript text</sup> <tg-spoiler>spoiler</tg-spoiler> <a href="#note-1">Reference</a> <a href="https://asme.su/">inline URL</a> <a href="mailto:user@example.com">inline e-mail</a> <a href="tel:+123456789">inline phone number</a> <a href="as://user?id=123456789">inline mention of a user</a> <a href="#chapter-1">in-document link</a> <a name="chapter-1"></a> <tg-reference name="note-1">Referenced text</tg-reference> <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji> <img src="as://emoji?id=5368324170671202286" alt="👍"/> <tg-time unix="1647531900" format="wDT">22:45 tomorrow</tg-time> <tg-math>x^2 + y^2</tg-math> #hashtag $USD +12345678901, card: 4242 4242 4242 4242, https://asme.su asme.su a@asme.su /command @username all the text above was on the same line <h1>Heading 1</h1> <h2>Heading 2</h2> <h3>Heading 3</h3> <h4>Heading 4</h4> <h5>Heading 5</h5> <h6>Heading 6</h6> <a name="chapter-2"></a> <p>Paragraph text</p> <pre>pre-formatted fixed-width code block</pre> <pre><code class="language-python"> print('pre-formatted fixed-width code block written in the Python programming language')</code></pre> <footer>Footer text</footer> <hr/> <ul><li>unordered list item</li></ul> <ol><li>ordered list item</li></ol> <ol start="3" type="a" reversed><li>ordered list item</li></ol> <ol><li value="7" type="i">ordered list item with explicit number</li></ol> <ul> <li><input type="checkbox" checked>Checked checkbox</li> <li><input type="checkbox">Unchecked checkbox</li> </ul> <blockquote>Block quotation started<br>Block quotation continued<br>The last line of the block quotation<cite>The Author</cite></blockquote> <aside>Pull quote<cite>The Author</cite></aside> <img src="https://ansible.su/example/photo.jpg"/> <video src="https://ansible.su/example/video.mp4"></video> <audio src="https://ansible.su/example/audio.mp3"></audio> <audio src="https://ansible.su/example/audio.ogg"></audio> <video src="https://ansible.su/example/animation.gif"></video> <figure><img src="https://ansible.su/example/photo.jpg" tg-spoiler/><figcaption>Photo caption<cite>Photo credit</cite></figcaption></figure> <figure><video src="https://ansible.su/example/video.mp4" tg-spoiler></video><figcaption>Video caption</figcaption></figure> <figure><audio src="https://ansible.su/example/audio.mp3"></audio><figcaption>Audio caption</figcaption></figure> <figure><audio src="https://ansible.su/example/audio.ogg"></audio><figcaption>Voice note caption</figcaption></figure> <figure><video src="https://ansible.su/example/animation.gif" tg-spoiler></video><figcaption>Animation caption</figcaption></figure> <tg-map lat="41.9" long="12.5" zoom="14"/> <figure><tg-map lat="41.9" long="12.5" zoom="14"/><figcaption>Map caption</figcaption></figure> <tg-collage><img src="https://ansible.su/example/photo.jpg"/><video src="https://ansible.su/example/video.mp4"/></tg-collage> <tg-collage><video src="https://ansible.su/example/video.mp4"/><img src="https://ansible.su/example/photo.jpg"/><figcaption>Collage caption</figcaption></tg-collage> <tg-slideshow><img src="https://ansible.su/example/photo.jpg"/><video src="https://ansible.su/example/video.mp4"/></tg-slideshow> <tg-slideshow><video src="https://ansible.su/example/video.mp4"/><img src="https://ansible.su/example/photo.jpg"/><figcaption>Slideshow caption</figcaption></tg-slideshow> <table><tr><th>Header 1</th><th>Header 2</th></tr><tr><td>Value 1</td><td>Value 2</td></tr></table> <table bordered striped><caption>Table caption</caption> <tr><td colspan="2" rowspan="2" align="left">Value</td><td align="center">Value2</td><td align="right">Value3</td></tr> <tr><td valign="top">Value4</td><td valign="middle">Value5</td><td valign="bottom">Value6</td></tr> <tr><td>Value7</td></tr></table> <details><summary>Title</summary>Content</details> <details open><summary>Title</summary>Content</details> <tg-math-block>E = mc^2</tg-math-block>

Кроме того, вы можете использовать следующий тег в sendRichMessageDraft:

<tg-thinking>Размышление...</tg-thinking>

Обратите внимание:

  • В настоящее время поддерживаются только перечисленные выше теги.
  • Поддерживаются все числовые HTML-сущности.
  • В настоящее время API поддерживает только следующие именованные HTML-сущности: &lt;, &gt;, &amp;, &quot;, &apos;, &nbsp;, &hellip;, &mdash;, &ndash;, &lsquo;, &rsquo;, &ldquo; и &rdquo;.
  • Используйте вложенные pre и код теги для определения языка программирования для предварительно отформатированного блока.
  • Язык программирования нельзя указать для отдельного код теги.
  • Ссылки mailto:..., tel:..., и as://user?id=... отображаются как ссылки на e-mail, телефонные ссылки и встроенные упоминания соответственно. Другие поддерживаемые ссылки отображаются как обычные встроенные ссылки.
  • Изображения, видео и аудиофайлы можно указывать только как отдельные медиаблоки.
  • Медиаблоки поддерживают только HTTP и HTTPS URL.
  • Пустой <a name="..."></a> сам по себе создаёт якорь, на который можно сослаться с помощью <a href="#...">...</a>.
  • In <figcaption>, вы можете использовать <cite> теги, чтобы указать авторство подписи.
  • Используйте <tg-reference name="...">...</tg-reference> чтобы определить целевой текст, на который можно сослаться с помощью <a href="#...">...</a>.
  • Тело <details> тег может содержать содержимое rich-сообщения. Если открыть атрибут указан, блок по умолчанию развёрнут.
  • Исходный код формулы обрабатывается как чистый LaTeX.
  • См. форматирование сущности даты и времени для получения подробностей о поддерживаемых форматах даты и времени.

RichMessage

Сообщение с расширенным форматированием.

Поле Тип Описание
blocks Array of RichBlock Содержимое сообщения
is_rtl Boolean Необязательное. True, если форматированное сообщение должно отображаться справа налево

InputRichMessage

Описывает отправляемое rich-сообщение. Ровно одно из полей html, markdown, or blocks должен использоваться.

Поле Тип Описание
blocks Array of InputRichBlock Необязательное. Содержимое отправляемого rich-сообщения, описанное в виде списка блоков
html String Необязательное. Содержимое отправляемого rich-сообщения, описанное с помощью HTML-форматирования. См. параметры форматирования rich-сообщений для получения подробностей. Используйте media поле, чтобы указать медиа, используемое в сообщении.
markdown String Необязательное. Содержимое отправляемого rich-сообщения, описанное с помощью форматирования Markdown. См. параметры форматирования rich-сообщений для получения подробностей. Используйте media поле, чтобы указать медиа, используемое в сообщении.
media Array of InputRichMessageMedia Необязательное. Список медиа, которые указаны в markdown or html поля с помощью as://photo?id=, as://video?id=, и as://audio?id= ссылки
is_rtl Boolean Необязательное. Передайте True если форматированное сообщение должно отображаться справа налево
skip_entity_detection Boolean Необязательное. Передайте True чтобы пропустить автоматическое определение сущностей (например, URL, адресов электронной почты, упоминаний имён пользователей, хештегов, кештегов, команд ботов или номеров телефонов) в тексте

InputRichMessageMedia

Описывает медиаэлемент, встроенный в исходящее rich-сообщение.

Поле Тип Описание
id String Уникальный идентификатор медиа, используемого в as://photo?id=, as://video?id=, or as://audio?id= ссылку. 1-64 символа, только A-Z, a-z, 0-9, _ и - разрешены.
media InputMediaAnimation or InputMediaAudio or InputMediaPhoto or InputMediaVideo or InputMediaVoiceNote Медиа для отправки. Всё, кроме самого медиа и его свойств, игнорируется.

sendRichMessage

Используйте этот метод, чтобы отправлять rich-сообщения. Если сообщение содержит блок с медиаэлементом, то бот должен иметь право отправлять это медиа в чат. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение. Бот может отправлять rich-сообщения от имени бизнес-аккаунта, только если соответствующий пользователь может отправлять rich-сообщения.
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
rich_message InputRichMessage Да Сообщение, которое будет отправлено
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Необязательное Дополнительные параметры интерфейса. JSON-сериализованный объект для inline-клавиатура, пользовательская клавиатура ответов, инструкции убрать клавиатуру ответа или принудительно запросить ответ от пользователя.

sendRichMessageDraft

Используйте этот метод, чтобы передавать пользователю частичное rich-сообщение по мере его генерации. Обратите внимание, что передаваемый черновик эфемерен и служит временным предпросмотром на 30 секунд - как только вывод финализирован, вы должен звонок sendRichMessage с полным сообщением, чтобы сохранить его в чате пользователя. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
chat_id Integer Да Уникальный идентификатор целевого личного чата
message_thread_id Integer Необязательное Уникальный идентификатор целевого треда сообщений
draft_id Integer Да Уникальный идентификатор черновика сообщения; должен быть ненулевым. Изменения черновиков с одинаковым идентификатором анимируются.
rich_message InputRichMessage Да Частичное сообщение для потоковой передачи. Прямая загрузка новых файлов не поддерживается.

RichText

Этот объект представляет rich-форматированный текст. В настоящее время это может быть либо String для обычного текста, либо Array of RichText, или любой из следующих типов:

RichTextBold

Полужирный текст.

Поле Тип Описание
type String Тип форматированного текста, всегда «bold»
text RichText Текст

RichTextItalic

Курсивный текст.

Поле Тип Описание
type String Тип rich-текста, всегда «italic»
text RichText Текст

RichTextUnderline

Подчёркнутый текст.

Поле Тип Описание
type String Тип форматированного текста, всегда “underline”
text RichText Текст

RichTextStrikethrough

Зачёркнутый текст.

Поле Тип Описание
type String Тип форматированного текста, всегда «strikethrough»
text RichText Текст

RichTextSpoiler

Текст, скрытый спойлером.

Поле Тип Описание
type String Тип форматированного текста, всегда “spoiler”
text RichText Текст

RichTextDateTime

Отформатированные дата и время.

Поле Тип Описание
type String Тип форматированного текста, всегда «date_time»
text RichText Текст
unix_time Integer Unix-время, связанное с сущностью
date_time_format String Строка, определяющая форматирование даты и времени. См. форматирование сущности даты и времени подробнее.

RichTextTextMention

Упоминание пользователя Ansible по его идентификатору.

Поле Тип Описание
type String Тип форматированного текста, всегда “text_mention”
text RichText Текст
пользователя User Упомянутый пользователь

RichTextSubscript

Текст с нижним индексом.

Поле Тип Описание
type String Тип форматированного текста, всегда «subscript»
text RichText Текст

RichTextSuperscript

Текст в верхнем индексе.

Поле Тип Описание
type String Тип rich-текста, всегда «superscript»
text RichText Текст

RichTextMarked

Выделенный текст.

Поле Тип Описание
type String Тип форматированного текста, всегда «marked»
text RichText Текст

RichTextCode

Моноширинный текст.

Поле Тип Описание
type String Тип форматированного текста, всегда «code»
text RichText Текст

RichTextCustomEmoji

Пользовательский эмодзи.

Поле Тип Описание
type String Тип форматированного текста, всегда «custom_emoji»
custom_emoji_id String Уникальный идентификатор кастомного эмодзи. Используйте getCustomEmojiStickers чтобы получить полную информацию о стикере.
alternative_text String Альтернативный эмодзи для кастомного эмодзи

RichTextMathematicalExpression

Математическое выражение.

Поле Тип Описание
type String Тип rich-текста, всегда «mathematical_expression»
выражение String Выражение в формате LaTeX

RichTextUrl

Текст со ссылкой.

Поле Тип Описание
type String Тип rich-текста, всегда “url”
text RichText Текст
url String URL ссылки

RichTextEmailAddress

Текст с адресом электронной почты.

Поле Тип Описание
type String Тип форматированного текста, всегда «email_address»
text RichText Текст
email_address String Адрес электронной почты

RichTextPhoneNumber

Текст с номером телефона.

Поле Тип Описание
type String Тип rich-текста, всегда «phone_number»
text RichText Текст
phone_number String Номер телефона

RichTextBankCardNumber

Текст с номером банковской карты.

Поле Тип Описание
type String Тип форматированного текста, всегда «bank_card_number»
text RichText Текст
bank_card_number String Номер банковской карты

RichTextMention

Упоминание по username.

Поле Тип Описание
type String Тип rich-текста, всегда «mention»
text RichText Текст
username String Имя пользователя

RichTextHashtag

Хэштег.

Поле Тип Описание
type String Тип форматированного текста, всегда «hashtag»
text RichText Текст
hashtag String Хештег

RichTextCashtag

Кэштег.

Поле Тип Описание
type String Тип форматированного текста, всегда «cashtag»
text RichText Текст
cashtag String Кэштег

RichTextBotCommand

Команда бота.

Поле Тип Описание
type String Тип форматированного текста, всегда «bot_command»
text RichText Текст
bot_command String Команда бота

RichTextAnchor

Якорь.

Поле Тип Описание
type String Тип rich-текста, всегда «anchor»
name String Имя якоря

RichTextAnchorLink

Ссылка на якорь.

Поле Тип Описание
type String Тип rich-текста, всегда “anchor_link”
text RichText Текст ссылки
anchor_name String Имя якоря. Если имя пустое, то ссылка возвращает к началу сообщения.

RichTextReference

Ссылка.

Поле Тип Описание
type String Тип rich-текста, всегда «reference»
text RichText Текст ссылки
name String Имя ссылки

RichTextReferenceLink

Ссылка на сноску.

Поле Тип Описание
type String Тип rich-текста, всегда «reference_link»
text RichText Текст ссылки
reference_name String Имя ссылки

RichBlockCaption

Подпись форматированного rich-блока.

Поле Тип Описание
text RichText Подпись блока
credit RichText Необязательное. Блок credit, который соответствует HTML-тегу <cite>

RichBlockTableCell

Ячейка таблицы.

Поле Тип Описание
text RichText Необязательное. Текст в ячейке. Если не указан, то ячейка невидима.
is_header True Необязательное. True, если ячейка является заголовочной
colspan Integer Необязательное. Количество столбцов, которые занимает ячейка, если оно больше 1
rowspan Integer Необязательное. Количество строк, которые занимает ячейка, если оно больше 1
align String Горизонтальное выравнивание содержимого ячейки. Сейчас должно быть одним из «left», «center» или «right».
valign String Вертикальное выравнивание содержимого ячейки. В настоящее время должно быть одним из «top», «middle» или «bottom».

RichBlockListItem

Элемент списка.

Поле Тип Описание
label String Метка элемента
blocks Array of RichBlock Содержимое элемента
has_checkbox True Необязательное. True, если у элемента есть чекбокс
is_checked True Необязательное. True, если у элемента отмечен флажок
value Integer Необязательное. Для нумерованных списков — числовое значение метки элемента
type String Необязательное. Для нумерованных списков — тип метки элемента; должен быть одним из «a» для строчных букв, «A» для прописных букв, «i» для строчных римских цифр, «I» для прописных римских цифр или «1» для десятичных чисел

RichBlock

Этот объект представляет блок в rich-форматированном сообщении. В настоящее время это может быть любой из следующих типов:

RichBlockParagraph

Текстовый абзац, соответствующий HTML-тегу <p>.

Поле Тип Описание
type String Тип блока, всегда “paragraph”
text RichText Текст блока

RichBlockSectionHeading

Заголовок раздела, соответствующий HTML-тегам <h1>, <h2>, <h3>, <h4>, <h5>, or <h6>.

Поле Тип Описание
type String Тип блока, всегда «heading»
text RichText Текст блока
size Integer Относительный размер шрифта текста; 1-6, 1 — самый большой, 6 — самый маленький

RichBlockPreformatted

Блок преформатированного текста, соответствующий вложенным HTML-тегам <pre> и <code>.

Поле Тип Описание
type String Тип блока, всегда «pre»
text RichText Текст блока
language String Необязательное. Язык программирования текста

RichBlockFooter

Нижний колонтитул, соответствующий HTML-тегу <footer>.

Поле Тип Описание
type String Тип блока, всегда «footer»
text RichText Текст блока

RichBlockDivider

Разделитель, соответствующий HTML-тегу <hr/>.

Поле Тип Описание
type String Тип блока, всегда «divider»

RichBlockMathematicalExpression

Блок с математическим выражением в формате LaTeX, соответствующий пользовательскому HTML-тегу <tg-math-block>.

Поле Тип Описание
type String Тип блока, всегда «mathematical_expression»
выражение String Математическое выражение в формате LaTeX

RichBlockAnchor

Блок с якорем, соответствующий HTML-тегу <a> с атрибутом name.

Поле Тип Описание
type String Тип блока, всегда «anchor»
name String Имя якоря

RichBlockList

Список блоков, соответствующий HTML-тегу <ul> or <ol> с несколькими вложенными тегами <li>.

Поле Тип Описание
type String Тип блока, всегда «list»
items Array of RichBlockListItem Элементы списка

RichBlockBlockQuotation

Блочная цитата, соответствующая HTML-тегу <blockquote>.

Поле Тип Описание
type String Тип блока, всегда «blockquote»
blocks Array of RichBlock Содержимое блока
credit RichText Необязательное. Указание авторства блока

RichBlockPullQuotation

Цитата с выровненным по центру текстом, приблизительно соответствующая HTML-тегу <aside>.

Поле Тип Описание
type String Тип блока, всегда «pullquote»
text RichText Текст блока
credit RichText Необязательное. Указание авторства блока

RichBlockCollage

Коллаж, соответствующий пользовательскому HTML-тегу <tg-collage>.

Поле Тип Описание
type String Тип блока, всегда «collage»
blocks Array of RichBlock Элементы коллажа
caption RichBlockCaption Необязательное. Подпись блока

RichBlockSlideshow

Слайдшоу, соответствующее пользовательскому HTML-тегу <tg-slideshow>.

Поле Тип Описание
type String Тип блока, всегда “slideshow”
blocks Array of RichBlock Элементы слайд-шоу
caption RichBlockCaption Необязательное. Подпись блока

RichBlockTable

Таблица, соответствующая HTML-тегу <table>.

Поле Тип Описание
type String Тип блока, всегда “table”
cells Array of Array of RichBlockTableCell Ячейки таблицы
is_bordered True Необязательное. True, если у таблицы есть границы
is_striped True Необязательное. True, если таблица полосатая
caption RichText Необязательное. Подпись таблицы

RichBlockDetails

Раскрывающийся блок для отображения деталей, соответствующий HTML-тегу <details>.

Поле Тип Описание
type String Тип блока, всегда «details»
summary RichText Всегда отображаемая сводка блока
blocks Array of RichBlock Содержимое блока
is_open True Необязательное. True, если содержимое блока видно по умолчанию

RichBlockMap

Блок с картой, соответствующий кастомному HTML-тегу <tg-map>.

Поле Тип Описание
type String Тип блока, всегда «map»
location Location Местоположение центра карты
zoom Integer Уровень масштабирования карты; 13-20
width Integer Ожидаемая ширина карты
height Integer Ожидаемая высота карты
caption RichBlockCaption Необязательное. Подпись блока

RichBlockAnimation

Блок с анимацией, соответствующий HTML-тегу <video>.

Поле Тип Описание
type String Тип блока, всегда «animation»
animation Animation Анимация
has_spoiler True Необязательное. True, если превью медиа скрыто анимацией спойлера
caption RichBlockCaption Необязательное. Подпись блока

RichBlockAudio

Блок с музыкальным файлом, соответствующий HTML-тегу <audio>.

Поле Тип Описание
type String Тип блока, всегда «audio»
audio Audio Аудио
caption RichBlockCaption Необязательное. Подпись блока

RichBlockPhoto

Блок с фотографией, соответствующий HTML-тегу <img>.

Поле Тип Описание
type String Тип блока, всегда «photo»
photo Array of PhotoSize Доступные размеры фотографии
has_spoiler True Необязательное. True, если превью медиа скрыто анимацией спойлера
caption RichBlockCaption Необязательное. Подпись блока

RichBlockVideo

Блок с видео, соответствующий HTML-тегу <video>.

Поле Тип Описание
type String Тип блока, всегда «video»
video Video Видео
has_spoiler True Необязательное. True, если превью медиа скрыто анимацией спойлера
caption RichBlockCaption Необязательное. Подпись блока

RichBlockVoiceNote

Блок с голосовым сообщением, соответствующий HTML-тегу <audio>.

Поле Тип Описание
type String Тип блока, всегда «voice_note»
voice_note Voice Голосовое сообщение
caption RichBlockCaption Необязательное. Подпись блока

RichBlockThinking

Блок с заглушкой «Thinking…», соответствующий пользовательскому HTML-тегу <tg-thinking>. Блок может использоваться только в sendRichMessageDraft, поэтому его нельзя получить в сообщениях. См. https://asme.su/addemoji/AIActions для примеров кастомных эмодзи, рекомендуемых для использования в блоке.

Поле Тип Описание
type String Тип блока, всегда “thinking”
text RichText Текст блока. См. https://asme.su/addemoji/AIActions для примеров кастомных эмодзи, рекомендуемых для использования в блоке.

InputRichBlockListItem

Элемент отправляемого списка.

Поле Тип Описание
blocks Array of InputRichBlock Содержимое элемента
has_checkbox True Необязательное. Передайте True если у элемента есть флажок
is_checked True Необязательное. Передайте True если у элемента отмечен флажок
value Integer Необязательное. Для нумерованных списков — числовое значение метки элемента
type String Необязательное. Для нумерованных списков — тип метки элемента; должен быть одним из «a» для строчных букв, «A» для прописных букв, «i» для строчных римских цифр, «I» для прописных римских цифр или «1» для десятичных чисел

InputRichBlock

Этот объект представляет блок в отправляемом сообщении с расширенным форматированием. В настоящее время это может быть любой из следующих типов:

InputRichBlockParagraph

Текстовый абзац, соответствующий HTML-тегу <p>.

Поле Тип Описание
type String Тип блока, всегда “paragraph”
text RichText Текст блока

InputRichBlockSectionHeading

Заголовок раздела, соответствующий HTML-тегам <h1>, <h2>, <h3>, <h4>, <h5>, or <h6>.

Поле Тип Описание
type String Тип блока, всегда «heading»
text RichText Текст блока
size Integer Относительный размер шрифта текста; 1-6, 1 — самый большой, 6 — самый маленький

InputRichBlockPreformatted

Блок преформатированного текста, соответствующий вложенным HTML-тегам <pre> и <code>.

Поле Тип Описание
type String Тип блока, всегда «pre»
text RichText Текст блока
language String Необязательное. Язык программирования текста

InputRichBlockFooter

Нижний колонтитул, соответствующий HTML-тегу <footer>.

Поле Тип Описание
type String Тип блока, всегда «footer»
text RichText Текст блока

InputRichBlockDivider

Разделитель, соответствующий HTML-тегу <hr/>.

Поле Тип Описание
type String Тип блока, всегда «divider»

InputRichBlockMathematicalExpression

Блок с математическим выражением в формате LaTeX, соответствующий пользовательскому HTML-тегу <tg-math-block>.

Поле Тип Описание
type String Тип блока, всегда «mathematical_expression»
выражение String Математическое выражение в формате LaTeX

InputRichBlockAnchor

Блок с якорем, соответствующий HTML-тегу <a> с атрибутом name.

Поле Тип Описание
type String Тип блока, всегда «anchor»
name String Имя якоря

InputRichBlockList

Список блоков, соответствующий HTML-тегу <ul> or <ol> с несколькими вложенными тегами <li>.

Поле Тип Описание
type String Тип блока, всегда «list»
items Array of InputRichBlockListItem Элементы списка

InputRichBlockBlockQuotation

Блочная цитата, соответствующая HTML-тегу <blockquote>.

Поле Тип Описание
type String Тип блока, всегда «blockquote»
blocks Array of InputRichBlock Содержимое блока
credit RichText Необязательное. Указание авторства блока

InputRichBlockPullQuotation

Цитата с выровненным по центру текстом, приблизительно соответствующая HTML-тегу <aside>.

Поле Тип Описание
type String Тип блока, всегда «pullquote»
text RichText Текст блока
credit RichText Необязательное. Указание авторства блока

InputRichBlockCollage

Коллаж, соответствующий пользовательскому HTML-тегу <tg-collage>.

Поле Тип Описание
type String Тип блока, всегда «collage»
blocks Array of InputRichBlock Элементы коллажа
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockSlideshow

Слайдшоу, соответствующее пользовательскому HTML-тегу <tg-slideshow>.

Поле Тип Описание
type String Тип блока, всегда “slideshow”
blocks Array of InputRichBlock Элементы слайд-шоу
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockTable

Таблица, соответствующая HTML-тегу <table>.

Поле Тип Описание
type String Тип блока, всегда “table”
cells Array of Array of RichBlockTableCell Ячейки таблицы
is_bordered True Необязательное. Передайте True если у таблицы есть границы
is_striped True Необязательное. Передайте True если таблица полосатая
caption RichText Необязательное. Подпись таблицы

InputRichBlockDetails

Раскрывающийся блок для отображения деталей, соответствующий HTML-тегу <details>.

Поле Тип Описание
type String Тип блока, всегда «details»
summary RichText Всегда отображаемая сводка блока
blocks Array of InputRichBlock Содержимое блока
is_open True Необязательное. Передайте True если содержимое блока видно по умолчанию

InputRichBlockMap

Блок с картой, соответствующий кастомному HTML-тегу <tg-map>. Ширина и высота карты в сумме не должны превышать 10000. Соотношение ширины и высоты должно быть не более 20.

Поле Тип Описание
type String Тип блока, всегда «map»
location Location Местоположение центра карты
zoom Integer Уровень масштабирования карты; 0-24
width Integer Ширина карты; 0-10000
height Integer Высота карты; 0-10000
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockAnimation

Блок с анимацией, соответствующий HTML-тегу <video>.

Поле Тип Описание
type String Тип блока, всегда «animation»
animation InputMediaAnimation Анимация. Подпись игнорируется.
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockAudio

Блок с музыкальным файлом, соответствующий HTML-тегу <audio>.

Поле Тип Описание
type String Тип блока, всегда «audio»
audio InputMediaAudio Аудио. Подпись игнорируется.
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockPhoto

Блок с фотографией, соответствующий HTML-тегу <img>.

Поле Тип Описание
type String Тип блока, всегда «photo»
photo InputMediaPhoto Фото. Подпись игнорируется.
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockVideo

Блок с видео, соответствующий HTML-тегу <video>.

Поле Тип Описание
type String Тип блока, всегда «video»
video InputMediaVideo Видео. Подпись игнорируется.
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockVoiceNote

Блок с голосовым сообщением, соответствующий HTML-тегу <audio>.

Поле Тип Описание
type String Тип блока, всегда «voice_note»
voice_note InputMediaVoiceNote Голосовое сообщение. Подпись игнорируется.
caption RichBlockCaption Необязательное. Подпись блока

InputRichBlockThinking

Блок с заглушкой «Thinking…», соответствующий пользовательскому HTML-тегу <tg-thinking>. Блок может использоваться только в sendRichMessageDraft, поэтому его нельзя получить в сообщениях. См. https://asme.su/addemoji/AIActions для примеров кастомных эмодзи, рекомендуемых для использования в блоке.

Поле Тип Описание
type String Тип блока, всегда “thinking”
text RichText Текст блока. См. https://asme.su/addemoji/AIActions для примеров кастомных эмодзи, рекомендуемых для использования в блоке.

Inline-режим

Следующие методы и объекты позволяют вашему боту работать в inline-режиме.
Подробности см. в нашем «Введении в Inline-ботов».

Чтобы включить эту опцию, отправьте /setinline команду, чтобы @BotFather и укажите текст-подсказку, который пользователь увидит в поле ввода после набора имени вашего бота.

InlineQuery

Этот объект представляет входящий инлайн-запрос. Когда пользователь отправляет пустой запрос, ваш бот может вернуть результаты по умолчанию или популярные результаты.

Поле Тип Описание
id String Уникальный идентификатор этого запроса
from User Отправитель
query String Текст запроса (до 256 символов)
offset String Смещение возвращаемых результатов, может контролироваться ботом
chat_type String Необязательное. Тип чата, из которого был отправлен инлайн-запрос. Может быть «sender» для личного чата с отправителем инлайн-запроса, «private», «group», «supergroup» или «channel». Тип чата всегда известен для запросов из официальных клиентов и большинства сторонних, кроме запросов из секретного чата.
location Location Необязательное. Местоположение отправителя, только для ботов, запрашивающих местоположение пользователя

answerInlineQuery

Используйте этот метод, чтобы отправить ответы на инлайн-запрос. В случае успеха True возвращается.
Не более 50 результатов на запрос.

Параметр Тип Обязательно Описание
inline_query_id String Да Уникальный идентификатор запроса, на который дан ответ
results Array of InlineQueryResult Да JSON-сериализованный массив результатов для inline-запроса
cache_time Integer Необязательное Максимальное время в секундах, в течение которого результат inline-запроса может кешироваться на сервере. По умолчанию 300.
is_personal Boolean Необязательное Передайте True если результаты могут кэшироваться на стороне сервера только для пользователя, отправившего запрос. По умолчанию результаты могут возвращаться любому пользователю, который отправит такой же запрос.
next_offset String Необязательное Передайте смещение, которое клиент должен отправить в следующем запросе с тем же текстом, чтобы получить больше результатов. Передайте пустую строку, если результатов больше нет или если вы не поддерживаете постраничную выдачу. Длина смещения не может превышать 64 байта.
кнопка InlineQueryResultsButton Необязательное JSON-сериализованный объект, описывающий кнопку, которая будет показана над результатами inline-запроса

InlineQueryResultsButton

Этот объект представляет кнопку, которая будет показана над результатами inline-запроса. Вы должен используйте ровно одно из необязательных полей.

Поле Тип Описание
text String Текст надписи на кнопке
web_app WebAppInfo Необязательное. Описание Web App, который будет запущен при нажатии пользователем кнопки. Web App сможет вернуться в inline-режим с помощью метода switchInlineQuery внутри Web App.
start_parameter String Необязательное. Диплинкинг параметр для сообщения /start, отправляемого боту, когда пользователь нажимает кнопку. 1-64 символа, только A-Z, a-z, 0-9, _ и - разрешены.

Пример: Inline-бот, который отправляет видео с YouTube, может попросить пользователя подключить бота к его аккаунту YouTube, чтобы соответствующим образом адаптировать результаты поиска. Для этого он показывает кнопку 'Connect your YouTube account' над результатами или даже до того, как покажет хоть какие-то. Пользователь нажимает кнопку, переходит в личный чат с ботом и тем самым передаёт параметр start, который указывает боту вернуть OAuth-ссылку. После этого бот может предложить switch_inline кнопку, чтобы пользователь мог легко вернуться в чат, где он хотел использовать inline-возможности бота.

InlineQueryResult

Этот объект представляет один результат inline-запроса. Клиенты Ansible в настоящее время поддерживают результаты следующих 20 типов:

Заметка: Все URL, переданные в результатах инлайн-запроса, будут доступны конечным пользователям, поэтому следует считать их public.

InlineQueryResultArticle

Представляет ссылку на статью или веб-страницу.

Поле Тип Описание
type String Тип результата, должен быть article
id String Уникальный идентификатор этого результата, 1-64 байта
title String Заголовок результата
input_message_content InputMessageContent Содержимое отправляемого сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
url String Необязательное. URL результата
description String Необязательное. Краткое описание результата
thumbnail_url String Необязательное. Url миниатюры для результата
thumbnail_width Integer Необязательное. Ширина миниатюры
thumbnail_height Integer Необязательное. Высота миниатюры

InlineQueryResultPhoto

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

Поле Тип Описание
type String Тип результата, должен быть photo
id String Уникальный идентификатор этого результата, 1-64 байта
photo_url String Корректный URL фотографии. Фотография должна быть в JPEG формате. Размер фотографии не должен превышать 5MB.
thumbnail_url String URL миниатюры для фото
photo_width Integer Необязательное. Ширина фото
photo_height Integer Необязательное. Высота фотографии
title String Необязательное. Заголовок результата
description String Необязательное. Краткое описание результата
caption String Необязательное. Подпись к отправляемому фото, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к фотографии. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, отправляемого вместо фото

InlineQueryResultGif

Представляет ссылку на анимированный GIF-файл. По умолчанию этот анимированный GIF-файл будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо анимации.

Поле Тип Описание
type String Тип результата, должен быть gif
id String Уникальный идентификатор этого результата, 1-64 байта
gif_url String Корректный URL GIF-файла
gif_width Integer Необязательное. Ширина GIF
gif_height Integer Необязательное. Высота GIF
gif_duration Integer Необязательное. Длительность GIF в секундах
thumbnail_url String URL статичной (JPEG или GIF) или анимированной (MPEG4) миниатюры для результата
thumbnail_mime_type String Необязательное. MIME-тип миниатюры, должен быть одним из «image/jpeg», «image/gif» или «video/mp4». По умолчанию «image/jpeg».
title String Необязательное. Заголовок результата
caption String Необязательное. Подпись к отправляемому GIF-файлу, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо GIF-анимации

InlineQueryResultMpeg4Gif

Представляет ссылку на видеоанимацию (видео H.264/MPEG-4 AVC без звука). По умолчанию этот анимированный файл MPEG-4 будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо анимации.

Поле Тип Описание
type String Тип результата, должен быть mpeg4_gif
id String Уникальный идентификатор этого результата, 1-64 байта
mpeg4_url String Корректный URL файла MPEG4
mpeg4_width Integer Необязательное. Ширина видео
mpeg4_height Integer Необязательное. Высота видео
mpeg4_duration Integer Необязательное. Длительность видео в секундах
thumbnail_url String URL статичной (JPEG или GIF) или анимированной (MPEG4) миниатюры для результата
thumbnail_mime_type String Необязательное. MIME-тип миниатюры, должен быть одним из «image/jpeg», «image/gif» или «video/mp4». По умолчанию «image/jpeg».
title String Необязательное. Заголовок результата
caption String Необязательное. Подпись к отправляемому MPEG-4 файлу, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо видеоанимации

InlineQueryResultVideo

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

Если сообщение InlineQueryResultVideo содержит встроенное видео (например, YouTube), вы должен заменить его содержимое с помощью input_message_content.

Поле Тип Описание
type String Тип результата, должен быть video
id String Уникальный идентификатор этого результата, 1-64 байта
video_url String Корректный URL встроенного видеоплеера или видеофайла
mime_type String MIME-тип содержимого по URL видео, «text/html» или «video/mp4»
thumbnail_url String URL миниатюры (только JPEG) для видео
title String Заголовок результата
caption String Необязательное. Подпись отправляемого видео, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к видео. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
video_width Integer Необязательное. Ширина видео
video_height Integer Необязательное. Высота видео
video_duration Integer Необязательное. Длительность видео в секундах
description String Необязательное. Краткое описание результата
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо видео. Это поле обязательный если InlineQueryResultVideo используется для отправки HTML-страницы в качестве результата (например, видео с YouTube).

InlineQueryResultAudio

Представляет ссылку на аудиофайл MP3. По умолчанию этот аудиофайл будет отправлен пользователем. Как вариант, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо аудио.

Поле Тип Описание
type String Тип результата, должен быть audio
id String Уникальный идентификатор этого результата, 1-64 байта
audio_url String Действительный URL аудиофайла
title String Название
caption String Необязательное. Подпись, 0-1024 символов после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к аудио. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
performer String Необязательное. Исполнитель
audio_duration Integer Необязательное. Длительность аудио в секундах
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо аудио

InlineQueryResultVoice

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

Поле Тип Описание
type String Тип результата, должен быть voice
id String Уникальный идентификатор этого результата, 1-64 байта
voice_url String Корректный URL голосовой записи
title String Название записи
caption String Необязательное. Подпись, 0-1024 символов после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к голосовому сообщению. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
voice_duration Integer Необязательное. Длительность записи в секундах
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо голосовой записи

InlineQueryResultDocument

Представляет ссылку на файл. По умолчанию этот файл будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо файла. В настоящее время только .PDF и .ZIP файлы можно отправлять с помощью этого метода.

Поле Тип Описание
type String Тип результата, должен быть document
id String Уникальный идентификатор этого результата, 1-64 байта
title String Заголовок результата
caption String Необязательное. Подпись отправляемого документа, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к документу. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
document_url String Действительный URL файла
mime_type String MIME-тип содержимого файла, либо «application/pdf», либо «application/zip»
description String Необязательное. Краткое описание результата
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо файла
thumbnail_url String Необязательное. URL миниатюры (только JPEG) для файла
thumbnail_width Integer Необязательное. Ширина миниатюры
thumbnail_height Integer Необязательное. Высота миниатюры

InlineQueryResultLocation

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

Поле Тип Описание
type String Тип результата, должен быть location
id String Уникальный идентификатор этого результата, 1-64 байта
latitude Float Широта местоположения в градусах
longitude Float Долгота местоположения в градусах
title String Название местоположения
horizontal_accuracy Float Необязательное. Радиус погрешности местоположения, измеряемый в метрах; 0-1500
live_period Integer Необязательное. Период в секундах, в течение которого местоположение может обновляться, должен быть от 60 до 86400, или 0x7FFFFFFF для трансляций местоположения, которые можно редактировать неограниченно долго
heading Integer Необязательное. Для трансляций геопозиции — направление, в котором движется пользователь, в градусах. Если указано, должно быть от 1 до 360.
proximity_alert_radius Integer Необязательное. Для live-локаций — максимальное расстояние для уведомлений о приближении к другому участнику чата, в метрах. Если указано, должно быть от 1 до 100000.
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо геопозиции
thumbnail_url String Необязательное. Url миниатюры для результата
thumbnail_width Integer Необязательное. Ширина миниатюры
thumbnail_height Integer Необязательное. Высота миниатюры

InlineQueryResultVenue

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

Поле Тип Описание
type String Тип результата, должен быть venue
id String Уникальный идентификатор этого результата, 1-64 байта
latitude Float Широта местоположения заведения в градусах
longitude Float Долгота местоположения места в градусах
title String Название места
address String Адрес места
foursquare_id String Необязательное. Идентификатор места в Foursquare, если известен
foursquare_type String Необязательное. Тип места в Foursquare, если известен. (Например, «arts_entertainment/default», «arts_entertainment/aquarium» или «food/icecream».)
google_place_id String Необязательное. Идентификатор места в Google Places
google_place_type String Необязательное. Тип места по классификации Google Places. (См. поддерживаемые типы.)
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо места
thumbnail_url String Необязательное. Url миниатюры для результата
thumbnail_width Integer Необязательное. Ширина миниатюры
thumbnail_height Integer Необязательное. Высота миниатюры

InlineQueryResultContact

Представляет контакт с номером телефона. По умолчанию этот контакт будет отправлен пользователем. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо контакта.

Поле Тип Описание
type String Тип результата, должен быть contact
id String Уникальный идентификатор этого результата, 1-64 байта
phone_number String Номер телефона контакта
first_name String Имя контакта
last_name String Необязательное. Фамилия контакта
vcard String Необязательное. Дополнительные данные о контакте в виде vCard, 0-2048 байт
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо контакта
thumbnail_url String Необязательное. Url миниатюры для результата
thumbnail_width Integer Необязательное. Ширина миниатюры
thumbnail_height Integer Необязательное. Высота миниатюры

InlineQueryResultGame

Представляет Game.

Поле Тип Описание
type String Тип результата, должен быть game
id String Уникальный идентификатор этого результата, 1-64 байта
game_short_name String Короткое имя игры
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению

InlineQueryResultCachedPhoto

Представляет ссылку на фотографию, хранящуюся на серверах Ansible. По умолчанию эта фотография будет отправлена пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо фотографии.

Поле Тип Описание
type String Тип результата, должен быть photo
id String Уникальный идентификатор этого результата, 1-64 байта
photo_file_id String Действительный идентификатор файла фотографии
title String Необязательное. Заголовок результата
description String Необязательное. Краткое описание результата
caption String Необязательное. Подпись к отправляемому фото, 0-1024 символа после парсинга сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к фотографии. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, отправляемого вместо фото

InlineQueryResultCachedGif

Представляет ссылку на анимированный файл GIF, хранящийся на серверах Ansible. По умолчанию этот анимированный файл GIF будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо анимации.

Поле Тип Описание
type String Тип результата, должен быть gif
id String Уникальный идентификатор этого результата, 1-64 байта
gif_file_id String Действительный идентификатор файла для файла GIF
title String Необязательное. Заголовок результата
caption String Необязательное. Подпись к отправляемому GIF-файлу, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо GIF-анимации

InlineQueryResultCachedMpeg4Gif

Представляет ссылку на видеоанимацию (видео H.264/MPEG-4 AVC без звука), хранящуюся на серверах Ansible. По умолчанию этот анимированный MPEG-4 файл будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо анимации.

Поле Тип Описание
type String Тип результата, должен быть mpeg4_gif
id String Уникальный идентификатор этого результата, 1-64 байта
mpeg4_file_id String Валидный идентификатор файла для MPEG4-файла
title String Необязательное. Заголовок результата
caption String Необязательное. Подпись к отправляемому MPEG-4 файлу, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо видеоанимации

InlineQueryResultCachedSticker

Представляет ссылку на стикер, хранящийся на серверах Ansible. По умолчанию этот стикер будет отправлен пользователем. В качестве альтернативы вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо стикера.

Поле Тип Описание
type String Тип результата, должен быть sticker
id String Уникальный идентификатор этого результата, 1-64 байта
sticker_file_id String Действительный идентификатор файла стикера
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо стикера

InlineQueryResultCachedDocument

Представляет ссылку на файл, хранящийся на серверах Ansible. По умолчанию этот файл будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо файла.

Поле Тип Описание
type String Тип результата, должен быть document
id String Уникальный идентификатор этого результата, 1-64 байта
title String Заголовок результата
document_file_id String Корректный идентификатор файла для файла
description String Необязательное. Краткое описание результата
caption String Необязательное. Подпись отправляемого документа, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к документу. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо файла

InlineQueryResultCachedVideo

Представляет ссылку на видеофайл, хранящийся на серверах Ansible. По умолчанию этот видеофайл будет отправлен пользователем с необязательной подписью. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо видео.

Поле Тип Описание
type String Тип результата, должен быть video
id String Уникальный идентификатор этого результата, 1-64 байта
video_file_id String Действительный идентификатор файла для видеофайла
title String Заголовок результата
description String Необязательное. Краткое описание результата
caption String Необязательное. Подпись отправляемого видео, 0-1024 символа после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к видео. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
show_caption_above_media Boolean Необязательное. Передайте True если подпись должна отображаться над медиа сообщения
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо видео

InlineQueryResultCachedVoice

Представляет ссылку на голосовое сообщение, хранящееся на серверах Ansible. По умолчанию это голосовое сообщение будет отправлено пользователем. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо голосового сообщения.

Поле Тип Описание
type String Тип результата, должен быть voice
id String Уникальный идентификатор этого результата, 1-64 байта
voice_file_id String Действительный идентификатор файла для голосового сообщения
title String Название голосового сообщения
caption String Необязательное. Подпись, 0-1024 символов после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к голосовому сообщению. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо голосового сообщения

InlineQueryResultCachedAudio

Представляет ссылку на MP3-аудиофайл, хранящийся на серверах Ansible. По умолчанию этот аудиофайл будет отправлен пользователем. Кроме того, вы можете использовать input_message_content чтобы отправить сообщение с указанным содержимым вместо аудио.

Поле Тип Описание
type String Тип результата, должен быть audio
id String Уникальный идентификатор этого результата, 1-64 байта
audio_file_id String Действительный идентификатор файла для аудиофайла
caption String Необязательное. Подпись, 0-1024 символов после разбора сущностей
parse_mode String Необязательное. Режим разбора сущностей в подписи к аудио. См. варианты форматирования подробнее.
caption_entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в подписи, который может быть указан вместо parse_mode
reply_markup InlineKeyboardMarkup Необязательное. Инлайн-клавиатура прикреплённый к сообщению
input_message_content InputMessageContent Необязательное. Содержимое сообщения, которое будет отправлено вместо аудио

InputMessageContent

Этот объект представляет содержимое сообщения, которое будет отправлено в результате inline-запроса. Клиенты Ansible в настоящее время поддерживают следующие типы:

InputTextMessageContent

Представляет content текстового сообщения, которое будет отправлено в качестве результата inline-запроса.

Поле Тип Описание
message_text String Текст отправляемого сообщения, 1-4096 символов
parse_mode String Необязательное. Режим разбора сущностей в тексте сообщения. См. варианты форматирования подробнее.
entities Array of MessageEntity Необязательное. Список специальных сущностей, встречающихся в тексте сообщения, который можно указать вместо parse_mode
link_preview_options LinkPreviewOptions Необязательное. Параметры генерации предпросмотра ссылки для сообщения

InputRichMessageContent

Представляет content rich-сообщения, которое будет отправлено как результат инлайн-запроса.

Поле Тип Описание
rich_message InputRichMessage Сообщение, которое будет отправлено

InputLocationMessageContent

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

Поле Тип Описание
latitude Float Широта местоположения в градусах
longitude Float Долгота местоположения в градусах
horizontal_accuracy Float Необязательное. Радиус погрешности местоположения, измеряемый в метрах; 0-1500
live_period Integer Необязательное. Период в секундах, в течение которого местоположение может обновляться, должен быть от 60 до 86400, или 0x7FFFFFFF для трансляций местоположения, которые можно редактировать неограниченно долго
heading Integer Необязательное. Для трансляций геопозиции — направление, в котором движется пользователь, в градусах. Если указано, должно быть от 1 до 360.
proximity_alert_radius Integer Необязательное. Для live-локаций — максимальное расстояние для уведомлений о приближении к другому участнику чата, в метрах. Если указано, должно быть от 1 до 100000.

InputVenueMessageContent

Представляет content сообщения с местом, которое будет отправлено в результате инлайн-запроса.

Поле Тип Описание
latitude Float Широта места в градусах
longitude Float Долгота места в градусах
title String Название места
address String Адрес места
foursquare_id String Необязательное. Идентификатор места в Foursquare, если известен
foursquare_type String Необязательное. Тип места в Foursquare, если известен. (Например, «arts_entertainment/default», «arts_entertainment/aquarium» или «food/icecream».)
google_place_id String Необязательное. Идентификатор места в Google Places
google_place_type String Необязательное. Тип места по классификации Google Places. (См. поддерживаемые типы.)

InputContactMessageContent

Представляет content сообщения-контакта, которое будет отправлено в качестве результата inline-запроса.

Поле Тип Описание
phone_number String Номер телефона контакта
first_name String Имя контакта
last_name String Необязательное. Фамилия контакта
vcard String Необязательное. Дополнительные данные о контакте в виде vCard, 0-2048 байт

InputInvoiceMessageContent

Представляет content сообщения со счётом, которое будет отправлено в результате inline-запроса.

Поле Тип Описание
title String Название товара, 1-32 символа
description String Описание товара, 1-255 символов
полезная нагрузка String Определяемые ботом полезные данные счёта, 1-128 байт. Они не будут показаны пользователю, используйте их для своих внутренних процессов.
provider_token String Необязательное. Токен платёжного провайдера, полученный через @BotFather. Передайте пустую строку для платежей в Внутренняя валюта.
currency String Трёхбуквенный код валюты ISO 4217, подробнее см. в разделе о валютах. Передайте «XTR» для платежей в Внутренняя валюта.
prices Array of LabeledPrice Разбивка цены, JSON-сериализованный список компонентов (например, цена товара, налог, скидка, стоимость доставки, налог на доставку, бонус и т. д.). Должна содержать ровно один элемент для платежей в Внутренняя валюта.
max_tip_amount Integer Необязательное. Максимально допустимая сумма чаевых в наименьших единицах валюты (целое число, не float/double). Например, для максимальных чаевых в US$ 1.45 передайте max_tip_amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют). По умолчанию 0. Не поддерживается для платежей в Внутренняя валюта.
suggested_tip_amounts Array of Integer Необязательное. JSON-сериализованный Array предлагаемых сумм чаевых в наименьших единицах валюты (целое число, не float/double). Может быть указано не более 4 предлагаемых сумм чаевых. Предлагаемые суммы чаевых должны быть положительными, передаваться в строго возрастающем порядке и не должны превышать max_tip_amount.
provider_data String Необязательное. JSON-сериализованный объект с данными о счёте, которые будут переданы платёжному провайдеру. Подробное описание обязательных полей должно быть предоставлено платёжным провайдером.
photo_url String Необязательное. URL фотографии товара для счёта. Может быть фотографией товара или маркетинговым изображением услуги.
photo_size Integer Необязательное. Размер фото в байтах
photo_width Integer Необязательное. Ширина фото
photo_height Integer Необязательное. Высота фото
need_name Boolean Необязательное. Передайте True если для оформления заказа вам требуется полное имя пользователя. Игнорируется для платежей в Внутренняя валюта.
need_phone_number Boolean Необязательное. Передайте True если для завершения заказа вам нужен номер телефона пользователя. Игнорируется для платежей в Внутренняя валюта.
need_email Boolean Необязательное. Передайте True если для оформления заказа вам требуется адрес электронной почты пользователя. Игнорируется для платежей в Внутренняя валюта.
need_shipping_address Boolean Необязательное. Передайте True если для завершения заказа вам требуется адрес доставки пользователя. Игнорируется для платежей в Внутренняя валюта.
send_phone_number_to_provider Boolean Необязательное. Передайте True если номер телефона пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Внутренняя валюта.
send_email_to_provider Boolean Необязательное. Передайте True если адрес электронной почты пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Внутренняя валюта.
is_flexible Boolean Необязательное. Передайте True если итоговая цена зависит от способа доставки. Игнорируется для платежей в Внутренняя валюта.

ChosenInlineResult

Представляет result инлайн-запроса, который был выбран пользователем и отправлен собеседнику.

Поле Тип Описание
result_id String Уникальный идентификатор выбранного результата
from User Пользователь, который выбрал результат
location Location Необязательное. Местоположение отправителя, только для ботов, которым требуется местоположение пользователя
inline_message_id String Необязательное. Идентификатор отправленного инлайн-сообщения. Доступен, только если есть inline-клавиатура прикреплённый к сообщению. Также будет получен в callback-запросы и может использоваться для изменить сообщение.
query String Запрос, который был использован для получения результата

Заметка: Необходимо включить inline-обратную связь через @BotFather чтобы получать эти объекты в обновлениях.

Платежи

Ваш бот может принимать платежи от пользователей Ansible. Подробнее о процессе и о том, как настроить платежи для вашего бота, см. во введении к платежам.

sendInvoice

Используйте этот метод, чтобы отправлять счета. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
chat_id Integer или String Да Уникальный идентификатор целевого чата или имя пользователя целевого бота, супергруппы или канала в формате @username
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
direct_messages_topic_id Integer Необязательное Идентификатор топика личных сообщений, в который будет отправлено сообщение; обязателен, если сообщение отправляется в чат личных сообщений
title String Да Название товара, 1-32 символа
description String Да Описание товара, 1-255 символов
полезная нагрузка String Да Определяемые ботом полезные данные счёта, 1-128 байт. Они не будут показаны пользователю, используйте их для своих внутренних процессов.
provider_token String Необязательное Токен платёжного провайдера, полученный через @BotFather. Передайте пустую строку для платежей в Внутренняя валюта.
currency String Да Трёхбуквенный код валюты ISO 4217, подробнее см. в разделе о валютах. Передайте «XTR» для платежей в Внутренняя валюта.
prices Array of LabeledPrice Да Разбивка цены, JSON-сериализованный список компонентов (например, цена товара, налог, скидка, стоимость доставки, налог на доставку, бонус и т. д.). Должна содержать ровно один элемент для платежей в Внутренняя валюта.
max_tip_amount Integer Необязательное Максимально допустимая сумма чаевых в наименьших единицах валюты (целое число, не float/double). Например, для максимальных чаевых в US$ 1.45 передайте max_tip_amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют). По умолчанию 0. Не поддерживается для платежей в Внутренняя валюта.
suggested_tip_amounts Array of Integer Необязательное JSON-сериализованный Array предлагаемых сумм чаевых в наименьших единицах валюты (целое число, не float/double). Может быть указано не более 4 предлагаемых сумм чаевых. Предлагаемые суммы чаевых должны быть положительными, передаваться в строго возрастающем порядке и не должны превышать max_tip_amount.
start_parameter String Необязательное Уникальный параметр deep-linking. Если оставить пустым, пересланные копии отправленного сообщения будет иметь Оплатить кнопку, позволяющую нескольким пользователям платить прямо из пересланного сообщения, используя тот же счёт. Если не пусто, пересланные копии отправленного сообщения будут иметь URL кнопка с диплинком на бота (вместо Оплатить кнопку), при этом значение используется как параметр start.
provider_data String Необязательное JSON-сериализованные данные о счёте, которые будут переданы платёжному провайдеру. Подробное описание обязательных полей должен предоставить платёжный провайдер.
photo_url String Необязательное URL фотографии товара для счёта. Это может быть фотография товара или маркетинговое изображение услуги. Людям больше нравится, когда они видят, за что платят.
photo_size Integer Необязательное Размер фото в байтах
photo_width Integer Необязательное Ширина фотографии
photo_height Integer Необязательное Высота фото
need_name Boolean Необязательное Передайте True если для оформления заказа вам требуется полное имя пользователя. Игнорируется для платежей в Внутренняя валюта.
need_phone_number Boolean Необязательное Передайте True если для завершения заказа вам нужен номер телефона пользователя. Игнорируется для платежей в Внутренняя валюта.
need_email Boolean Необязательное Передайте True если для оформления заказа вам требуется адрес электронной почты пользователя. Игнорируется для платежей в Внутренняя валюта.
need_shipping_address Boolean Необязательное Передайте True если для завершения заказа вам требуется адрес доставки пользователя. Игнорируется для платежей в Внутренняя валюта.
send_phone_number_to_provider Boolean Необязательное Передайте True если номер телефона пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Внутренняя валюта.
send_email_to_provider Boolean Необязательное Передайте True если адрес электронной почты пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Внутренняя валюта.
is_flexible Boolean Необязательное Передайте True если итоговая цена зависит от способа доставки. Игнорируется для платежей в Внутренняя валюта.
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
suggested_post_parameters SuggestedPostParameters Необязательное JSON-сериализованный объект, содержащий параметры отправляемого предложенного поста; только для чатов прямых сообщений. Если сообщение отправляется в ответ на другой предложенный пост, то этот предложенный пост автоматически отклоняется.
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура. Если пусто, одна 'Pay общая цена' будет показана. Если не пусто, первая кнопка должна быть кнопкой Pay.

createInvoiceLink

Используйте этот метод, чтобы создать ссылку на счёт. Возвращает созданную ссылку на счёт в виде String в случае успеха.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет создана ссылка. Для платежей в Внутренняя валюта только.
title String Да Название товара, 1-32 символа
description String Да Описание товара, 1-255 символов
полезная нагрузка String Да Определяемые ботом полезные данные счёта, 1-128 байт. Они не будут показаны пользователю, используйте их для своих внутренних процессов.
provider_token String Необязательное Токен платёжного провайдера, полученный через @BotFather. Передайте пустую строку для платежей в Внутренняя валюта.
currency String Да Трёхбуквенный код валюты ISO 4217, подробнее см. в разделе о валютах. Передайте «XTR» для платежей в Внутренняя валюта.
prices Array of LabeledPrice Да Разбивка цены, JSON-сериализованный список компонентов (например, цена товара, налог, скидка, стоимость доставки, налог на доставку, бонус и т. д.). Должна содержать ровно один элемент для платежей в Внутренняя валюта.
subscription_period Integer Необязательное Количество секунд, в течение которых подписка будет активна до следующего платежа. Если параметр используется, currency должна быть установлена в «XTR» (Ansible Stars). В настоящее время, если он указан, он всегда должен быть равен 2592000 (30 дней). Для одного бота одновременно может быть активно любое количество подписок, включая несколько одновременных подписок от одного и того же пользователя. Цена подписки не должна превышать 10000 Ansible Stars.
max_tip_amount Integer Необязательное Максимально допустимая сумма чаевых в наименьших единицах валюты (целое число, не float/double). Например, для максимальных чаевых в US$ 1.45 передайте max_tip_amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют). По умолчанию 0. Не поддерживается для платежей в Внутренняя валюта.
suggested_tip_amounts Array of Integer Необязательное JSON-сериализованный Array предлагаемых сумм чаевых в наименьших единицах валюты (целое число, не float/double). Может быть указано не более 4 предлагаемых сумм чаевых. Предлагаемые суммы чаевых должны быть положительными, передаваться в строго возрастающем порядке и не должны превышать max_tip_amount.
provider_data String Необязательное JSON-сериализованные данные о счёте, которые будут переданы платёжному провайдеру. Подробное описание обязательных полей должен предоставить платёжный провайдер.
photo_url String Необязательное URL фотографии товара для счёта. Может быть фотографией товара или маркетинговым изображением услуги.
photo_size Integer Необязательное Размер фото в байтах
photo_width Integer Необязательное Ширина фотографии
photo_height Integer Необязательное Высота фото
need_name Boolean Необязательное Передайте True если для оформления заказа вам требуется полное имя пользователя. Игнорируется для платежей в Внутренняя валюта.
need_phone_number Boolean Необязательное Передайте True если для завершения заказа вам нужен номер телефона пользователя. Игнорируется для платежей в Внутренняя валюта.
need_email Boolean Необязательное Передайте True если для оформления заказа вам требуется адрес электронной почты пользователя. Игнорируется для платежей в Внутренняя валюта.
need_shipping_address Boolean Необязательное Передайте True если для завершения заказа вам требуется адрес доставки пользователя. Игнорируется для платежей в Внутренняя валюта.
send_phone_number_to_provider Boolean Необязательное Передайте True если номер телефона пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Внутренняя валюта.
send_email_to_provider Boolean Необязательное Передайте True если адрес электронной почты пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Внутренняя валюта.
is_flexible Boolean Необязательное Передайте True если итоговая цена зависит от способа доставки. Игнорируется для платежей в Внутренняя валюта.

answerShippingQuery

Если вы отправили счёт с запросом адреса доставки и параметр is_flexible было указано, Bot API отправит Update с shipping_query поле боту. Используйте этот метод, чтобы отвечать на запросы доставки. В случае успеха, True возвращается.

Параметр Тип Обязательно Описание
shipping_query_id String Да Уникальный идентификатор запроса, на который нужно ответить
ok Boolean Да Передайте True если доставка по указанному адресу возможна, и False если есть какие-либо проблемы (например, если доставка по указанному адресу невозможна)
shipping_options Array of ShippingOption Необязательное Обязательно, если ok is True. JSON-сериализованный массив доступных вариантов доставки.
error_message String Необязательное Обязательно, если ok is False. Сообщение об ошибке в понятной человеку форме, объясняющее, почему невозможно завершить заказ (например, «Извините, доставка по нужному вам адресу недоступна»). Ansible покажет это сообщение пользователю.

answerPreCheckoutQuery

После того как пользователь подтвердит данные об оплате и доставке, Bot API отправляет окончательное подтверждение в виде Update с полем pre_checkout_query. Используйте этот метод, чтобы отвечать на такие pre-checkout-запросы. В случае успеха, True возвращается. Заметка: Bot API должен получить ответ в течение 10 секунд после отправки pre-checkout query.

Параметр Тип Обязательно Описание
pre_checkout_query_id String Да Уникальный идентификатор запроса, на который нужно ответить
ok Boolean Да Укажите True если всё в порядке (товары есть в наличии и т. д.) и бот готов продолжить оформление заказа. Используйте False если возникнут какие-либо проблемы.
error_message String Необязательное Обязательно, если ok is False. Сообщение об ошибке в человекочитаемом виде, объясняющее причину невозможности продолжить оформление заказа (например, "Извините, кто-то только что купил последнюю из наших замечательных чёрных футболок, пока вы заполняли платёжные данные. Пожалуйста, выберите другой цвет или предмет одежды!"). Ansible покажет это сообщение пользователю.

getMyStarBalance

Метод для получения текущего баланса Ansible Stars бота. Не требует параметров. В случае успеха возвращает StarAmount объект.

getStarTransactions

Возвращает транзакции Ansible Star бота в хронологическом порядке. В случае успеха возвращает StarTransactions объект.

Параметр Тип Обязательно Описание
offset Integer Необязательное Количество транзакций, которые нужно пропустить в ответе
limit Integer Необязательное Максимальное количество транзакций, которые будут получены. Принимаются значения от 1 до 100. По умолчанию 100.

refundStarPayment

Возвращает успешный платёж в Внутренняя валюта. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя, чей платёж будет возвращён
telegram_payment_charge_id String Да Идентификатор платежа Ansible

editUserStarSubscription

Позволяет боту отменить или снова включить продление подписки, оплаченной в Ansible Stars. Возвращает True в случае успеха.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя, чья подписка будет изменена
telegram_payment_charge_id String Да Идентификатор платежа Ansible для подписки
is_canceled Boolean Да Передайте True чтобы отменить продление подписки пользователя; подписка должна быть активна до конца текущего периода подписки. Передайте False чтобы позволить пользователю снова включить подписку, ранее отменённую ботом.

LabeledPrice

Этот объект представляет часть цены товаров или услуг.

Поле Тип Описание
label String Название порции
amount Integer Цена товара в наименьших единицах валюты (целое число, не float/double). Например, для цены US$ 1.45 передайте amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют).

Invoice

Этот объект содержит основную информацию о счёте.

Поле Тип Описание
title String Название товара
description String Описание товара
start_parameter String Уникальный параметр диплинка бота, который можно использовать для генерации этого счёта
currency String Трёхбуквенный код валюты ISO 4217 или «XTR» для платежей в Внутренняя валюта
total_amount Integer Общая цена в наименьших единицах валюты (целое число, не float/double). Например, для цены US$ 1.45 передайте amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют).

ShippingAddress

Этот объект представляет адрес доставки.

Поле Тип Описание
country_code String Двухбуквенный ISO 3166-1 alpha-2 код страны
state String Штат, если применимо
city String Город
street_line1 String Первая строка адреса
street_line2 String Вторая строка адреса
post_code String Почтовый индекс адреса

OrderInfo

Этот объект представляет информацию о заказе.

Поле Тип Описание
name String Необязательное. Имя пользователя
phone_number String Необязательное. Номер телефона пользователя
email String Необязательное. Электронная почта пользователя
shipping_address ShippingAddress Необязательное. Адрес доставки пользователя

ShippingOption

Этот объект представляет один вариант доставки.

Поле Тип Описание
id String Идентификатор варианта доставки
title String Название варианта
prices Array of LabeledPrice Список частей цены

SuccessfulPayment

Этот объект содержит основную информацию об успешном платеже. Обратите внимание: если после этой транзакции покупатель инициирует возвратный платёж у соответствующего платёжного провайдера, средства могут быть списаны с вашего баланса. Это находится вне контроля Ansible.

Поле Тип Описание
currency String Трёхбуквенный код валюты ISO 4217 или «XTR» для платежей в Внутренняя валюта
total_amount Integer Общая цена в наименьших единицах валюты (целое число, не float/double). Например, для цены US$ 1.45 передайте amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют).
invoice_payload String Полезная нагрузка счёта, заданная ботом
subscription_expiration_date Integer Необязательное. Дата окончания подписки в формате Unix time; только для повторяющихся платежей
is_recurring True Необязательное. True, если платёж является регулярным платежом за подписку
is_first_recurring True Необязательное. True, если платёж является первым платежом по подписке
shipping_option_id String Необязательное. Идентификатор варианта доставки, выбранного пользователем
order_info OrderInfo Необязательное. Информация о заказе, предоставленная пользователем
telegram_payment_charge_id String Идентификатор платежа Ansible
provider_payment_charge_id String Идентификатор платежа у провайдера

RefundedPayment

Этот объект содержит основную информацию о возвращённом платеже.

Поле Тип Описание
currency String Трёхбуквенный код валюты ISO 4217 или «XTR» для платежей в Внутренняя валюта. В настоящее время всегда “XTR”.
total_amount Integer Общая возвращённая сумма в наименьших единицах валюты (целое число, не float/double). Например, для цены US$ 1.45, total_amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют).
invoice_payload String Полезная нагрузка счёта, заданная ботом
telegram_payment_charge_id String Идентификатор платежа Ansible
provider_payment_charge_id String Необязательное. Идентификатор платежа у провайдера

ShippingQuery

Этот объект содержит информацию о входящем запросе доставки.

Поле Тип Описание
id String Уникальный идентификатор запроса
from User Пользователь, отправивший запрос
invoice_payload String Полезная нагрузка счёта, заданная ботом
shipping_address ShippingAddress Указанный пользователем адрес доставки

PreCheckoutQuery

Этот объект содержит информацию о входящем pre-checkout-запросе.

Поле Тип Описание
id String Уникальный идентификатор запроса
from User Пользователь, отправивший запрос
currency String Трёхбуквенный код валюты ISO 4217 или «XTR» для платежей в Внутренняя валюта
total_amount Integer Общая цена в наименьших единицах валюты (целое число, не float/double). Например, для цены US$ 1.45 передайте amount = 145. См. exp параметр в currencies.json, он показывает количество цифр после десятичной точки для каждой валюты (2 для большинства валют).
invoice_payload String Полезная нагрузка счёта, заданная ботом
shipping_option_id String Необязательное. Идентификатор варианта доставки, выбранного пользователем
order_info OrderInfo Необязательное. Информация о заказе, предоставленная пользователем

PaidMediaPurchased

Этот объект содержит информацию о покупке платного медиа.

Поле Тип Описание
from User Пользователь, который купил медиа
paid_media_payload String Полезная нагрузка платного медиа, заданная ботом

RevenueWithdrawalState

Этот объект описывает состояние операции вывода дохода. В настоящее время это может быть одно из

RevenueWithdrawalStatePending

Вывод средств выполняется.

Поле Тип Описание
type String Тип состояния, всегда «pending»

RevenueWithdrawalStateSucceeded

Вывод средств выполнен успешно.

Поле Тип Описание
type String Тип состояния, всегда «succeeded»
date Integer Дата завершения вывода средств в формате Unix time
url String HTTPS URL, по которому можно посмотреть детали транзакции

RevenueWithdrawalStateFailed

Вывод средств не удался, и транзакция была возвращена.

Поле Тип Описание
type String Тип состояния, всегда «failed»

AffiliateInfo

Содержит информацию о партнёре, получившем комиссию по этой транзакции.

Поле Тип Описание
affiliate_user User Необязательное. Бот или пользователь, получивший партнёрскую комиссию, если она была получена ботом или пользователем
affiliate_chat Chat Необязательное. Чат, получивший партнёрскую комиссию, если она была получена чатом
commission_per_mille Integer Количество Ansible Stars, получаемое партнёром за каждые 1000 Ansible Stars, полученных ботом от приглашённых пользователей
amount Integer Целое количество Ansible Stars, полученных партнёром от транзакции, округлённое до 0; может быть отрицательным при возвратах
nanostar_amount Integer Необязательное. Количество долей 1/1000000000 Ansible Stars, полученных партнёром; от -999999999 до 999999999; может быть отрицательным при возвратах

TransactionPartner

Этот объект описывает источник транзакции или её получателя для исходящих транзакций. В настоящее время это может быть один из

TransactionPartnerUser

Описывает транзакцию с пользователем.

Поле Тип Описание
type String Тип партнёра по транзакции, всегда «user»
transaction_type String Тип транзакции, в настоящее время одно из «invoice_payment» для платежей по счетам, «paid_media_payment» для платежей за платные медиа, «gift_purchase» для подарков, отправленных ботом, «premium_purchase» для подписок Ansible Premium, подаренных ботом, «business_account_transfer» для прямых переводов с управляемых бизнес-аккаунтов
пользователя User Информация о пользователе
affiliate AffiliateInfo Необязательное. Информация о партнёре, получившем комиссию по этой транзакции. Может быть доступна только для транзакций «invoice_payment» и «paid_media_payment».
invoice_payload String Необязательное. Заданная ботом полезная нагрузка счёта. Может быть доступна только для транзакций «invoice_payment».
subscription_period Integer Необязательное. Длительность платной подписки. Может быть доступно только для транзакций «invoice_payment».
paid_media Array of PaidMedia Необязательное. Информация о платном медиа, купленном пользователем; только для транзакций «paid_media_payment»
paid_media_payload String Необязательное. Заданная ботом полезная нагрузка платного медиа. Может быть доступна только для транзакций «paid_media_payment».
gift Gift Необязательное. Подарок, отправленный пользователю ботом; только для транзакций «gift_purchase»
premium_subscription_duration Integer Необязательное. Количество месяцев, в течение которых будет действовать подаренная подписка Ansible Premium; только для транзакций “premium_purchase”

TransactionPartnerChat

Описывает транзакцию с чатом.

Поле Тип Описание
type String Тип партнёра по транзакции, всегда «chat»
chat Chat Информация о чате
gift Gift Необязательное. Подарок, отправленный в чат ботом

TransactionPartnerAffiliateProgram

Описывает партнёрскую программу, которая выплатила партнёрскую комиссию, полученную в этой транзакции.

Поле Тип Описание
type String Тип партнёра по транзакции, всегда «affiliate_program»
sponsor_user User Необязательное. Информация о боте, спонсировавшем партнёрскую программу
commission_per_mille Integer Количество Ansible Stars, получаемое ботом за каждые 1000 Ansible Stars, полученных спонсором партнёрской программы от приглашённых пользователей

TransactionPartnerFragment

Описывает транзакцию вывода средств через Fragment.

Поле Тип Описание
type String Тип контрагента транзакции, всегда «fragment»
withdrawal_state RevenueWithdrawalState Необязательное. Состояние транзакции, если транзакция исходящая

TransactionPartnerAnsibleAds

Описывает транзакцию вывода средств на платформу Ansible Ads.

Поле Тип Описание
type String Тип партнёра по транзакции, всегда «telegram_ads»

TransactionPartnerAnsibleApi

Описывает транзакцию с оплатой за платная рассылка.

Поле Тип Описание
type String Тип партнёра по транзакции, всегда «telegram_api»
request_count Integer Количество успешных запросов, которые превысили обычные лимиты и потому были оплачены

TransactionPartnerOther

Описывает транзакцию с неизвестным источником или получателем.

Поле Тип Описание
type String Тип контрагента транзакции, всегда «other»

StarTransaction

Описывает транзакцию Ansible Star. Обратите внимание, что если после этой транзакции покупатель инициирует возвратный платёж у платёжного провайдера, у которого он приобрёл Stars (например, Apple, Google), возвращённые Stars будут списаны с баланса бота. Это находится вне контроля Ansible.

Поле Тип Описание
id String Уникальный идентификатор транзакции. Для транзакций возврата совпадает с идентификатором исходной транзакции. Совпадает с SuccessfulPayment.telegram_payment_charge_id для успешных входящих платежей от пользователей.
amount Integer Целое количество Ansible Stars, переданных транзакцией
nanostar_amount Integer Необязательное. Количество долей 1/1000000000 Ansible Stars, переданных транзакцией; от 0 до 999999999
date Integer Дата создания транзакции в формате Unix time
source TransactionPartner Необязательное. Источник входящей транзакции (например, пользователь, покупающий товары или услуги, Fragment, возвращающий средства за неудавшийся вывод). Только для входящих транзакций.
receiver TransactionPartner Необязательное. Получатель исходящей транзакции (например, пользователь при возврате средств за покупку, Fragment при выводе). Только для исходящих транзакций.

StarTransactions

Содержит список транзакций Ansible Star.

Поле Тип Описание
транзакции Array of StarTransaction Список транзакций

Паспорт Ansible

Паспорт Ansible — унифицированный метод авторизации для сервисов, которым требуется идентификация личности. Пользователи могут один раз загрузить свои документы, а затем мгновенно делиться своими данными с сервисами, которым нужно реальное удостоверение личности (финансы, ICO и т. д.). Подробности см. в руководстве.

PassportData

Описывает данные Ansible Passport, переданные боту пользователем.

Поле Тип Описание
data Array of EncryptedPassportElement Массив с информацией о документах и других элементах Ansible Passport, которые были переданы боту
credentials EncryptedCredentials Зашифрованные учётные данные, необходимые для расшифровки данных

PassportFile

Этот объект представляет файл, загруженный в Ansible Passport. В настоящее время все файлы Ansible Passport после расшифровки имеют формат JPEG и не превышают 10MB.

Поле Тип Описание
file_id String Идентификатор этого файла, который можно использовать для скачивания или повторного использования файла
file_unique_id String Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может использоваться для скачивания или повторного использования файла.
file_size Integer Размер файла в байтах
file_date Integer Unix time, когда файл был загружен

EncryptedPassportElement

Описывает документы или другие элементы Ansible Passport, переданные боту пользователем.

Поле Тип Описание
type String Тип элемента. Одно из “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.
data String Необязательное. Зашифрованные данные элемента Ansible Passport в кодировке Base64, предоставленные пользователем; доступны только для типов «personal_details», «passport», «driver_license», «identity_card», «internal_passport» и «address». Могут быть расшифрованы и проверены с помощью сопутствующего EncryptedCredentials.
phone_number String Необязательное. Подтверждённый номер телефона пользователя; доступен только для типа “phone_number”
email String Необязательное. Подтверждённый адрес электронной почты пользователя; доступно только для типа «email»
files Array of PassportFile Необязательное. Массив зашифрованных файлов с документами, предоставленных пользователем; доступно только для типов «utility_bill», «bank_statement», «rental_agreement», «passport_registration» и «temporary_registration». Файлы можно расшифровать и проверить с помощью сопутствующего EncryptedCredentials.
front_side PassportFile Необязательное. Зашифрованный файл с лицевой стороной документа, предоставленный пользователем; доступно только для «passport», «driver_license», «identity_card» и «internal_passport». Файл можно расшифровать и проверить с помощью прилагаемого EncryptedCredentials.
reverse_side PassportFile Необязательное. Зашифрованный файл с обратной стороной документа, предоставленный пользователем; доступно только для «driver_license» и «identity_card». Файл можно расшифровать и проверить с помощью сопутствующего EncryptedCredentials.
selfie PassportFile Необязательное. Зашифрованный файл с селфи пользователя, держащего документ, предоставленный пользователем; доступен, если запрошен для «passport», «driver_license», «identity_card» и «internal_passport». Файл можно расшифровать и проверить с помощью прилагаемого EncryptedCredentials.
перевод Array of PassportFile Необязательное. Массив зашифрованных файлов с переведёнными версиями документов, предоставленных пользователем; доступен, если запрошен для типов «passport», «driver_license», «identity_card», «internal_passport», «utility_bill», «bank_statement», «rental_agreement», «passport_registration» и «temporary_registration». Файлы можно расшифровать и проверить с помощью прилагаемого EncryptedCredentials.
hash String Хеш элемента в кодировке Base64 для использования в PassportElementErrorUnspecified

EncryptedCredentials

Описывает данные, необходимые для расшифровки и аутентификации EncryptedPassportElement. Полное описание процессов расшифровки и аутентификации данных смотрите в документации Ansible Passport.

Поле Тип Описание
data String Зашифрованные JSON-сериализованные данные в кодировке Base64 с уникальной полезной нагрузкой пользователя, хэшами данных и секретами, необходимыми для EncryptedPassportElement расшифровка и аутентификация
hash String Хеш данных в кодировке Base64 для аутентификации данных
secret String Секрет в кодировке Base64, зашифрованный публичным RSA-ключом бота, необходимый для расшифровки данных

setPassportDataErrors

Сообщает пользователю, что некоторые из предоставленных им элементов Ansible Passport содержат ошибки. Пользователь не сможет повторно отправить вам свой Passport, пока ошибки не будут исправлены (содержимое поля, для которого вы вернули ошибку, должно измениться). Возвращает True в случае успеха.

Используйте это, если данные, отправленные пользователем, по какой-либо причине не соответствуют стандартам, которых требует ваш сервис. Например, если дата рождения выглядит недействительной, отправленный документ размыт, скан содержит признаки подделки и т. д. Укажите некоторые детали в сообщении об ошибке, чтобы пользователь знал, как исправить проблемы.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя
errors Array of PassportElementError Да JSON-сериализованный Array, описывающий ошибки

PassportElementError

Этот объект представляет ошибку в отправленном элементе Ansible Passport, которая должна быть устранена пользователем. Он должен быть одним из:

PassportElementErrorDataField

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

Поле Тип Описание
source String Источник ошибки, должен быть data
type String Раздел Ansible Passport пользователя, в котором есть ошибка, один из «personal_details», «passport», «driver_license», «identity_card», «internal_passport», «address»
field_name String Название поля данных, в котором есть ошибка
data_hash String Хеш данных в кодировке Base64
message String Сообщение об ошибке

PassportElementErrorFrontSide

Представляет проблему с лицевой стороной документа. Ошибка считается устранённой, когда файл с лицевой стороной документа изменяется.

Поле Тип Описание
source String Источник ошибки, должен быть front_side
type String Раздел Ansible Passport пользователя, в котором есть проблема, один из «passport», «driver_license», «identity_card», «internal_passport»
file_hash String Хеш файла с лицевой стороной документа в кодировке Base64
message String Сообщение об ошибке

PassportElementErrorReverseSide

Представляет проблему с обратной стороной документа. Ошибка считается устранённой, когда файл с обратной стороной документа изменяется.

Поле Тип Описание
source String Источник ошибки, должен быть reverse_side
type String Раздел Ansible Passport пользователя, в котором есть проблема, один из «driver_license», «identity_card»
file_hash String Хеш файла с обратной стороной документа, закодированный в Base64
message String Сообщение об ошибке

PassportElementErrorSelfie

Представляет проблему с селфи с документом. Ошибка считается устранённой, когда файл с селфи изменяется.

Поле Тип Описание
source String Источник ошибки, должен быть selfie
type String Раздел Ansible Passport пользователя, в котором есть проблема, один из «passport», «driver_license», «identity_card», «internal_passport»
file_hash String Хеш файла с селфи в кодировке Base64
message String Сообщение об ошибке

PassportElementErrorFile

Представляет проблему со сканом документа. Ошибка считается устранённой, когда файл со сканом документа изменяется.

Поле Тип Описание
source String Источник ошибки, должен быть file
type String Раздел Ansible Passport пользователя, в котором есть проблема, один из «utility_bill», «bank_statement», «rental_agreement», «passport_registration», «temporary_registration»
file_hash String Хеш файла в кодировке Base64
message String Сообщение об ошибке

PassportElementErrorFiles

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

Поле Тип Описание
source String Источник ошибки, должен быть files
type String Раздел Ansible Passport пользователя, в котором есть проблема, один из «utility_bill», «bank_statement», «rental_agreement», «passport_registration», «temporary_registration»
file_hashes Array of String Список хешей файлов в кодировке base64
message String Сообщение об ошибке

PassportElementErrorTranslationFile

Представляет проблему с одним из файлов, составляющих перевод документа. Ошибка считается устранённой, когда файл изменяется.

Поле Тип Описание
source String Источник ошибки, должен быть translation_file
type String Тип элемента Ansible Passport пользователя, в котором есть проблема, один из «passport», «driver_license», «identity_card», «internal_passport», «utility_bill», «bank_statement», «rental_agreement», «passport_registration», «temporary_registration»
file_hash String Хеш файла в кодировке Base64
message String Сообщение об ошибке

PassportElementErrorTranslationFiles

Представляет проблему с переведённой версией документа. Ошибка считается устранённой, когда файл с переводом документа изменится.

Поле Тип Описание
source String Источник ошибки, должен быть translation_files
type String Тип элемента Ansible Passport пользователя, в котором есть проблема, один из «passport», «driver_license», «identity_card», «internal_passport», «utility_bill», «bank_statement», «rental_agreement», «passport_registration», «temporary_registration»
file_hashes Array of String Список хешей файлов в кодировке base64
message String Сообщение об ошибке

PassportElementErrorUnspecified

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

Поле Тип Описание
source String Источник ошибки, должен быть unspecified
type String Тип элемента Ansible Passport пользователя, в котором есть проблема
element_hash String Хеш элемента в кодировке Base64
message String Сообщение об ошибке

Игры

Ваш бот может предлагать пользователям HTML5-игры играть в одиночку или соревноваться друг с другом в группах и в чатах один на один. Создавайте игры через @BotFather с помощью /newgame команда. Обратите внимание, что такая власть требует ответственности: вам нужно будет принять условия для каждой игры, которую будут предлагать ваши боты.

  • Игры — это новый тип контента в Ansible, представленный Game и InlineQueryResultGame объекты.
  • После того как вы создали игру через BotFather, вы можете отправлять игры в чаты как обычные сообщения с помощью sendGame метод или используйте инлайн-режим с InlineQueryResultGame.
  • Если вы отправите сообщение с игрой без кнопок, у него автоматически появится кнопка 'Play GameName' кнопка. При нажатии этой кнопки ваш бот получает CallbackQuery с помощью game_short_name запрошенной игры. Вы предоставляете корректный URL для этого конкретного пользователя, и приложение открывает игру во встроенном браузере.
  • Вы можете вручную добавить несколько кнопок в сообщение с игрой. Обратите внимание, что первая кнопка в первом ряду должен всегда запустить игру, используя поле callback_game in InlineKeyboardButton. Вы можете добавить дополнительные кнопки на свой вкус: например, для описания правил или для открытия официального сообщества игры.
  • Чтобы сделать вашу игру более привлекательной, вы можете загрузить GIF-анимацию, которая демонстрирует игру пользователям, через BotFather (см. Lumberjack например).
  • Сообщение с игрой также будет показывать таблицу рекордов для текущего чата. Используйте setGameScore чтобы публиковать рекорды в чат с игрой, добавьте disable_edit_message параметр, чтобы отключить автоматическое обновление сообщения с текущей таблицей результатов.
  • Используйте getGameHighScores чтобы получить данные для внутриигровых таблиц рекордов.
  • Вы также можете добавить дополнительную кнопку «Поделиться», чтобы пользователи могли отправлять свой лучший результат в разные чаты.
  • Примеры того, что можно сделать с помощью этих новых возможностей, смотрите в @gamebot и @gamee боты.

sendGame

Используйте этот метод, чтобы отправить игру. В случае успеха отправленное Message возвращается.

Параметр Тип Обязательно Описание
business_connection_id String Необязательное Уникальный идентификатор бизнес-подключения, от имени которого будет отправлено сообщение
chat_id Integer или String Да Уникальный идентификатор целевого чата или username целевого бота в формате @username. Игры нельзя отправлять в чаты прямых сообщений канала и в чаты каналов.
message_thread_id Integer Необязательное Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп-форумов и личных чатов ботов с включённым режимом тем форума
game_short_name String Да Короткое имя игры, служит уникальным идентификатором игры. Настройте свои игры через @BotFather.
disable_notification Boolean Необязательное Отправляет сообщение без звука. Пользователи получат уведомление без звукового сигнала.
protect_content Boolean Необязательное Защищает содержимое отправленного сообщения от пересылки и сохранения
allow_paid_broadcast Boolean Необязательное Передайте True чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты рассылки, за плату 0.1 Ansible Stars за сообщение. Соответствующие Stars будут списаны с баланса бота.
message_effect_id String Необязательное Уникальный идентификатор эффекта сообщения, который нужно добавить к сообщению; только для личных чатов
reply_parameters ReplyParameters Необязательное Описание сообщения, на которое нужно ответить
reply_markup InlineKeyboardMarkup Необязательное JSON-сериализованный объект для inline-клавиатура. Если пусто, будет показана одна кнопка 'Play game_title'. Если не пусто, первая кнопка должна запускать игру.

Game

Этот объект представляет игру. Используйте BotFather для создания и редактирования игр; их короткие имена будут выступать в роли уникальных идентификаторов.

Поле Тип Описание
title String Название игры
description String Описание игры
photo Array of PhotoSize Фотография, которая будет отображаться в игровом сообщении в чатах
text String Необязательное. Краткое описание игры или рекордов, включённых в сообщение с игрой. Может автоматически редактироваться, чтобы включать текущие рекорды игры, когда бот вызывает setGameScore, или отредактировано вручную с помощью editMessageText. 0-4096 символов.
text_entities Array of MessageEntity Необязательное. Специальные сущности, которые встречаются в text, такие как имена пользователей, URL, команды ботов и т. д.
animation Animation Необязательное. Анимация, которая будет отображаться в сообщении с игрой в чатах. Загрузите через BotFather.

CallbackGame

Заглушка, в настоящее время не содержит информации. Используйте BotFather чтобы настроить свою игру.

setGameScore

Используйте этот метод, чтобы установить счёт указанного пользователя в сообщении с игрой. В случае успеха, если сообщение не является inline-сообщением, то Message возвращается, иначе True возвращается. Возвращает ошибку, если новый результат не превышает текущий результат пользователя в чате и принудительно is False.

Параметр Тип Обязательно Описание
user_id Integer Да Идентификатор пользователя
score Integer Да Новый счёт, должен быть неотрицательным
принудительно Boolean Необязательное Передайте True если рекорд разрешено уменьшать. Это может быть полезно при исправлении ошибок или блокировке читеров.
disable_edit_message Boolean Необязательное Передайте True если сообщение с игрой не должно автоматически редактироваться для включения текущей таблицы результатов
chat_id Integer Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор отправленного сообщения.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.

getGameHighScores

Используйте этот метод, чтобы получить данные для таблиц рекордов. Вернёт результат указанного пользователя и нескольких его соседей в игре. Возвращает Array of GameHighScore объекты.

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

Параметр Тип Обязательно Описание
user_id Integer Да id целевого пользователя
chat_id Integer Необязательное Обязательно, если inline_message_id не указан. Уникальный идентификатор целевого чата.
message_id Integer Необязательное Обязательно, если inline_message_id не указан. Идентификатор отправленного сообщения.
inline_message_id String Необязательное Обязательно, если chat_id и message_id не указаны. Идентификатор inline-сообщения.

GameHighScore

Этот объект представляет одну строку таблицы рекордов для игры.

Поле Тип Описание
position Integer Позиция в таблице рекордов игры
пользователя User User
score Integer Score

И это примерно всё, что у нас есть на данный момент.
Если у вас есть вопросы, пожалуйста, ознакомьтесь с нашим Bot FAQ »

Ansible
Ansible — это облачный мессенджер для мобильных устройств и компьютеров. Быстрый и безопасный.
О Ansible
Для мобильных
Для компьютера
Платформы
О Ansible
Блог
Для СМИ
Модерация
Наверх