Добро пожаловать в мир Telegram-ботов без языковых преград! Эта страница — ваш путеводитель по официальному Telegram Bot API, адаптированный для русскоязычных разработчиков. Здесь вы найдете всё: от настройки авторизации до интеграции платежей. А если захотите проверить оригинал — он всегда доступен на официальном сайте.
Недавние изменения
Подпишитесь на @BotNews, чтобы первыми узнавать о последних обновлениях и присоединяйтесь к обсуждению в чате @BotTalk. А еще вы можете найти последние новости на нашем сайте или обсудить обновления в нашем чат @botphp_ru.
Выполнение запросов
Все запросы к Telegram Bot API должны выполняться по HTTPS и представлены в следующем формате: https://api.telegram.org/bot<token>/METHOD_NAME. Например:
https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMeМы поддерживаем GET и POST HTTP методы. Мы поддерживаем четыре способа передачи параметров в запросах Bot API:
- URL строка запроса
- application/x-www-form-urlencoded
- application/json (за исключением загрузки файлов)
- multipart/form-data (используйте для загрузки файлов)
Ответ содержит объект JSON, который всегда имеет логическое поле 'ok' и может иметь необязательное строковое поле 'description' с описанием результата, понятным человеку. Если 'ok' равно True, запрос был успешным, и результат запроса можно найти в поле 'result'. В случае неудачного запроса 'ok' равно false, и ошибка объясняется в 'description'. Также возвращается целочисленное поле 'error_code', но его содержимое может измениться в будущем. Некоторые ошибки также могут иметь необязательное поле 'parameters' типа ResponseParameters, которое может помочь автоматически обработать ошибку.
- Все методы в Bot API нечувствительны к регистру.
- Все запросы должны быть выполнены с использованием UTF-8.
Отправка запросов при получении обновлений
Если вы используете вебхуки, вы можете выполнить запрос к Bot API, отправляя ответ на вебхук. Используйте либо application/json, либо application/x-www-form-urlencoded, либо multipart/form-data в качестве типа содержимого ответа для передачи параметров. Укажите метод, который должен быть вызван, в параметре method запроса. Невозможно узнать, был ли такой запрос успешным, или получить его результат.
Пожалуйста, смотрите наш FAQ для примеров.
Использование локального сервера Bot API
Исходный код сервера Bot API доступен по адресу telegram-bot-api. Вы можете запустить его локально и отправлять запросы на свой собственный сервер вместо https://api.telegram.org. Если вы переключитесь на локальный сервер Bot API, ваш бот сможет:
- Скачивать файлы без ограничения по размеру.
- Загружать файлы размером до 2000 МБ.
- Загружать файлы, используя их локальный путь и схему URI файла.
- Использовать HTTP URL для вебхука.
- Использовать любой локальный IP-адрес для вебхука.
- Использовать любой порт для вебхука.
- Устанавливать max_webhook_connections до 100000.
- Получать абсолютный локальный путь в качестве значения поля file_path без необходимости загружать файл после запроса getFile.
Нужен ли мне локальный Bot API сервер
Большинство ботов будет работать нормально с конфигурацией по умолчанию, на наших серверах. Но если вы считаете, что вам нужны эти функции, вы можете в любой момент перейти на свой собственный сервер.
Получение обновлений
Существует два взаимоисключающих способа получения обновлений для вашего бота - с одной стороны, метод getUpdates, а с другой - webhooks. Входящие обновления хранятся на сервере до тех пор, пока бот не получит их любым из способов, но они не будут храниться дольше 24 часов.
Независимо от того, какой вариант вы выберете, вы получите сериализованные в JSON объекты Update в результате.
Обновление
Этот объект представляет собой входящее обновление.
В любом данном обновлении может присутствовать не более одного из необязательных параметров.
| Поле | Тип | Описание |
|---|---|---|
| update_id | Целое число | Уникальный идентификатор обновления. Идентификаторы обновлений начинаются с определенного положительного числа и увеличиваются последовательно. Этот идентификатор становится особенно полезным, если вы используете вебхуки, так как он позволяет игнорировать повторяющиеся обновления или восстанавливать правильную последовательность обновлений, если они выходят из порядка. Если в течение как минимум недели не будет новых обновлений, то идентификатор следующего обновления будет выбран случайным образом вместо последовательного. |
| message | Сообщение | Необязательно. Новое входящее сообщение любого типа - текст, фото, стикер и т.д. |
| edited_message | Сообщение | Необязательно. Новая версия сообщения, известная боту, которая была отредактирована. Это обновление может иногда быть вызвано изменениями в полях сообщения, которые либо недоступны, либо активно не используются вашим ботом. |
| channel_post | Сообщение | Необязательно. Новая входящая публикация канала любого типа - текст, фото, стикер и т.д. |
| edited_channel_post | Сообщение | Необязательно. Новая версия публикации канала, известная боту, которая была отредактирована. Это обновление может иногда быть вызвано изменениями в полях сообщения, которые либо недоступны, либо активно не используются вашим ботом. |
| business_connection | BusinessConnection | Необязательно. Бот был подключен или отключен от бизнес-аккаунта, или пользователь отредактировал существующее соединение с ботом. |
| business_message | Сообщение | Необязательно. Новое сообщение от подключенного бизнес-аккаунта. |
| edited_business_message | Сообщение | Необязательно. Новая версия сообщения от подключенного бизнес-аккаунта. |
| deleted_business_messages | BusinessMessagesDeleted | Необязательно. Сообщения были удалены из подключенного бизнес-аккаунта. |
| message_reaction | MessageReactionUpdated | Необязательно. Реакция на сообщение была изменена пользователем. Бот должен быть администратором в чате и явно указать "message_reaction" в списке allowed_updates, чтобы получать эти обновления. Обновление не будет получено для реакций, установленных ботами. |
| message_reaction_count | MessageReactionCountUpdated | Необязательно. Реакции на сообщение с анонимными реакциями были изменены. Бот должен быть администратором в чате и явно указать "message_reaction_count" в списке allowed_updates, чтобы получать эти обновления. Обновления группируются и могут быть отправлены с задержкой до нескольких минут. |
| inline_query | InlineQuery | Необязательно. Новой входящий инлайн запрос. |
| chosen_inline_result | ChosenInlineResult | Необязательно. Результат инлайн запроса, который был выбран пользователем и отправлен его собеседнику. Пожалуйста, ознакомьтесь с нашей документацией по сбору отзывов для получения деталей о том, как включить эти обновления для вашего бота. |
| callback_query | CallbackQuery | Необязательно. Новый входящий запрос обратного вызова. |
| shipping_query | ShippingQuery | Необязательно. Новый входящий запрос на доставку. Только для счетов с гибкой ценой. |
| pre_checkout_query | PreCheckoutQuery | Необязательно. Новый входящий запрос на предварительную оплату. Содержит полную информацию о процессе оформления заказа. |
| purchased_paid_media | PaidMediaPurchased | Необязательно. Пользователь приобрел платный медиа-контент с непустым полезным грузом, отправленным ботом в неканальном чате. |
| 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 | Необязательно. Повышение было удалено из чата. Бот должен быть администратором в чате для получения этих обновлений. |
getUpdates
Используйте этот метод, чтобы получать входящие обновления с помощью долгого опроса (wiki). Возвращает массив объектов Update.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| offset | Целое число | Необязательный | Идентификатор первого обновления, которое должно быть возвращено. Должен быть больше на один, чем наибольший из идентификаторов ранее полученных обновлений. По умолчанию возвращаются обновления, начиная с самого раннего неподтвержденного обновления. Обновление считается подтвержденным, как только вызывается getUpdates с offset, большим чем его update_id. Отрицательный offset может быть указан для получения обновлений, начиная с -offset обновления с конца очереди обновлений. Все предыдущие обновления будут забыты. |
| limit | Целое число | Необязательный | Ограничивает количество обновлений, которые нужно получить. Принимаются значения от 1 до 100. По умолчанию 100. |
| timeout | Целое число | Необязательный | Таймаут в секундах для долгого опроса. По умолчанию 0, т.е. обычный короткий опрос. Должен быть положительным, короткий опрос следует использовать только в целях тестирования. |
| allowed_updates | Массив строк | Необязательный | 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-Telegram-Bot-Api-Secret-Token” с секретным токеном в качестве содержимого.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| url | String | Да | HTTPS URL для отправки обновлений. Используйте пустую строку для удаления интеграции вебхука |
| certificate | InputFile | Необязательный | Загрузите ваш публичный ключ сертификата, чтобы можно было проверить корневой сертификат. См. наш гид по самоподписанным сертификатам для получения деталей. |
| ip_address | String | Необязательный | Фиксированный IP-адрес, который будет использоваться для отправки запросов вебхука вместо IP-адреса, разрешенного через DNS |
| max_connections | Integer | Необязательный | Максимально допустимое количество одновременных HTTPS соединений к вебхуку для доставки обновлений, 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-Telegram-Bot-Api-Secret-Token” в каждом запросе вебхука, 1-256 символов. Разрешены только символы A-Z, a-z, 0-9, _ и -. Заголовок полезен для обеспечения того, чтобы запрос поступал из вебхука, установленного вами. |
Примечания
1. Вы не сможете получать обновления, используя getUpdates, пока установлен исходящий вебхук.
2. Чтобы использовать самоподписанный сертификат, вам нужно загрузить ваш публичный ключ сертификата с помощью параметра certificate. Пожалуйста, загружайте как InputFile, отправка строки не сработает.
3. Порты, которые в настоящее время поддерживаются для вебхуков: 443, 80, 88, 8443.Если у вас возникли проблемы с настройкой вебхуков, пожалуйста, ознакомьтесь с этим замечательным руководством по вебхукам.
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-адрес вебхука |
| last_error_date | Integer | Необязательно. Время Unix для самой последней ошибки, которая произошла при попытке доставить обновление через вебхук |
| last_error_message | String | Необязательно. Сообщение об ошибке в читаемом формате для самой последней ошибки, которая произошла при попытке доставить обновление через вебхук |
| last_synchronization_error_date | Integer | Необязательно. Время Unix самой последней ошибки, которая произошла при попытке синхронизировать доступные обновления с дата-центрами Telegram |
| max_connections | Integer | Необязательно. Максимально допустимое количество одновременных HTTPS-соединений с вебхуком для доставки обновлений |
| allowed_updates | Array of String | Необязательно. Список типов обновлений, на которые подписан бот. По умолчанию все типы обновлений, кроме chat_member |
Доступные типы
Все типы, используемые в ответах Bot API, представлены в виде JSON-объектов.
Без дополнительных примечаний безопасно использовать 32-битные знаковые целые числа для хранения всех Integer полей.
Необязательные поля могут не возвращаться, если они не актуальны.
Пользователь
Этот объект представляет собой пользователя или бота Telegram.
| Поле | Тип | Описание |
|---|---|---|
| id | Целое число | Уникальный идентификатор для этого пользователя или бота. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или молчаливые ошибки при его интерпретации. Но у него максимум 52 значащих бита, так что 64-битное целое число или тип с плавающей запятой двойной точности безопасны для хранения этого идентификатора. |
| is_bot | Булевый | Истина, если этот пользователь является ботом |
| first_name | Строка | Имя пользователя или бота |
| last_name | Строка | Необязательно. Фамилия пользователя или бота |
| username | Строка | Необязательно. Имя пользователя или бота |
| language_code | Строка | Необязательно. IETF язык тег языка пользователя |
| is_premium | Булевый | Необязательно. Истина, если этот пользователь является пользователем Telegram Premium |
| added_to_attachment_menu | Булевый | Необязательно. Истина, если этот пользователь добавил бота в меню вложений |
| can_join_groups | Булевый | Необязательно. Истина, если бота можно пригласить в группы. Возвращается только в getMe. |
| can_read_all_group_messages | Булевый | Необязательно. Истина, если режим конфиденциальности отключен для бота. Возвращается только в getMe. |
| supports_inline_queries | Булевый | Необязательно. Истина, если бот поддерживает инлайн-запросы. Возвращается только в getMe. |
| can_connect_to_business | Булевый | Необязательно. Истина, если бот может быть подключен к бизнес-аккаунту Telegram для получения его сообщений. Возвращается только в getMe. |
| has_main_web_app | Булевый | Необязательно. Истина, если у бота есть основное веб-приложение. Возвращается только в getMe. |
Чат
Этот объект представляет собой чат.
| Поле | Тип | Описание |
|---|---|---|
| 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, если супергрупповой чат является форумом (имеет темы включены) |
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, если супергрупповой чат является форумом (имеет темы включены) |
| 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 | Опционально. Для частных чатов, личный канал пользователя |
| 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 времени, если есть |
| bio | String | Опционально. Биография другой стороны в частном чате |
| has_private_forwards | True | Опционально. True, если настройки конфиденциальности другой стороны в частном чате позволяют использовать tg://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 | Optional. Основная ссылка для приглашения, для групп, супергрупп и каналов |
| pinned_message | Message | Optional. Самое недавнее закрепленное сообщение (по дате отправки) |
| permissions | ChatPermissions | Optional. Стандартные разрешения участников чата, для групп и супергрупп |
| can_send_gift | True | Optional. True, если в чат можно отправлять подарки |
| can_send_paid_media | True | Optional. True, если платные медиа-сообщения могут быть отправлены или пересланы в канал. Это поле доступно только для каналов. |
| slow_mode_delay | Integer | Optional. Для супергрупп минимальная допустимая задержка между последовательными сообщениями, отправляемыми каждым непривилегированным пользователем; в секундах |
| unrestrict_boost_count | Integer | Optional. Для супергрупп минимальное количество бустов, которое должен добавить непривилегированный пользователь, чтобы игнорировать медленный режим и разрешения чата |
| message_auto_delete_time | Integer | Optional. Время после которого все сообщения, отправленные в чат, будут автоматически удалены; в секундах |
| has_aggressive_anti_spam_enabled | True | Optional. True, если в супергруппе включены агрессивные проверки против спама. Это поле доступно только администраторам чата. |
| has_hidden_members | True | Optional. True, если непривилегированные пользователи могут получать только список ботов и администраторов в чате |
| has_protected_content | True | Optional. True, если сообщения из чата не могут быть пересланы в другие чаты |
| has_visible_history | True | Optional. True, если новые участники чата будут иметь доступ к старым сообщениям; доступно только администраторам чата |
| sticker_set_name | String | Optional. Для супергрупп, название набора стикеров группы |
| can_set_sticker_set | True | Optional. True, если бот может изменить набор стикеров группы |
| custom_emoji_sticker_set_name | String | Optional. Для супергрупп, название набора стикеров с кастомными эмодзи группы. Кастомные эмодзи из этого набора могут использоваться всеми пользователями и ботами в группе. |
| linked_chat_id | Integer | Optional. Уникальный идентификатор связанного чата, то есть идентификатор группы обсуждений для канала и наоборот; для супергрупп и каналов. Этот идентификатор может превышать 32 бита, и некоторые языки программирования могут испытывать трудности/скрытые дефекты при его интерпретации. Однако он меньше 52 бит, поэтому безопасным выбором будет использование знакового целого числа 64 бит или типа double-precision float для хранения этого идентификатора. |
| location | ChatLocation | Optional. Для супергрупп, местоположение, к которому подключена супергруппа |
Сообщение
Этот объект представляет сообщение.
| Поле | Тип | Описание |
|---|---|---|
| message_id | Integer | Уникальный идентификатор сообщения внутри этого чата. В некоторых случаях (например, сообщение, содержащее видео, отправленное в большой чат) сервер может автоматически запланировать сообщение вместо немедленной отправки. В таких случаях это поле будет равно 0, и соответствующее сообщение будет недоступно до тех пор, пока оно не будет фактически отправлено. |
| message_thread_id | Integer | Необязательно. Уникальный идентификатор темы сообщения, к которой принадлежит сообщение; только для супергрупп. |
| from | Пользователь | Необязательно. Отправитель сообщения; может быть пустым для сообщений, отправленных в каналы. Для обратной совместимости, если сообщение было отправлено от имени чата, поле содержит поддельного пользователя-отправителя в неканальных чатах. |
| sender_chat | Чат | Необязательно. Отправитель сообщения, когда оно отправлено от имени чата. Например, сама супергруппа для сообщений, отправленных ее анонимными администраторами, или связанный канал для сообщений, автоматически пересылаемых в группу обсуждений канала. Для обратной совместимости, если сообщение было отправлено от имени чата, поле from содержит поддельного пользователя-отправителя в неканальных чатах. |
| sender_boost_count | Integer | Необязательно. Если отправитель сообщения увеличил чат, количество увеличений, добавленных пользователем. |
| sender_business_bot | Пользователь | Необязательно. Бот, который фактически отправил сообщение от имени бизнес-аккаунта. Доступно только для исходящих сообщений, отправленных от имени подключенного бизнес-аккаунта. |
| date | Integer | Дата отправки сообщения в формате Unix time. Это всегда положительное число, представляющее действительную дату. |
| business_connection_id | String | Необязательно. Уникальный идентификатор бизнес-соединения, откуда было получено сообщение. Если не пусто, сообщение принадлежит чату соответствующего бизнес-аккаунта, который независим от любого потенциального чата бота, который может иметь тот же идентификатор. |
| chat | Чат | Чат, к которому принадлежит сообщение. |
| forward_origin | MessageOrigin | Необязательно. Информация об оригинальном сообщении для пересланных сообщений. |
| is_topic_message | True | Необязательно. True, если сообщение отправлено в тему форума. |
| is_automatic_forward | True | Необязательно. True, если сообщение является постом канала, который был автоматически переслан в подключенную группу обсуждений. |
| reply_to_message | Сообщение | Необязательно. Для ответов в том же чате и теме сообщения — оригинальное сообщение. Обратите внимание, что объект Message в этом поле не будет содержать дополнительных полей reply_to_message, даже если он сам является ответом. |
| external_reply | ExternalReplyInfo | Необязательно. Информация о сообщении, на которое идет ответ, которое может приходить из другого чата или темы форума. |
| quote | TextQuote | Необязательно. Для ответов, которые цитируют часть оригинального сообщения, цитируемая часть сообщения. |
| reply_to_story | Story | Необязательно. Для ответов на историю — оригинальная история. |
| via_bot | Пользователь | Необязательно. Бот, через который было отправлено сообщение. |
| edit_date | Integer | Необязательно. Дата последнего редактирования сообщения в формате Unix time. |
| has_protected_content | True | Необязательно. True, если сообщение не может быть переслано. |
| is_from_offline | True | Необязательно. True, если сообщение было отправлено в результате неявного действия, например, как сообщение о приветствии или отсутствия, или как запланированное сообщение. |
| media_group_id | String | Необязательно. Уникальный идентификатор группы медиа-сообщений, к которой принадлежит это сообщение. |
| author_signature | String | Необязательно. Подпись автора поста для сообщений в каналах или пользовательский титул анонимного администратора группы. |
| text | String | Необязательно. Для текстовых сообщений фактический текст сообщения в кодировке UTF-8. |
| entities | Array of MessageEntity | Необязательно. Для текстовых сообщений специальные сущности, такие как имена пользователей, URL, команды бота и т.д., которые появляются в тексте. |
| link_preview_options | LinkPreviewOptions | Необязательно. Опции, используемые для генерации превью ссылки для сообщения, если это текстовое сообщение и параметры превью ссылки были изменены. |
| effect_id | String | Необязательно. Уникальный идентификатор эффекта сообщения, добавленного к сообщению. |
| animation | Анимация | Необязательно. Сообщение является анимацией, информация о анимации. Для обратной совместимости, когда это поле установлено, поле document также будет установлено. |
| audio | Audio | Необязательно. Сообщение представляет собой аудиофайл, информация о файле |
| document | Document | Необязательно. Сообщение является общим файлом, информация о файле |
| 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, если медиаконтент сообщения скрыт анимацией спойлера |
| contact | Contact | Необязательно. Сообщение является обменом контактами, информация о контакте |
| dice | Dice | Необязательно. Сообщение представляет собой кубик со случайным значением |
| game | Game | Необязательно. Сообщение является игрой, информация об игре. Больше о играх » |
| poll | Poll | Необязательно. Сообщение является нативным опросом, информация об опросе |
| venue | Venue | Необязательно. Сообщение является местоположением, информация о месте. Для обратной совместимости, когда это поле установлено, поле location также будет установлено |
| location | Location | Необязательно. Сообщение является обменом местоположением, информация о местоположении |
| new_chat_members | Array of User | Необязательно. Новые участники, добавленные в группу или супергруппу, и информация о них (сам бот может быть одним из этих участников) |
| left_chat_member | User | Необязательно. Участник был удален из группы, информация о нем (этот участник может быть самим ботом) |
| new_chat_title | String | Необязательно. Название чата было изменено на это значение |
| new_chat_photo | Array of PhotoSize | Необязательно. Фотография чата была изменена на это значение |
| delete_chat_photo | True | Необязательно. Служебное сообщение: фотография чата была удалена |
| group_chat_created | True | Необязательно. Служебное сообщение: группа была создана |
| supergroup_chat_created | True | Необязательно. Служебное сообщение: супергруппа была создана. Это поле нельзя получить в сообщении, поступающем через обновления, потому что бот не может быть участником супергруппы при её создании. Оно может быть найдено только в 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 | Необязательно. Системное сообщение: чат был передан боту. |
| connected_website | String | Необязательно. Имя домена веб-сайта, на котором пользователь выполнил вход. Больше о Telegram Login » |
| write_access_allowed | WriteAccessAllowed | Необязательно. Системное сообщение: пользователь разрешил боту отправлять сообщения после добавления его в меню вложений или боковой панели, запуска Web App по ссылке или принятия явного запроса от Web App, отправленного методом requestWriteAccess. |
| passport_data | PassportData | Необязательно. Данные Telegram Passport. |
| proximity_alert_triggered | ProximityAlertTriggered | Необязательно. Системное сообщение. Пользователь в чате активировал оповещение о близости другого пользователя во время обмена Live Location. |
| boost_added | ChatBoostAdded | Необязательно. Системное сообщение: пользователь повысил чат. |
| chat_background_set | ChatBackground | Необязательно. Системное сообщение: фон чата установлен. |
| forum_topic_created | ForumTopicCreated | Необязательно. Системное сообщение: тема форума создана. |
| forum_topic_edited | ForumTopicEdited | Необязательно. Системное сообщение: тема форума отредактирована. |
| forum_topic_closed | ForumTopicClosed | Необязательно. Системное сообщение: тема форума закрыта. |
| forum_topic_reopened | ForumTopicReopened | Необязательно. Системное сообщение: тема форума открыта заново. |
| general_forum_topic_hidden | GeneralForumTopicHidden | Необязательно. Системное сообщение: тема 'Общая' скрыта. |
| general_forum_topic_unhidden | GeneralForumTopicUnhidden | Необязательно. Системное сообщение: тема 'Общая' показана. |
| giveaway_created | GiveawayCreated | Необязательно. Системное сообщение: розыгрыш был запланирован. |
| giveaway | Giveaway | Необязательно. Сообщение является запланированным сообщением розыгрыша. |
| giveaway_winners | GiveawayWinners | Необязательно. Розыгрыш с публичными победителями завершен. |
| giveaway_completed | GiveawayCompleted | Необязательно. Системное сообщение: розыгрыш без публичных победителей завершен. |
| 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 или #hashtag@chatusername), “cashtag” ($USD или $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (жирный текст), “italic” (курсивный текст), “underline” (подчеркнутый текст), “strikethrough” (зачеркнутый текст), “spoiler” (спойлер-сообщение), “blockquote” (блоковая цитата), “expandable_blockquote” (сжатая по умолчанию блоковая цитата), “code” (моноширинная строка), “pre” (моноширинный блок), “text_link” (для кликабельных текстовых URL), “text_mention” (для пользователей без имен пользователей), “custom_emoji” (для встроенных пользовательских эмодзи-стикеров) |
| offset | Integer | Смещение в единицах кода UTF-16 до начала сущности |
| length | Integer | Длина сущности в единицах кода UTF-16 |
| url | String | Необязательно. Только для “text_link”, URL, который будет открыт после нажатия пользователем на текст |
| user | User | Необязательно. Только для “text_mention”, упомянутый пользователь |
| language | String | Необязательно. Только для “pre”, язык программирования текста сущности |
| custom_emoji_id | String | Необязательно. Только для “custom_emoji”, уникальный идентификатор пользовательского эмодзи. Используйте getCustomEmojiStickers, чтобы получить полную информацию о стикере |
TextQuote
Этот объект содержит информацию о цитируемой части сообщения, на которое отвечает данное сообщение.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст цитируемой части сообщения, на которое отвечает данное сообщение |
| entities | Array of MessageEntity | Необязательно. Специальные сущности, которые появляются в цитате. В настоящее время в цитатах сохраняются только сущности bold, italic, underline, strikethrough, spoiler и custom_emoji. |
| position | Integer | Приблизительная позиция цитаты в оригинальном сообщении в кодовых единицах UTF-16, как указано отправителем |
| is_manual | True | Необязательно. True, если цитата была выбрана вручную отправителем сообщения. В противном случае цитата была добавлена автоматически сервером. |
ExternalReplyInfo
Этот объект содержит информацию о сообщении, на которое осуществляется ответ, которое может поступать из другого чата или темы форума.
| Поле | Тип | Описание |
|---|---|---|
| origin | MessageOrigin | Происхождение сообщения, на которое отвечает данное сообщение |
| chat | Chat | Необязательно. Чат, к которому принадлежит оригинальное сообщение. Доступно только если чат является супергруппой или каналом. |
| message_id | Целое число | Необязательно. Уникальный идентификатор сообщения внутри оригинального чата. Доступно только если оригинальный чат является супергруппой или каналом. |
| link_preview_options | LinkPreviewOptions | Необязательно. Опции, используемые для генерации предпросмотра ссылки для оригинального сообщения, если это текстовое сообщение |
| animation | Animation | Необязательно. Сообщение является анимацией, информация об анимации |
| audio | Audio | Необязательно. Сообщение является аудиофайлом, информация о файле |
| document | Document | Необязательно. Сообщение является общим файлом, информация о файле |
| paid_media | PaidMediaInfo | Необязательно. Сообщение содержит платные медиа; информация о платном медиаконтенте |
| photo | Массив PhotoSize | Необязательно. Сообщение является фотографией, доступные размеры фотографии |
| sticker | Sticker | Необязательно. Сообщение является стикером, информация о стикере |
| story | Story | Необязательно. Сообщение является пересланной историей |
| video | Video | Необязательно. Сообщение является видео, информация о видео |
| video_note | VideoNote | Необязательно. Сообщение является видео заметкой, информация о видео сообщении |
| voice | Voice | Необязательно. Сообщение является голосовым сообщением, информация о файле |
| has_media_spoiler | True | Необязательно. True, если медиа сообщение скрыто под анимацией спойлера |
| 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, если он указан |
| chat_id | Integer or String | Необязательно. Если сообщение, на которое нужно ответить, из другого чата, уникальный идентификатор чата или имя пользователя канала (в формате @channelusername). Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта. |
| allow_sending_without_reply | Boolean | Необязательно. Укажите True, если сообщение должно быть отправлено, даже если указанное сообщение для ответа не найдено. Всегда False для ответов в другом чате или форуме. Всегда True для сообщений, отправленных от имени бизнес-аккаунта. |
| quote | String | Необязательно. Цитируемая часть сообщения, на которое нужно ответить; 0-1024 символов после разбора сущностей. Цитата должна быть точной подстрокой сообщения, на которое нужно ответить, включая жирный, курсив, подчеркнутый, зачеркнутый, спойлер и custom_emoji сущности. Сообщение не будет отправлено, если цитата не найдена в оригинальном сообщении. |
| quote_parse_mode | String | Необязательно. Режим для разбора сущностей в цитате. Смотрите опции форматирования для получения дополнительных деталей. |
| quote_entities | Array of MessageEntity | Необязательно. JSON-сериализованный список специальных сущностей, которые появляются в цитате. Может быть указан вместо quote_parse_mode. |
| quote_position | Integer | Необязательно. Позиция цитаты в оригинальном сообщении в кодовых единицах UTF-16 |
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_id | String | Идентификатор этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор этого файла, который должен оставаться одинаковым с течением времени и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| width | Integer | Ширина фотографии |
| height | Integer | Высота фотографии |
| file_size | Integer | Необязательно. Размер файла в байтах |
Анимация
Этот объект представляет собой файл анимации (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-битный целый тип или тип с плавающей точкой двойной точности безопасны для хранения этого значения. |
Аудио
Этот объект представляет собой аудиофайл, который будет восприниматься как музыка клиентами Telegram.
| Поле | Тип | Описание |
|---|---|---|
| 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 | Необязательно. Эскиз обложки альбома, к которому принадлежит музыкальный файл |
Документ
Этот объект представляет собой общий файл (в отличие от фото, голосовых сообщений и аудиофайлов).
| Поле | Тип | Описание |
|---|---|---|
| file_id | String | Идентификатор этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| thumbnail | PhotoSize | Необязательно. Эскиз документа, определенный отправителем |
| file_name | String | Необязательно. Оригинальное имя файла, определенное отправителем |
| mime_type | String | Необязательно. MIME-тип файла, определенный отправителем |
| file_size | Integer | Необязательно. Размер файла в байтах. Он может превышать 2^31, и некоторые языки программирования могут испытывать трудности/иметь скрытые ошибки при его интерпретации. Но он имеет не более 52 значащих бит, поэтому для хранения этого значения безопасно использовать знаковый 64-битный целочисленный тип или тип с плавающей запятой двойной точности. |
История
Этот объект представляет собой историю.
| Поле | Тип | Описание |
|---|---|---|
| chat | Чат | Чат, который опубликовал историю |
| id | Integer | Уникальный идентификатор для истории в чате |
Видео
Этот объект представляет собой видеофайл.
| Поле | Тип | Описание |
|---|---|---|
| file_id | String | Идентификатор этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор этого файла, который должен оставаться неизменным с течением времени и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| width | Integer | Ширина видео, определенная отправителем |
| height | Integer | Высота видео, определенная отправителем |
| duration | Integer | Длительность видео в секундах, определенная отправителем |
| thumbnail | PhotoSize | Необязательно. Миниатюра видео |
| cover | Array of PhotoSize | Необязательно. Доступные размеры обложки видео в сообщении |
| start_timestamp | Integer | Необязательно. Временная метка в секундах, с которой видео будет воспроизводиться в сообщении |
| file_name | String | Необязательно. Оригинальное имя файла, определенное отправителем |
| mime_type | String | Необязательно. MIME-тип файла, определенный отправителем |
| file_size | Integer | Необязательно. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут испытывать трудности/молчаливые дефекты в его интерпретации. Но он имеет не более 52 значащих бит, поэтому знаковый 64-битный целочисленный тип или тип с плавающей запятой двойной точности безопасны для хранения этого значения. |
VideoNote
Этот объект представляет собой видеосообщение (доступно в приложениях Telegram начиная с версии 4.0).
| Поле | Тип | Описание |
|---|---|---|
| file_id | String | Идентификатор для этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор для этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| length | Integer | Ширина и высота видео (диаметр видеосообщения), определенные отправителем |
| duration | Integer | Длительность видео в секундах, определенная отправителем |
| thumbnail | PhotoSize | Необязательно. Миниатюра видео |
| file_size | Integer | Необязательно. Размер файла в байтах |
Голосовое сообщение
Этот объект представляет собой голосовую заметку.
| Поле | Тип | Описание |
|---|---|---|
| file_id | String | Идентификатор этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| duration | Integer | Длительность аудио в секундах, определенная отправителем |
| mime_type | String | Необязательно. MIME-тип файла, определенный отправителем |
| file_size | Integer | Необязательно. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут испытывать трудности/тихие дефекты при интерпретации этого значения. Но он имеет не более 52 значащих бит, поэтому знаковый 64-битный целочисленный тип или тип с плавающей запятой двойной точности безопасны для хранения этого значения. |
PaidMediaInfo
Описание платных медиа, добавленных к сообщению.
| Поле | Тип | Описание |
|---|---|---|
| star_count | Integer | Количество Telegram Stars, которые необходимо оплатить для получения доступа к медиа |
| paid_media | Array of PaidMedia | Информация о платных медиа |
ПлатныеМедиа
Этот объект описывает платные медиа. В настоящее время он может быть одним из
PaidMediaPreview
Платные медиа недоступны до оплаты.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип платного медиа, всегда “preview” |
| width | Integer | Необязательно. Ширина медиа, определенная отправителем |
| height | Integer | Необязательно. Высота медиа, определенная отправителем |
| duration | Integer | Необязательно. Длительность медиа в секундах, определенная отправителем |
PaidMediaPhoto
Платные медиа — это фото.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип платного медиа, всегда “photo” |
| photo | Array of PhotoSize | Фото |
PaidMediaVideo
Платные медиа — это видео.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип платного медиа, всегда “video” |
| video | Video | Видео |
Контакт
Этот объект представляет собой телефонный контакт.
| Поле | Тип | Описание |
|---|---|---|
| phone_number | String | Номер телефона контакта |
| first_name | String | Имя контакта |
| last_name | String | Необязательно. Фамилия контакта |
| user_id | Integer | Необязательно. Идентификатор пользователя контакта в Telegram. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или иметь скрытые ошибки при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битное целое число или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора. |
| vcard | String | Необязательно. Дополнительные данные о контакте в формате vCard |
Кубик
Этот объект представляет собой анимированный эмодзи, который отображает случайное значение.
| Поле | Тип | Описание |
|---|---|---|
| emoji | String | Эмодзи, на основе которого основана анимация броска кубика |
| value | Integer | Значение кубика, 1-6 для “ ”, “ ” и “ ” базовых эмодзи, 1-5 для “ ” и “ ” базовых эмодзи, 1-64 для “ ” базового эмодзи |
PollOption
Этот объект содержит информацию об одном варианте ответа в опросе.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст варианта, 1-100 символов |
| text_entities | Array of MessageEntity | Необязательно. Специальные сущности, которые появляются в тексте варианта. В настоящее время в текстах вариантов опроса разрешены только пользовательские эмодзи-сущности |
| voter_count | Integer | Количество пользователей, проголосовавших за этот вариант |
InputPollOption
Этот объект содержит информацию об одном варианте ответа в опросе, который будет отправлен.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст варианта, 1-100 символов |
| text_parse_mode | String | Необязательно. Режим для разбора сущностей в тексте. См. варианты форматирования для получения дополнительных сведений. В настоящее время разрешены только пользовательские эмодзи-сущности |
| text_entities | Array of MessageEntity | Необязательно. Список специальных сущностей в формате JSON, которые появляются в тексте варианта опроса. Может быть указан вместо text_parse_mode |
PollAnswer
Этот объект представляет собой ответ пользователя в ненастоящем опросе.
| Поле | Тип | Описание |
|---|---|---|
| poll_id | String | Уникальный идентификатор опроса |
| voter_chat | Chat | Необязательно. Чат, который изменил ответ на опрос, если голосующий анонимный |
| user | User | Необязательно. Пользователь, который изменил ответ на опрос, если голосующий не анонимный |
| option_ids | Array of Integer | Идентификаторы выбранных вариантов ответов, начинающиеся с 0. Могут быть пустыми, если голос был отозван. |
Опрос
Этот объект содержит информацию об опросе.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор опроса |
| question | String | Вопрос опроса, 1-300 символов |
| question_entities | Array of MessageEntity | Необязательно. Специальные сущности, которые появляются в вопросе. В настоящее время разрешены только пользовательские эмодзи в вопросах опроса |
| options | Array of PollOption | Список вариантов опроса |
| total_voter_count | Integer | Общее количество пользователей, проголосовавших в опросе |
| is_closed | Boolean | True, если опрос закрыт |
| is_anonymous | Boolean | True, если опрос анонимный |
| type | String | Тип опроса, в настоящее время может быть “обычный” или “викторина” |
| allows_multiple_answers | Boolean | True, если опрос позволяет несколько ответов |
| correct_option_id | Integer | Необязательно. Идентификатор правильного варианта ответа, начиная с 0. Доступен только для опросов в режиме викторины, которые закрыты или были отправлены (не пересланы) ботом или в личный чат с ботом. |
| explanation | String | Необязательно. Текст, который отображается, когда пользователь выбирает неправильный ответ или нажимает на иконку лампы в опросе в стиле викторины, 0-200 символов |
| explanation_entities | Array of MessageEntity | Необязательно. Специальные сущности, такие как имена пользователей, URL, команды бота и т.д., которые появляются в объяснении |
| open_period | Integer | Необязательно. Период времени в секундах, в течение которого опрос будет активен после создания |
| close_date | Integer | Необязательно. Момент времени (Unix timestamp), когда опрос будет автоматически закрыт |
Местоположение
Этот объект представляет точку на карте.
| Поле | Тип | Описание |
|---|---|---|
| latitude | Float | Широта, определенная отправителем |
| longitude | Float | Долгота, определенная отправителем |
| horizontal_accuracy | Float | Необязательно. Радиус неопределенности для местоположения, измеряемый в метрах; 0-1500 |
| live_period | Integer | Необязательно. Время относительно даты отправки сообщения, в течение которого местоположение может обновляться; в секундах. Только для активных живых местоположений. |
| heading | Integer | Необязательно. Направление, в котором движется пользователь, в градусах; 1-360. Только для активных живых местоположений. |
| proximity_alert_radius | Integer | Необязательно. Максимальное расстояние для предупреждений о приближении к другому участнику чата, в метрах. Только для отправленных живых местоположений. |
Место проведения
Этот объект представляет собой место проведения.
| Поле | Тип | Описание |
|---|---|---|
| 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 | Новое время автоматического удаления сообщений в чате; в секундах |
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 и затем размылены с радиусом 12 |
| is_moving | True | Необязательно. True, если фон немного движется при наклоне устройства |
BackgroundTypePattern
Фон — это .PNG или .TGV (сжатый подмножество 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 | Тип фона |
ForumTopicCreated
Этот объект представляет собой служебное сообщение о новой теме форума, созданной в чате.
| Поле | Тип | Описание |
|---|---|---|
| name | String | Название темы |
| icon_color | Integer | Цвет иконки темы в формате RGB |
| icon_custom_emoji_id | String | Необязательно. Уникальный идентификатор пользовательского эмодзи, отображаемого в качестве иконки темы |
ForumTopicClosed
Этот объект представляет собой служебное сообщение о закрытии темы форума в чате. В настоящее время не содержит информации.
ForumTopicEdited
Этот объект представляет собой служебное сообщение о редактировании темы форума.
| Поле | Тип | Описание |
|---|---|---|
| name | String | Необязательно. Новое имя темы, если она была отредактирована |
| icon_custom_emoji_id | String | Необязательно. Новый идентификатор пользовательского эмодзи, отображаемого в качестве иконки темы, если она была отредактирована; пустая строка, если иконка была удалена |
ForumTopicReopened
Этот объект представляет собой служебное сообщение о том, что тема форума была reopened в чате. В настоящее время не содержит никакой информации.
GeneralForumTopicHidden
Этот объект представляет собой служебное сообщение о скрытой теме общего форума в чате. В настоящее время не содержит информации.
GeneralForumTopicUnhidden
Этот объект представляет собой служебное сообщение о том, что общая тема форума была раскрыта в чате. В настоящее время не содержит информации.
SharedUser
Этот объект содержит информацию о пользователе, который был передан боту с помощью кнопки KeyboardButtonRequestUsers.
| Поле | Тип | Описание |
|---|---|---|
| user_id | Целое число | Идентификатор переданного пользователя. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или иметь скрытые ошибки при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битные целые числа или типы с плавающей запятой двойной точности безопасны для хранения этих идентификаторов. Бот может не иметь доступа к пользователю и не сможет использовать этот идентификатор, если пользователь не известен боту каким-либо другим способом. |
| first_name | Строка | Необязательно. Имя пользователя, если имя было запрошено ботом |
| last_name | Строка | Необязательно. Фамилия пользователя, если фамилия была запрошена ботом |
| username | Строка | Необязательно. Имя пользователя, если имя пользователя было запрошено ботом |
| photo | Массив PhotoSize | Необязательно. Доступные размеры фото чата, если фото было запрошено ботом |
UsersShared
Этот объект содержит информацию о пользователях, чьи идентификаторы были переданы боту с помощью кнопки KeyboardButtonRequestUsers.
| Поле | Тип | Описание |
|---|---|---|
| request_id | Integer | Идентификатор запроса |
| users | Array of SharedUser | Информация о пользователях, переданных боту. |
ChatShared
Этот объект содержит информацию о чате, который был отправлен боту с помощью кнопки KeyboardButtonRequestChat.
| Поле | Тип | Описание |
|---|---|---|
| request_id | Целое число | Идентификатор запроса |
| chat_id | Целое число | Идентификатор общего чата. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или иметь скрытые дефекты при его интерпретации. Но у него максимум 52 значащих бита, поэтому 64-битное целое число или число с плавающей запятой двойной точности безопасны для хранения этого идентификатора. Бот может не иметь доступа к чату и не сможет использовать этот идентификатор, если чат не известен боту каким-либо другим способом. |
| title | Строка | Необязательно. Название чата, если название было запрошено ботом. |
| username | Строка | Необязательно. Имя пользователя чата, если имя пользователя было запрошено ботом и доступно. |
| photo | Массив PhotoSize | Необязательно. Доступные размеры фотографии чата, если фотография была запрошена ботом |
WriteAccessAllowed
Этот объект представляет собой служебное сообщение о том, что пользователь разрешил боту отправлять сообщения после добавления его в меню вложений, запуска веб-приложения по ссылке или принятия явного запроса от веб-приложения, отправленного методом requestWriteAccess.
| Поле | Тип | Описание |
|---|---|---|
| from_request | Boolean | Необязательно. True, если доступ был предоставлен после того, как пользователь принял явный запрос от веб-приложения, отправленный методом requestWriteAccess |
| web_app_name | String | Необязательно. Название веб-приложения, если доступ был предоставлен, когда веб-приложение было запущено по ссылке |
| from_attachment_menu | Boolean | Необязательно. True, если доступ был предоставлен, когда бот был добавлен в меню вложений или боковое меню |
VideoChatScheduled
Этот объект представляет собой служебное сообщение о запланированном видео-чате в чате.
| Поле | Тип | Описание |
|---|---|---|
| start_date | Integer | Момент времени (Unix timestamp), когда видео-чат должен быть начат администратором чата |
VideoChatStarted
Этот объект представляет собой служебное сообщение о начале видеочата в чате. В настоящее время не содержит информации.
VideoChatEnded
Этот объект представляет собой служебное сообщение о завершении видеочата в чате.
| Поле | Тип | Описание |
|---|---|---|
| duration | Integer | Длительность видеочата в секундах |
VideoChatParticipantsInvited
Этот объект представляет собой служебное сообщение о новых участниках, приглашенных в видеочат.
| Поле | Тип | Описание |
|---|---|---|
| users | Массив User | Новые участники, приглашенные в видеочат |
GiveawayCreated
Этот объект представляет собой служебное сообщение о создании запланированного розыгрыша.
| Поле | Тип | Описание |
|---|---|---|
| prize_star_count | Integer | Необязательно. Количество Telegram Stars, которые будут разделены между победителями розыгрыша; только для розыгрышей Telegram Star |
Розыгрыш
Этот объект представляет собой сообщение о запланированном розыгрыше.
| Поле | Тип | Описание |
|---|---|---|
| chats | Массив Chat | Список чатов, в которые пользователь должен вступить, чтобы участвовать в розыгрыше |
| winners_selection_date | Целое число | Момент времени (Unix timestamp), когда будут выбраны победители розыгрыша |
| winner_count | Целое число | Количество пользователей, которые должны быть выбраны в качестве победителей розыгрыша |
| only_new_members | True | Необязательно. True, если только пользователи, которые присоединились к чатам после начала розыгрыша, могут претендовать на выигрыш |
| has_public_winners | True | Необязательно. True, если список победителей розыгрыша будет виден всем |
| prize_description | Строка | Необязательно. Описание дополнительного приза розыгрыша |
| country_codes | Массив строк | Необязательно. Список двухбуквенных ISO 3166-1 alpha-2 кодов стран, указывающих на страны, из которых должны приходить подходящие пользователи для розыгрыша. Если пусто, то все пользователи могут участвовать в розыгрыше. Пользователи с номером телефона, купленным на Fragment, всегда могут участвовать в розыгрышах. |
| prize_star_count | Целое число | Необязательно. Количество Telegram Stars, которое будет разделено между победителями розыгрыша; только для розыгрышей Telegram Star |
| premium_subscription_month_count | Целое число | Необязательно. Количество месяцев, на которые будет активна подписка Telegram Premium, выигранная в розыгрыше; только для розыгрышей Telegram 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 | Необязательно. Количество Telegram Stars, которые были распределены между победителями розыгрыша; только для розыгрышей Telegram Star |
| premium_subscription_month_count | Integer | Необязательно. Количество месяцев, на которые будет активна подписка Telegram Premium, выигранная в розыгрыше; только для розыгрышей Telegram 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 | Сообщение | Необязательно. Сообщение с завершенным розыгрышем, если оно не было удалено |
| is_star_giveaway | True | Необязательно. True, если розыгрыш является розыгрышем Telegram Star. В противном случае, в настоящее время розыгрыш является розыгрышем Telegram 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, если предпросмотр ссылки должен отображаться выше текста сообщения; в противном случае предпросмотр ссылки будет отображаться ниже текста сообщения |
UserProfilePhotos
Этот объект представляет собой фотографии профиля пользователя.
| Поле | Тип | Описание |
|---|---|---|
| total_count | Integer | Общее количество фотографий профиля у целевого пользователя |
| photos | Array of Array of PhotoSize | Запрошенные фотографии профиля (вплоть до 4 размеров каждая) |
Файл
Этот объект представляет файл, готовый к загрузке. Файл можно загрузить по ссылке https://api.telegram.org/file/bot<token>/<file_path>. Гарантируется, что ссылка будет действительна как минимум 1 час. Когда ссылка истечет, новую можно запросить, вызвав getFile.
Максимальный размер файла для загрузки составляет 20 МБ
| Поле | Тип | Описание |
|---|---|---|
| file_id | String | Идентификатор этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор этого файла, который, как предполагается, будет одинаковым с течением времени и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| file_size | Integer | Необязательно. Размер файла в байтах. Он может быть больше 2^31, и некоторые языки программирования могут испытывать трудности/тихие дефекты при его интерпретации. Но он имеет не более 52 значащих бит, поэтому знаковый 64-битный целочисленный тип или тип с плавающей точкой двойной точности безопасны для хранения этого значения. |
| file_path | String | Необязательно. Путь к файлу. Используйте https://api.telegram.org/file/bot<token>/<file_path> для получения файла. |
WebAppInfo
Описание Веб-приложения.
| Поле | Тип | Описание |
|---|---|---|
| url | String | HTTPS URL Веб-приложения, которое должно быть открыто с дополнительными данными, как указано в Инициализация Веб-приложений |
ReplyKeyboardMarkup
Этот объект представляет собой пользовательскую клавиатуру с вариантами ответа (см. Введение в ботов для подробностей и примеров). Не поддерживается в каналах и для сообщений, отправленных от имени бизнес-аккаунта Telegram.
| Поле | Тип | Описание |
|---|---|---|
| keyboard | Массив массивов KeyboardButton | Массив строк кнопок, каждая из которых представлена массивом объектов KeyboardButton |
| is_persistent | Логический | Необязательно. Запрашивает клиентов всегда показывать клавиатуру, когда обычная клавиатура скрыта. По умолчанию false, в этом случае пользовательская клавиатура может быть скрыта и открыта с помощью значка клавиатуры. |
| resize_keyboard | Логический | Необязательно. Запрашивает клиентов изменять размер клавиатуры вертикально для оптимального соответствия (например, сделать клавиатуру меньше, если есть только две строки кнопок). По умолчанию false, в этом случае пользовательская клавиатура всегда будет иметь такую же высоту, как стандартная клавиатура приложения. |
| one_time_keyboard | Логический | Необязательно. Запрашивает клиентов скрыть клавиатуру, как только она была использована. Клавиатура все еще будет доступна, но клиенты автоматически отобразят обычную буквенно-цифровую клавиатуру в чате - пользователь может нажать специальную кнопку в поле ввода, чтобы снова увидеть пользовательскую клавиатуру. По умолчанию false. |
| input_field_placeholder | Строка | Необязательно. Заполнитель, который будет отображаться в поле ввода, когда клавиатура активна; 1-64 символа |
| selective | Логический | Необязательно. Используйте этот параметр, если хотите показать клавиатуру только конкретным пользователям. Цели: 1) пользователи, которые упоминаются в тексте объекта Message; 2) если сообщение бота является ответом на сообщение в том же чате и теме форума, отправитель оригинального сообщения. Пример: Пользователь запрашивает изменить язык бота, бот отвечает на запрос с клавиатурой для выбора нового языка. Другие пользователи в группе не видят клавиатуру. |
KeyboardButton
Этот объект представляет собой одну кнопку клавиатуры для ответа. Максимум одно из опциональных полей должно быть использовано для указания типа кнопки. Для простых текстовых кнопок можно использовать String вместо этого объекта для указания текста кнопки.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст кнопки. Если ни одно из опциональных полей не используется, он будет отправлен как сообщение, когда кнопка будет нажата |
| request_users | KeyboardButtonRequestUsers | Необязательно. Если указано, нажатие кнопки откроет список подходящих пользователей. Идентификаторы выбранных пользователей будут отправлены боту в служебном сообщении “users_shared”. Доступно только в личных чатах. |
| request_chat | KeyboardButtonRequestChat | Необязательно. Если указано, нажатие кнопки откроет список подходящих чатов. Нажатие на чат отправит его идентификатор боту в служебном сообщении “chat_shared”. Доступно только в личных чатах. |
| request_contact | Boolean | Необязательно. Если True, номер телефона пользователя будет отправлен как контакт, когда кнопка будет нажата. Доступно только в личных чатах. |
| request_location | Boolean | Необязательно. Если True, текущее местоположение пользователя будет отправлено, когда кнопка будет нажата. Доступно только в личных чатах. |
| request_poll | KeyboardButtonPollType | Необязательно. Если указано, пользователя попросят создать опрос и отправить его боту, когда кнопка будет нажата. Доступно только в личных чатах. |
| web_app | WebAppInfo | Необязательно. Если указано, описанное Web App будет запущено, когда кнопка будет нажата. Web App сможет отправить служебное сообщение “web_app_data”. Доступно только в личных чатах. |
Примечание: опции request_users и request_chat будут работать только в версиях Telegram, выпущенных после 3 февраля 2023 года. Более старые клиенты будут отображать unsupported message.
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, чтобы запросить супергруппу или канал с именем пользователя, передайте 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, чтобы запросить фото чата |
KeyboardButtonPollType
Этот объект представляет собой тип опроса, который можно создать и отправить, когда соответствующая кнопка будет нажата.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Необязательно. Если передан quiz, пользователю будет разрешено создавать только опросы в режиме викторины. Если передан regular, будут разрешены только обычные опросы. В противном случае пользователю будет разрешено создавать опрос любого типа. |
ReplyKeyboardRemove
После получения сообщения с этим объектом клиенты Telegram удалят текущую пользовательскую клавиатуру и отобразят стандартную клавиатуру с буквами. По умолчанию пользовательские клавиатуры отображаются до тех пор, пока бот не отправит новую клавиатуру. Исключение составляют одноразовые клавиатуры, которые скрываются сразу после нажатия пользователем кнопки (см. ReplyKeyboardMarkup). Не поддерживается в каналах и для сообщений, отправленных от имени бизнес-аккаунта Telegram.
| Поле | Тип | Описание |
|---|---|---|
| remove_keyboard | True | Запрашивает клиентов удалить пользовательскую клавиатуру (пользователь не сможет вызвать эту клавиатуру; если вы хотите скрыть клавиатуру из вида, но оставить ее доступной, используйте one_time_keyboard в ReplyKeyboardMarkup) |
| selective | Boolean | Необязательно. Используйте этот параметр, если хотите удалить клавиатуру только для конкретных пользователей. Цели: 1) пользователи, которые упомянуты в тексте объекта Message; 2) если сообщение бота является ответом на сообщение в том же чате и теме форума, отправитель оригинального сообщения. Пример: Пользователь голосует в опросе, бот возвращает сообщение с подтверждением в ответ на голосование и удаляет клавиатуру для этого пользователя, в то время как клавиатура с вариантами опроса все еще отображается пользователям, которые еще не голосовали. |
InlineKeyboardMarkup
Этот объект представляет собой встраиваемую клавиатуру, которая появляется прямо рядом с сообщением, к которому она относится.
| Поле | Тип | Описание |
|---|---|---|
| inline_keyboard | Массив массивов InlineKeyboardButton | Массив строк кнопок, каждая из которых представлена массивом объектов InlineKeyboardButton |
InlineKeyboardButton
Этот объект представляет собой одну кнопку встроенной клавиатуры. Должно быть использовано ровно одно из необязательных полей для указания типа кнопки.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст метки на кнопке |
| url | String | Необязательное. HTTP или tg:// URL, который будет открыт при нажатии на кнопку. Ссылки tg://user?id=<user_id> могут быть использованы для упоминания пользователя по его идентификатору без использования имени пользователя, если это разрешено его настройками конфиденциальности. |
| callback_data | String | Необязательное. Данные, которые будут отправлены в callback query боту при нажатии на кнопку, 1-64 байта |
| web_app | WebAppInfo | Необязательное. Описание Web App, который будет запущен, когда пользователь нажмет кнопку. Web App сможет отправить произвольное сообщение от имени пользователя, используя метод answerWebAppQuery. Доступно только в личных чатах между пользователем и ботом. Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта Telegram. |
| login_url | LoginUrl | Необязательное. HTTPS URL, используемый для автоматической авторизации пользователя. Может использоваться в качестве замены Виджету входа Telegram. |
| switch_inline_query | String | Необязательное. Если установлено, нажатие на кнопку предложит пользователю выбрать один из его чатов, откроет этот чат и вставит имя пользователя бота и указанной встроенной запрос в поле ввода. Может быть пустым, в этом случае будет вставлено только имя пользователя бота. Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта Telegram. |
| switch_inline_query_current_chat | String | Необязательное. Если установлено, нажатие на кнопку вставит имя пользователя бота и указанный встроенный запрос в поле ввода текущего чата. Может быть пустым, в этом случае будет вставлено только имя пользователя бота. Это предлагает быстрый способ для пользователя открыть вашего бота в встроенном режиме в том же чате - хорошо для выбора чего-то из нескольких вариантов. Не поддерживается в каналах и для сообщений, отправленных от имени бизнес-аккаунта Telegram. |
| switch_inline_query_chosen_chat | SwitchInlineQueryChosenChat | Необязательное. Если установлено, нажатие на кнопку предложит пользователю выбрать один из его чатов указанного типа, откроет этот чат и вставит имя пользователя бота и указанный встроенный запрос в поле ввода. Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта Telegram. |
| copy_text | CopyTextButton | Необязательное. Описание кнопки, которая копирует указанный текст в буфер обмена. |
| callback_game | CallbackGame | Необязательное. Описание игры, которая будет запущена, когда пользователь нажмет кнопку. ПРИМЕЧАНИЕ: Этот тип кнопки должен всегда быть первой кнопкой в первом ряду. |
| pay | Boolean | Необязательное. Укажите True, чтобы отправить Кнопку оплаты. Подстроки “ ” и “XTR” в тексте кнопки будут заменены на иконку звезды Telegram.ПРИМЕЧАНИЕ: Этот тип кнопки должен всегда быть первой кнопкой в первом ряду и может использоваться только в сообщениях счетов. |
LoginUrl
Этот объект представляет собой параметр кнопки встроенной клавиатуры, используемой для автоматической авторизации пользователя. Является отличной заменой Виджету авторизации Telegram, когда пользователь приходит из Telegram. Все, что нужно сделать пользователю, это нажать кнопку и подтвердить, что он хочет войти:
Приложения Telegram поддерживают эти кнопки начиная с версии 5.7.
Пример бота: @discussbot
| Поле | Тип | Описание |
|---|---|---|
| url | String | HTTPS URL, который будет открыт с добавленными данными авторизации пользователя в строку запроса, когда кнопка нажата. Если пользователь отказывается предоставлять данные авторизации, будет открыт оригинальный URL без информации о пользователе. Добавленные данные такие же, как описано в Получение данных авторизации. ПРИМЕЧАНИЕ: Вы должны всегда проверять хэш полученных данных, чтобы подтвердить аутентификацию и целостность данных, как описано в Проверка авторизации. |
| forward_text | String | Необязательно. Новый текст кнопки в пересланных сообщениях. |
| bot_username | String | Необязательно. Имя пользователя бота, которое будет использоваться для авторизации пользователя. См. Настройка бота для получения дополнительной информации. Если не указано, будет использовано имя пользователя текущего бота. Домен url должен совпадать с доменом, связанным с ботом. См. Связывание вашего домена с ботом для получения дополнительной информации. |
| request_write_access | Boolean | Необязательно. Укажите True, чтобы запросить разрешение вашему боту на отправку сообщений пользователю. |
SwitchInlineQueryChosenChat
Этот объект представляет собой встроенную кнопку, которая переключает текущего пользователя в встроенный режим в выбранном чате с необязательным значением по умолчанию для встроенного запроса.
| Поле | Тип | Описание |
|---|---|---|
| query | String | Необязательное. Запрос по умолчанию, который будет вставлен в поле ввода. Если оставить пустым, будет вставлено только имя пользователя бота. |
| allow_user_chats | Boolean | Необязательное. True, если можно выбрать личные чаты с пользователями. |
| allow_bot_chats | Boolean | Необязательное. True, если можно выбрать личные чаты с ботами. |
| allow_group_chats | Boolean | Необязательное. True, если можно выбрать групповые и супергрупповые чаты. |
| allow_channel_chats | Boolean | Необязательное. True, если можно выбрать чаты каналов. |
КнопкаКопированияТекста
Этот объект представляет собой кнопку встроенной клавиатуры, которая копирует указанный текст в буфер обмена.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст, который будет скопирован в буфер обмена; 1-256 символов |
CallbackQuery
Этот объект представляет входящий запрос обратного вызова от кнопки обратного вызова в встроенной клавиатуре. Если кнопка, вызвавшая запрос, была прикреплена к сообщению, отправленному ботом, поле message будет присутствовать. Если кнопка была прикреплена к сообщению, отправленному через бота (в встроенном режиме), поле inline_message_id будет присутствовать. Точно одно из полей data или game_short_name будет присутствовать.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор для этого запроса |
| from | User | Отправитель |
| message | MaybeInaccessibleMessage | Необязательно. Сообщение, отправленное ботом с кнопкой обратного вызова, вызвавшей запрос |
| inline_message_id | String | Необязательно. Идентификатор сообщения, отправленного через бота в встроенном режиме, которое вызвало запрос. |
| chat_instance | String | Глобальный идентификатор, уникально соответствующий чату, в который было отправлено сообщение с кнопкой обратного вызова. Полезен для высоких результатов в играх. |
| data | String | Необязательно. Данные, связанные с кнопкой обратного вызова. Обратите внимание, что сообщение, вызвавшее запрос, может не содержать кнопок обратного вызова с этими данными. |
| game_short_name | String | Необязательно. Короткое имя игры, которое будет возвращено, служит уникальным идентификатором для игры |
ПРИМЕЧАНИЕ: После нажатия пользователем кнопки обратного вызова клиенты Telegram будут отображать индикатор выполнения, пока вы не вызовете answerCallbackQuery. Поэтому необходимо реагировать, вызвав answerCallbackQuery, даже если уведомление пользователю не требуется (например, без указания каких-либо из необязательных параметров).
ForceReply
При получении сообщения с этим объектом клиенты Telegram отобразят интерфейс ответа для пользователя (как будто пользователь выбрал сообщение бота и нажал 'Ответить'). Это может быть крайне полезно, если вы хотите создать удобные для пользователя пошаговые интерфейсы, не жертвуя режимом конфиденциальности. Не поддерживается в каналах и для сообщений, отправленных от имени бизнес-аккаунта Telegram.
| Поле | Тип | Описание |
|---|---|---|
| force_reply | True | Отображает интерфейс ответа для пользователя, как будто он вручную выбрал сообщение бота и нажал 'Ответить' |
| input_field_placeholder | String | Необязательно. Заполнитель, который будет показан в поле ввода, когда ответ активен; 1-64 символов |
| selective | Boolean | Необязательно. Используйте этот параметр, если хотите принудительно получить ответ только от определенных пользователей. Цели: 1) пользователи, которые упомянуты в тексте объекта Message; 2) если сообщение бота является ответом на сообщение в том же чате и тематическом форуме, отправитель оригинального сообщения. |
Пример: бот для опросов для групп работает в режиме конфиденциальности (получает только команды, отвечает на свои сообщения и упоминания). Существует два способа создания нового опроса:
- Объяснить пользователю, как отправить команду с параметрами (например, /newpoll вопрос ответ1 ответ2). Может быть привлекательно для опытных пользователей, но не хватает современного блеска.
- Проводить пользователя через пошаговый процесс. 'Пожалуйста, отправьте мне ваш вопрос', 'Отлично, теперь давайте добавим первый вариант ответа', 'Здорово. Продолжайте добавлять варианты ответов, затем отправьте /done, когда будете готовы'.
Последний вариант определенно более привлекательный. И если вы используете ForceReply в вопросах вашего бота, он получит ответы пользователя, даже если получает только ответы, команды и упоминания - без лишней работы для пользователя.
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 | Необязательно. Сумма Telegram Stars, которую пользователь должен заплатить изначально и после каждого последующего периода подписки, чтобы быть членом чата, используя ссылку |
ChatAdministratorRights
Представляет права администратора в чате.
| Поле | Тип | Описание |
|---|---|---|
| is_anonymous | Boolean | True, если присутствие пользователя в чате скрыто |
| can_manage_chat | Boolean | True, если администратор может получить доступ к журналу событий чата, получить список повышений, видеть скрытых участников супергруппы и канала, сообщать о спам-сообщениях и игнорировать медленный режим. Подразумевается любым другим правом администратора. |
| 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, если пользователю разрешено создавать, переименовывать, закрывать и открывать форумы; только для супергрупп |
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
- ChatMemberAdministrator
- ChatMemberMember
- ChatMemberRestricted
- ChatMemberLeft
- ChatMemberBanned
ChatMemberOwner
Представляет собой участника чата, который является владельцем чата и имеет все права администратора.
| Поле | Тип | Описание |
|---|---|---|
| status | String | Статус участника в чате, всегда “creator” |
| user | User | Информация о пользователе |
| is_anonymous | Boolean | True, если присутствие пользователя в чате скрыто |
| custom_title | String | Необязательно. Пользовательский титул для этого пользователя |
ChatMemberAdministrator
Представляет собой участника чата, который имеет некоторые дополнительные привилегии.
| Поле | Тип | Описание |
|---|---|---|
| status | String | Статус участника в чате, всегда “administrator” |
| user | User | Информация о пользователе |
| can_be_edited | Boolean | True, если боту разрешено редактировать привилегии администратора этого пользователя |
| is_anonymous | Boolean | True, если присутствие пользователя в чате скрыто |
| can_manage_chat | Boolean | True, если администратор может получить доступ к журналу событий чата, получить список бустов, видеть скрытых участников супергруппы и канала, сообщать о спам-сообщениях и игнорировать медленный режим. Подразумевается любой другой привилегией администратора. |
| 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 | Optional. True, если администратор может публиковать сообщения в канале или получать доступ к статистике канала; только для каналов |
| can_edit_messages | Boolean | Optional. True, если администратор может редактировать сообщения других пользователей и может закреплять сообщения; только для каналов |
| can_pin_messages | Boolean | Optional. True, если пользователю разрешено закреплять сообщения; только для групп и супергрупп |
| can_manage_topics | Boolean | Optional. True, если пользователю разрешено создавать, переименовывать, закрывать и открывать темы форума; только для супергрупп |
| custom_title | String | Optional. Пользовательское название для этого пользователя |
ChatMemberMember
Представляет собой участника чата, который не имеет дополнительных привилегий или ограничений.
| Поле | Тип | Описание |
|---|---|---|
| status | String | Статус участника в чате, всегда “member” |
| user | User | Информация о пользователе |
| until_date | Integer | Необязательно. Дата, когда подписка пользователя истечет; Unix время |
ChatMemberRestricted
Представляет собой участника чата, который находится под определенными ограничениями в чате. Только супергруппы.
| Поле | Тип | Описание |
|---|---|---|
| status | String | Статус участника в чате, всегда “restricted” |
| user | 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_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 | User | Информация об пользователе |
ChatMemberBanned
Представляет собой участника чата, который был забанен в чате и не может вернуться в чат или просматривать сообщения чата.
| Поле | Тип | Описание |
|---|---|---|
| status | String | Статус участника в чате, всегда “kicked” |
| user | 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 | Необязательно. Ссылка на приглашение в чат, которую использовал пользователь для отправки запроса на присоединение |
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_change_info | Boolean | Необязательно. True, если пользователю разрешено изменять название чата, фото и другие настройки. Игнорируется в публичных супергруппах |
| can_invite_users | Boolean | Необязательно. True, если пользователю разрешено приглашать новых пользователей в чат |
| can_pin_messages | Boolean | Необязательно. True, если пользователю разрешено закреплять сообщения. Игнорируется в публичных супергруппах |
| can_manage_topics | Boolean | Необязательно. True, если пользователю разрешено создавать темы форума. Если опущено, по умолчанию принимает значение can_pin_messages |
Дата рождения
Описание даты рождения пользователя.
| Поле | Тип | Описание |
|---|---|---|
| day | Integer | День рождения пользователя; 1-31 |
| month | Integer | Месяц рождения пользователя; 1-12 |
| year | Integer | Необязательно. Год рождения пользователя |
BusinessIntro
Содержит информацию о настройках стартовой страницы учетной записи Telegram Business.
| Поле | Тип | Описание |
|---|---|---|
| title | String | Необязательно. Текст заголовка бизнес-интро |
| message | String | Необязательно. Текст сообщения бизнес-интро |
| sticker | Sticker | Необязательно. Стикер бизнес-интро |
BusinessLocation
Содержит информацию о местоположении учетной записи Telegram Business.
| Поле | Тип | Описание |
|---|---|---|
| address | String | Адрес бизнеса |
| location | Location | Опционально. Местоположение бизнеса |
BusinessOpeningHoursInterval
Описывает интервал времени, в течение которого бизнес открыт.
| Поле | Тип | Описание |
|---|---|---|
| opening_minute | Integer | Порядковый номер минуты в неделе, начиная с понедельника, обозначающий начало временного интервала, в течение которого бизнес открыт; 0 - 7 * 24 * 60 |
| closing_minute | Integer | Порядковый номер минуты в неделе, начиная с понедельника, обозначающий конец временного интервала, в течение которого бизнес открыт; 0 - 8 * 24 * 60 |
Часы работы бизнеса
Описание часов работы бизнеса.
| Поле | Тип | Описание |
|---|---|---|
| time_zone_name | String | Уникальное название часового пояса, для которого определены часы работы |
| opening_hours | Array of BusinessOpeningHoursInterval | Список временных интервалов, описывающих часы работы бизнеса |
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 | Количество раз, когда реакция была добавлена |
ОбновлениеРеакцииСообщения
Этот объект представляет собой изменение реакции на сообщение, выполненное пользователем.
| Поле | Тип | Описание |
|---|---|---|
| chat | Чат | Чат, содержащий сообщение, на которое пользователь отреагировал |
| message_id | Целое число | Уникальный идентификатор сообщения внутри чата |
| user | Пользователь | Необязательно. Пользователь, который изменил реакцию, если пользователь не анонимен |
| actor_chat | Чат | Необязательно. Чат, от имени которого была изменена реакция, если пользователь анонимен |
| date | Целое число | Дата изменения в формате Unix time |
| old_reaction | Массив ReactionType | Предыдущий список типов реакций, установленных пользователем |
| new_reaction | Массив 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 | Необязательно. Уникальный идентификатор пользовательского эмодзи, отображаемого в качестве иконки темы |
BotCommand
Этот объект представляет команду бота.
| Поле | Тип | Описание |
|---|---|---|
| command | String | Текст команды; 1-32 символа. Может содержать только строчные английские буквы, цифры и символы подчеркивания. |
| description | String | Описание команды; 1-256 символов. |
BotCommandScope
Этот объект представляет область, к которой применяются команды бота. В настоящее время поддерживаются следующие 7 областей:
- BotCommandScopeDefault
- BotCommandScopeAllPrivateChats
- BotCommandScopeAllGroupChats
- BotCommandScopeAllChatAdministrators
- BotCommandScopeChat
- BotCommandScopeChatAdministrators
- BotCommandScopeChatMember
Определение списка команд
Следующий алгоритм используется для определения списка команд для конкретного пользователя, просматривающего меню бота. Возвращается первый установленный список команд:
Команды в чате с ботом
- 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
Представляет собой стандартный объем команд бота. Стандартные команды используются, если для пользователя не указаны команды с узким объемом.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип объема, должен быть default |
BotCommandScopeAllPrivateChats
Представляет область команд бота, охватывающую все приватные чаты.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип области, должен быть all_private_chats |
BotCommandScopeAllGroupChats
Представляет собой область команд бота, охватывающую все групповые и супергрупповые чаты.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип области, должен быть all_group_chats |
BotCommandScopeAllChatAdministrators
Представляет собой область команд бота, охватывающую всех администраторов групповых и супергрупповых чатов.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип области, должен быть all_chat_administrators |
BotCommandScopeChat
Представляет область команд бота, охватывающую конкретный чат.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип области, должен быть chat |
| chat_id | Integer or String | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
BotCommandScopeChatAdministrators
Представляет область команд бота, охватывающую всех администраторов конкретного группового или супергруппового чата.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип области, должен быть chat_administrators |
| chat_id | Integer или String | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
BotCommandScopeChatMember
Представляет область команд бота, охватывающую конкретного участника группового или супергруппового чата.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип области, должен быть chat_member |
| chat_id | Integer or String | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| user_id | Integer | Уникальный идентификатор целевого пользователя |
ИмяБота
Этот объект представляет имя бота.
| Поле | Тип | Описание |
|---|---|---|
| name | String | Имя бота |
ОписаниеБота
Этот объект представляет собой описание бота.
| Поле | Тип | Описание |
|---|---|---|
| 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. В качестве альтернативы, вместо URL Web App можно указать ссылку t.me на Web App бота, в этом случае Web App откроется так, как будто пользователь нажал на ссылку. |
MenuButtonDefault
Описывает, что для кнопки меню не было установлено конкретное значение.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип кнопки, должен быть default |
ChatBoostSource
Этот объект описывает источник повышения чата. Это может быть один из
ChatBoostSourcePremium
Увеличение было получено за счет подписки на Telegram Premium или подарочной подписки на Telegram Premium для другого пользователя.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник увеличения, всегда “premium” |
| user | User | Пользователь, который увеличил чат |
ChatBoostSourceGiftCode
Усиление было получено путем создания подарочных кодов Telegram Premium для усиления чата. Каждый такой код усиливает чат 4 раза на протяжении соответствующей подписки Telegram Premium.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник усиления, всегда “gift_code” |
| user | User | Пользователь, для которого был создан подарочный код |
ChatBoostSourceGiveaway
Увеличение было получено за счет создания розыгрыша Telegram Premium или Telegram Star. Это увеличивает чат в 4 раза на протяжении соответствующей подписки Telegram Premium для розыгрышей Telegram Premium и prize_star_count / 500 раз на один год для розыгрышей Telegram Star.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник увеличения, всегда “giveaway” |
| giveaway_message_id | Integer | Идентификатор сообщения в чате с розыгрышем; сообщение могло быть уже удалено. Может быть 0, если сообщение еще не отправлено. |
| user | User | Необязательно. Пользователь, который выиграл приз в розыгрыше, если таковой имеется; только для розыгрышей Telegram Premium |
| prize_star_count | Integer | Необязательно. Количество Telegram Stars, которое будет разделено между победителями розыгрыша; только для розыгрышей Telegram Star |
| is_unclaimed | True | Необязательно. True, если розыгрыш был завершен, но не было пользователя, чтобы выиграть приз |
ChatBoost
Этот объект содержит информацию о повышении чата.
| Поле | Тип | Описание |
|---|---|---|
| boost_id | String | Уникальный идентификатор повышения |
| add_date | Integer | Момент времени (Unix timestamp), когда чат был повышен |
| expiration_date | Integer | Момент времени (Unix timestamp), когда повышение автоматически истечет, если подписка на Telegram Premium не будет продлена |
| source | ChatBoostSource | Источник добавленного повышения |
ChatBoostUpdated
Этот объект представляет собой увеличение, добавленное к чату или измененное.
| Поле | Тип | Описание |
|---|---|---|
| chat | Chat | Чат, который был увеличен |
| boost | ChatBoost | Информация о повышении чата |
ChatBoostRemoved
Этот объект представляет собой удаленный буст из чата.
| Поле | Тип | Описание |
|---|---|---|
| chat | Chat | Чат, который был бустирован |
| boost_id | String | Уникальный идентификатор буста |
| remove_date | Integer | Момент времени (Unix timestamp), когда буст был удален |
| source | ChatBoostSource | Источник удаленного буста |
UserChatBoosts
Этот объект представляет собой список бустов, добавленных в чат пользователем.
| Поле | Тип | Описание |
|---|---|---|
| boosts | Массив ChatBoost | Список бустов, добавленных в чат пользователем |
BusinessConnection
Описывает соединение бота с бизнес-аккаунтом.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор бизнес-соединения |
| user | User | Пользователь бизнес-аккаунта, который создал бизнес-соединение |
| user_chat_id | Integer | Идентификатор приватного чата с пользователем, который создал бизнес-соединение. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности или иметь скрытые ошибки при его интерпретации. Но оно имеет не более 52 значащих бит, поэтому 64-битный целочисленный тип или тип с плавающей запятой двойной точности безопасны для хранения этого идентификатора. |
| date | Integer | Дата, когда соединение было установлено, в формате Unix time |
| can_reply | Boolean | True, если бот может действовать от имени бизнес-аккаунта в чатах, которые были активны в последние 24 часа |
| is_enabled | Boolean | True, если соединение активно |
BusinessMessagesDeleted
Этот объект получен, когда сообщения удаляются из подключенного бизнес-аккаунта.
| Поле | Тип | Описание |
|---|---|---|
| business_connection_id | String | Уникальный идентификатор бизнес-соединения |
| chat | Chat | Информация о чате в бизнес-аккаунте. Бот может не иметь доступа к чату или соответствующему пользователю. |
| message_ids | Array of Integer | Список идентификаторов удаленных сообщений в чате бизнес-аккаунта |
ResponseParameters
Описывает, почему запрос не удался.
| Поле | Тип | Описание |
|---|---|---|
| migrate_to_chat_id | Integer | Необязательное. Группа была мигрирована в супергруппу с указанным идентификатором. Это число может иметь более 32 значащих бит, и некоторые языки программирования могут испытывать трудности/молчаливые ошибки при его интерпретации. Но у него не более 52 значащих бит, поэтому знаковый 64-битный целочисленный тип или тип с плавающей точкой двойной точности безопасны для хранения этого идентификатора. |
| retry_after | Integer | Необязательное. В случае превышения контроля затопления, количество секунд, оставшихся до повторной отправки запроса |
InputMedia
Этот объект представляет содержимое медиа-сообщения, которое будет отправлено. Он должен быть одним из
InputMediaPhoto
Представляет собой фотографию, которая будет отправлена.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть photo |
| media | String | Файл для отправки. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram мог получить файл из Интернета, или передайте “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, если фотография должна быть закрыта анимацией спойлера |
InputMediaVideo
Представляет видео, которое будет отправлено.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть video |
| media | String | Файл для отправки. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram смог получить файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация об отправке файлов » |
| thumbnail | String | Необязательно. Эскиз отправленного файла; может быть проигнорирован, если генерация эскиза для файла поддерживается на стороне сервера. Эскиз должен быть в формате JPEG и размером менее 200 кБ. Ширина и высота эскиза не должны превышать 320. Игнорируется, если файл не загружен с использованием multipart/form-data. Эскизы не могут быть повторно использованы и могут быть загружены только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если эскиз был загружен с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация об отправке файлов » |
| cover | String | Необязательно. Обложка для видео в сообщении. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram смог получить файл из Интернета, или передайте “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, если видео необходимо закрыть анимацией спойлера |
InputMediaAnimation
Представляет собой файл анимации (GIF или видео H.264/MPEG-4 AVC без звука), который будет отправлен.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть animation |
| media | String | Файл для отправки. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram мог получить файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация по отправке файлов » |
| thumbnail | String | Необязательно. Миниатюра отправленного файла; может быть проигнорирована, если сервер поддерживает генерацию миниатюр для файла. Миниатюра должна быть в формате JPEG и размером менее 200 кБ. Ширина и высота миниатюры не должны превышать 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 |
| show_caption_above_media | Boolean | Необязательно. Передайте True, если подпись должна отображаться выше медиа-содержимого сообщения |
| width | Integer | Необязательно. Ширина анимации |
| height | Integer | Необязательно. Высота анимации |
| duration | Integer | Необязательно. Длительность анимации в секундах |
| has_spoiler | Boolean | Необязательно. Передайте True, если анимацию нужно закрыть спойлером |
InputMediaAudio
Представляет аудиофайл, который будет отправлен как музыка.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть audio |
| media | String | Файл для отправки. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram мог получить файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация о отправке файлов » |
| thumbnail | String | Необязательно. Эскиз отправленного файла; можно игнорировать, если генерация эскиза для файла поддерживается на стороне сервера. Эскиз должен быть в формате JPEG и размером менее 200 кБ. Ширина и высота эскиза не должны превышать 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, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), укажите HTTP URL, чтобы Telegram получил файл из Интернета, или укажите “attach://<file_attach_name>”, чтобы загрузить новый файл, используя multipart/form-data под именем <file_attach_name>. Дополнительная информация о отправке файлов » |
| thumbnail | String | Необязательно. Эскиз отправленного файла; можно игнорировать, если сервер поддерживает генерацию эскизов для файла. Эскиз должен быть в формате JPEG и размером менее 200 кБ. Ширина и высота эскиза не должны превышать 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, если документ отправляется как часть альбома. |
InputFile
Этот объект представляет собой содержимое файла, который необходимо загрузить. Должен быть отправлен с использованием multipart/form-data таким же образом, как файлы загружаются через браузер.
InputPaidMedia
Этот объект описывает платные медиа, которые должны быть отправлены. В настоящее время это может быть одним из
InputPaidMediaPhoto
Платное медиа для отправки — это фото.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип медиа, должен быть photo |
| media | String | Файл для отправки. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram мог получить файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Больше информации об отправке файлов » |
InputPaidMediaVideo
Оплачиваемый медиа-контент для отправки — это видео.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип медиа, должен быть video |
| media | String | Файл для отправки. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram получил файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация об отправке файлов » |
| thumbnail | String | Необязательно. Эскиз отправленного файла; может быть проигнорирован, если генерация эскизов для файла поддерживается на стороне сервера. Эскиз должен быть в формате JPEG и размером менее 200 кБ. Ширина и высота эскиза не должны превышать 320. Игнорируется, если файл не загружается с использованием multipart/form-data. Эскизы не могут быть повторно использованы и могут быть загружены только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если эскиз был загружен с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация об отправке файлов » |
| cover | String | Необязательно. Обложка для видео в сообщении. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram получил файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация об отправке файлов » |
| start_timestamp | Integer | Необязательно. Начальная метка времени для видео в сообщении |
| width | Integer | Необязательно. Ширина видео |
| height | Integer | Необязательно. Высота видео |
| duration | Integer | Необязательно. Длительность видео в секундах |
| supports_streaming | Boolean | Необязательно. Передайте True, если загруженное видео подходит для потоковой передачи |
Отправка файлов
Существует три способа отправки файлов (фото, стикеры, аудио, медиа и т.д.):
- Если файл уже хранится на серверах Telegram, вам не нужно загружать его заново: у каждого объекта файла есть поле file_id, просто передайте этот file_id в качестве параметра вместо загрузки. Для файлов, отправленных таким образом, нет ограничений.
- Предоставьте Telegram HTTP URL для файла, который нужно отправить. Telegram загрузит и отправит файл. Максимальный размер 5 МБ для фото и 20 МБ для других типов контента.
- Отправьте файл, используя multipart/form-data, как обычно загружаются файлы через браузер. Максимальный размер 10 МБ для фото, 50 МБ для других файлов.
Отправка по file_id
- Невозможно изменить тип файла при повторной отправке по file_id. То есть, видео не может быть отправлено как фото, фото не может быть отправлено как документ и т.д.
- Невозможно повторно отправить миниатюры.
- Повторная отправка фото по file_id отправит все его размеры.
- file_id уникален для каждого отдельного бота и не может быть передан от одного бота к другому.
- file_id уникально идентифицирует файл, но файл может иметь разные действительные file_id даже для одного и того же бота.
Отправка по URL
- При отправке по URL целевой файл должен иметь правильный MIME тип (например, audio/mpeg для sendAudio и т.д.).
- В sendDocument отправка по URL в настоящее время будет работать только для файлов .PDF и .ZIP.
- Чтобы использовать sendVoice, файл должен иметь тип audio/ogg и размер не более 1 МБ. Голосовые заметки размером от 1 до 20 МБ будут отправлены как файлы.
- Другие конфигурации могут работать, но мы не можем гарантировать, что они будут работать.
Акцентные цвета
Цвета с идентификаторами 0 (красный), 1 (оранжевый), 2 (пурпурный/фиолетовый), 3 (зеленый), 4 (циановый), 5 (синий), 6 (розовый) могут быть настроены с помощью тем приложений. Кроме того, в настоящее время используются следующие цвета в формате RGB.
| Идентификатор цвета | Светлые цвета | Темные цвета |
|---|---|---|
| 7 | E15052 F9AE63 | FF9380 992F37 |
| 8 | E0802B FAC534 | ECB04E C35714 |
| 9 | A05FF3 F48FFF | C697FF 5E31C8 |
| 10 | 27A910 A7DC57 | A7EB6E 167E2D |
| 11 | 27ACCE 82E8D6 | 40D8D0 045C7F |
| 12 | 3391D4 7DD3F0 | 52BFFF 0B5494 |
| 13 | DD4371 FFBE9F | FF86A6 8E366E |
| 14 | 247BED F04856 FFFFFF | 3FA2FE E5424F FFFFFF |
| 15 | D67722 1EA011 FFFFFF | FF905E 32A527 FFFFFF |
| 16 | 179E42 E84A3F FFFFFF | 66D364 D5444F FFFFFF |
| 17 | 2894AF 6FC456 FFFFFF | 22BCE2 3DA240 FFFFFF |
| 18 | 0C9AB3 FFAD95 FFE6B5 | 22BCE2 FF9778 FFDA6B |
| 19 | 7757D6 F79610 FFDE8E | 9791FF F2731D FFDB59 |
| 20 | 1585CF F2AB1D FFFFFF | 3DA6EB EEA51D FFFFFF |
Цвета акцента профиля
В настоящее время для фонов профиля используются следующие цвета в формате RGB.
| Идентификатор цвета | Светлые цвета | Темные цвета |
|---|---|---|
| 0 | BA5650 | 9C4540 |
| 1 | C27C3E | 945E2C |
| 2 | 956AC8 | 715099 |
| 3 | 49A355 | 33713B |
| 4 | 3E97AD | 387E87 |
| 5 | 5A8FBB | 477194 |
| 6 | B85378 | 944763 |
| 7 | 7F8B95 | 435261 |
| 8 | C9565D D97C57 | 994343 AC583E |
| 9 | CF7244 CC9433 | 8F552F A17232 |
| 10 | 9662D4 B966B6 | 634691 9250A2 |
| 11 | 3D9755 89A650 | 296A43 5F8F44 |
| 12 | 3D95BA 50AD98 | 306C7C 3E987E |
| 13 | 538BC2 4DA8BD | 38618C 458BA1 |
| 14 | B04F74 D1666D | 884160 A65259 |
| 15 | 637482 7B8A97 | 53606E 384654 |
Объекты режима инлайн
Объекты и методы, используемые в режиме инлайн, описаны в разделе о режиме инлайн.
Доступные методы
Все методы в Bot API нечувствительны к регистру. Мы поддерживаем GET и POST HTTP методы. Используйте либо строку запроса URL, либо application/json, либо application/x-www-form-urlencoded, либо multipart/form-data для передачи параметров в запросах Bot API.
При успешном вызове будет возвращён JSON-объект, содержащий результат.
getMe
Простой метод для тестирования токена аутентификации вашего бота. Не требует параметров. Возвращает основную информацию о боте в виде объекта User.
Выход
Используйте этот метод для выхода из облачного сервера Bot API перед запуском бота локально. Вы должны выйти из бота перед его локальным запуском, в противном случае нет гарантии, что бот будет получать обновления. После успешного вызова вы можете сразу войти на локальном сервере, но не сможете снова войти в облачный сервер Bot API в течение 10 минут. Возвращает True в случае успеха. Не требует параметров.
закрыть
Используйте этот метод для закрытия экземпляра бота перед перемещением его с одного локального сервера на другой. Вам необходимо удалить вебхук перед вызовом этого метода, чтобы обеспечить отсутствие повторного запуска бота после перезагрузки сервера. Метод вернет ошибку 429 в первые 10 минут после запуска бота. Возвращает True в случае успеха. Не требует параметров.
sendMessage
Используйте этот метод для отправки текстовых сообщений. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername)
|
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщений (топика) форума; только для супергрупп форума |
| 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который необходимо добавить к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные интерфейсные опции. JSON-сериализованный объект для встраиваемой клавиатуры, пользовательской клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принудительного ответа от пользователя |
Опции форматирования
Bot API поддерживает базовое форматирование сообщений. Вы можете использовать жирный, курсивный, подчеркивающий, зачеркивающий текст, текст-спойлер, блочные цитаты, а также встроенные ссылки и предварительно отформатированный код в сообщениях ваших ботов. Клиенты Telegram будут отображать их соответствующим образом. Вы можете указывать текстовые сущности напрямую или использовать форматирование в стиле markdown или HTML.
Обратите внимание, что клиенты Telegram будут отображать уведомление пользователю перед открытием встроенной ссылки ('Открыть эту ссылку?' вместе с полным URL).
Сущности сообщений могут быть вложенными, при соблюдении следующих ограничений:
- Если две сущности имеют общие
символы, то одна из них полностью содержится внутри другой.
- Сущности bold, italic, underline,
strikethrough и spoiler могут содержать и могут быть частью любых других сущностей, кроме
pre и code.
- Сущности blockquote и expandable_blockquote не могут быть
вложенными.
- Все другие сущности не могут содержать друг друга.
Ссылки tg://user?id=<user_id> могут использоваться для упоминания пользователя по его
идентификатору без использования имени пользователя. Обратите внимание:
- Эти ссылки будут работать только, если они используются внутри встроенной ссылки или в кнопке встроенной клавиатуры. Например, они не будут работать, если использовать их в тексте сообщения.
- Если пользователь не является участником чата, где его упомянули, эти упоминания гарантированно будут работать только в том случае, если пользователь ранее связывался с ботом в личных сообщениях или отправлял обратный запрос к боту через встроенную кнопку и не включал настройки конфиденциальности для пересланных сообщений для бота.
Вы можете найти список языков программирования и разметки, для которых поддерживается подсветка синтаксиса, на libprisma#supported-languages.
Стиль MarkdownV2
Чтобы использовать этот режим, передайте MarkdownV2 в поле parse_mode. Используйте следующий синтаксис в вашем сообщении:
*жирный \*текст*
_курсив \*текст_
__подчеркивание__
~зачеркивание~
||спойлер||
*жирный _курсив жирный ~курсив жирный зачеркивание ||курсив жирный зачеркивание спойлер||~ __подчеркивание курсив жирный___ жирный*
[встроенная URL](http://www.example.com/)
[встроенное упоминание пользователя](tg://user?id=123456789)
](tg://emoji?id=5368324170671202286)
`встроенный фиксированной ширины код`
```
предварительно отформатированный фиксированной ширины блок кода
```
```python
предварительно отформатированный фиксированной ширины блок кода, написанный на языке программирования Python
```
>Блоковая цитата начата
>Блоковая цитата продолжается
>Блоковая цитата продолжается
>Блоковая цитата продолжается
>Последняя строка блоковой цитаты
**>Расширяемая блоковая цитата начата сразу после предыдущей блоковой цитаты
>Она отделена от предыдущей блоковой цитаты пустой жирной сущностью
>Расширяемая блоковая цитата продолжается
>Скрытая по умолчанию часть расширяемой блоковой цитаты начата
>Расширяемая блоковая цитата продолжается
>Последняя строка расширяемой блоковой цитаты с отметкой расширяемости||Обратите внимание:
- Любой символ с кодом от 1 до 126 включительно может быть экранирован в любом месте с предшествующим символом '\', в этом случае он рассматривается как обычный символ, а не как часть разметки. Это подразумевает, что символ '\' обычно должен быть экранирован с предшествующим символом '\'.
- Внутри сущностей
preиcodeвсе '`' и '\' символы должны быть экранированы с предшествующим символом '\'. - Внутри части
(...)встроенной ссылки и определения пользовательского эмодзи все ')' и '\' должны быть экранированы с предшествующим символом '\'. - Во всех других местах символы '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' должны быть экранированы предшествующим символом '\'.
- В случае неоднозначности между сущностями
italicиunderline__всегда жадно рассматривается слева направо как начало или конец сущностиunderline, поэтому вместо___italic underline___используйте___italic underline_**__, добавляя пустую жирную сущность в качестве разделителя. - Действительный эмодзи должен быть предоставлен в качестве альтернативного значения для пользовательского эмодзи. Эмодзи будет показан вместо пользовательского эмодзи в местах, где пользовательский эмодзи не может быть отображен (например, системные уведомления) или если сообщение пересылается непремиум пользователем. Рекомендуется использовать эмодзи из поля emoji пользовательского эмодзи стикера.
- Сущности пользовательского эмодзи могут использоваться только ботами, которые приобрели дополнительные имена пользователей на Fragment.
Стиль 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="tg://user?id=123456789">inline mention of a user</a>
<tg-emoji emoji-id="5368324170671202286">
</tg-emoji>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>
<blockquote>Block quotation started\nBlock quotation continued\nThe last line of the block quotation</blockquote>
<blockquote expandable>Expandable block quotation started\nExpandable block quotation continued\nExpandable block quotation continued\nHidden by default part of the block quotation started\nExpandable block quotation continued\nThe last line of the block quotation</blockquote>Обратите внимание:
- В настоящее время поддерживаются только упомянутые выше теги.
- Все символы
<,>и&, которые не являются частью тега или HTML-сущности, должны быть заменены соответствующими HTML-сущностями (<на<,>на>и&на&). - Поддерживаются все числовые HTML-сущности.
- API в настоящее время поддерживает только следующие именованные HTML-сущности:
<,>,&и". - Используйте вложенные теги
preиcode, чтобы определить язык программирования для сущностиpre. - Язык программирования нельзя указать для отдельно стоящих тегов
code. - В качестве содержимого тега
tg-emojiдолжен использоваться допустимый эмодзи. Эмодзи будет показан вместо пользовательского эмодзи в местах, где пользовательский эмодзи не может быть отображен (например, системные уведомления) или если сообщение переслано непремиум пользователем. Рекомендуется использовать эмодзи из поля emoji пользовательского эмодзи sticker. - Сущности пользовательских эмодзи могут использоваться только ботами, которые приобрели дополнительные имена пользователей на Fragment.
Стиль Markdown
Это устаревший режим, сохраненный для обратной совместимости. Чтобы использовать этот режим, передайте Markdown в поле parse_mode. Используйте следующий синтаксис в вашем сообщении:
*полужирный текст*
_курсивный текст_
[встроенная ссылка](http://www.example.com/)
[встроенное упоминание пользователя](tg://user?id=123456789)
`встроенный моноширинный код`
```
блок предварительно отформатированного моноширинного кода
```
```python
блок предварительно отформатированного моноширинного кода, написанный на языке программирования Python
```Обратите внимание:
- Сущности не должны быть вложенными, используйте режим разбора MarkdownV2 вместо этого.
- Нет возможности указать сущности «подчеркивание», «зачеркивание», «спойлер», «цитата», «развернутая цитата» и «пользовательский эмодзи», используйте режим разбора MarkdownV2 вместо этого.
- Чтобы экранировать символы '_', '*', '`', '[' вне сущности, добавьте символ '\' перед ними.
- Экранирование внутри сущностей не допускается, поэтому сущность должна быть сначала закрыта, а затем снова открыта: используйте
_snake_\__case_для курсиваsnake_caseи*2*\**2=4*для полужирного2*2=4.
Платные трансляции
По умолчанию все боты могут отправлять до 30 сообщений в секунду своим пользователям. Разработчики могут увеличить этот лимит, включив Платные трансляции в @Botfather - что позволяет их боту отправлять до 1000 сообщений в секунду.
Каждое сообщение, отправленное сверх бесплатного лимита в 30 сообщений в секунду, стоит 0.1 Stars за сообщение, оплачиваемое с помощью Telegram Stars из баланса бота. Чтобы использовать эту функцию, бот должен иметь как минимум 10,000 Stars на своем балансе.
Боты с увеличенными лимитами оплачиваются только за сообщения, которые были успешно отправлены.
forwardMessage
Используйте этот метод для пересылки сообщений любого типа. Сервисные сообщения и сообщения с защищенным содержимым не могут быть пересланы. При успешном выполнении отправленное Сообщение возвращается.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор для целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Целое число | Необязательно | Уникальный идентификатор для целевой темы сообщения (топика) форума; только для супергрупп форума |
| from_chat_id | Целое число или строка | Да | Уникальный идентификатор для чата, из которого было отправлено оригинальное сообщение (или имя пользователя канала в формате @channelusername) |
| video_start_timestamp | Целое число | Необязательно | Новая метка времени начала для пересылаемого видео в сообщении |
| disable_notification | Булевый | Необязательно | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Булевый | Необязательно | Защищает содержимое пересылаемого сообщения от пересылки и сохранения |
| message_id | Целое число | Да | Идентификатор сообщения в чате, указанном в from_chat_id |
forwardMessages
Используйте этот метод для пересылки нескольких сообщений любого типа. Если некоторые из указанных сообщений не могут быть найдены или пересланы, они будут пропущены. Сервисные сообщения и сообщения с защищенным контентом не могут быть пересланы. Группировка альбомов сохраняется для пересылаемых сообщений. В случае успеха возвращается массив MessageId отправленных сообщений.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Целое число | Необязательно | Уникальный идентификатор целевой темы сообщений (темы) форума; только для супергрупп форума |
| from_chat_id | Целое число или строка | Да | Уникальный идентификатор чата, из которого были отправлены оригинальные сообщения (или имя пользователя канала в формате @channelusername) |
| message_ids | Массив целых чисел | Да | JSON-сериализованный список из 1-100 идентификаторов сообщений в чате from_chat_id для пересылки. Идентификаторы должны быть указаны в строго возрастающем порядке. |
| disable_notification | Булевый | Необязательно | Отправляет сообщения тихо. Пользователи получат уведомление без звука. |
| protect_content | Булевый | Необязательно | Защищает содержимое пересылаемых сообщений от пересылки и сохранения |
copyMessage
Используйте этот метод для копирования сообщений любого типа. Сервисные сообщения, сообщения с платным контентом, сообщения о розыгрышах, сообщения о победителях розыгрышей и сообщения с инвойсами не могут быть скопированы. Опрос poll может быть скопирован только в том случае, если значение поля correct_option_id известно боту. Метод аналогичен методу forwardMessage, но скопированное сообщение не имеет ссылки на оригинальное сообщение. Возвращает MessageId отправленного сообщения в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Целое число | Необязательный | Уникальный идентификатор целевой темы сообщений (топика) форума; только для супергрупп форума |
| from_chat_id | Целое число или строка | Да | Уникальный идентификатор чата, из которого было отправлено оригинальное сообщение (или имя пользователя канала в формате @channelusername) |
| message_id | Целое число | Да | Идентификатор сообщения в чате, указанном в from_chat_id |
| video_start_timestamp | Целое число | Необязательный | Новая метка времени начала для скопированного видео в сообщении |
| caption | Строка | Необязательный | Новая подпись для медиа, 0-1024 символов после парсинга сущностей. Если не указано, оригинальная подпись сохраняется |
| parse_mode | Строка | Необязательный | Режим для парсинга сущностей в новой подписи. См. варианты форматирования для получения дополнительных сведений. |
| caption_entities | Массив MessageEntity | Необязательный | JSON-сериализованный список специальных сущностей, которые появляются в новой подписи, которые могут быть указаны вместо parse_mode |
| show_caption_above_media | Логическое | Необязательный | Передайте True, если подпись должна отображаться над медиа сообщения. Игнорируется, если новая подпись не указана. |
| disable_notification | Логическое | Необязательный | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Логическое | Необязательный | Защищает содержимое отправленного сообщения от пересылки и сохранения |
| allow_paid_broadcast | Логическое | Необязательный | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты на рассылку за плату 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, кастомной клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принудительного ответа от пользователя |
copyMessages
Используйте этот метод для копирования сообщений любого типа. Если некоторые из указанных сообщений не могут быть найдены или скопированы, они будут пропущены. Сервисные сообщения, платные медиа сообщения, сообщения о розыгрышах, сообщения о победителях розыгрышей и сообщения с инвойсами не могут быть скопированы. Опрос poll может быть скопирован только в том случае, если значение поля correct_option_id известно боту. Этот метод аналогичен методу forwardMessages, но скопированные сообщения не имеют ссылки на оригинальное сообщение. Группировка альбомов сохраняется для скопированных сообщений. При успешном выполнении возвращается массив MessageId отправленных сообщений.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Целое число | Необязательный | Уникальный идентификатор целевой темы сообщений (топика) форума; только для супергрупп форума |
| from_chat_id | Целое число или строка | Да | Уникальный идентификатор чата, из которого были отправлены оригинальные сообщения (или имя пользователя канала в формате @channelusername) |
| message_ids | Массив целых чисел | Да | JSON-сериализованный список из 1-100 идентификаторов сообщений в чате from_chat_id для копирования. Идентификаторы должны быть указаны в строго возрастающем порядке. |
| disable_notification | Булево | Необязательный | Отправляет сообщения тихо. Пользователи получат уведомление без звука. |
| protect_content | Булево | Необязательный | Защищает содержимое отправленных сообщений от пересылки и сохранения |
| remove_caption | Булево | Необязательный | Укажите True, чтобы скопировать сообщения без их подписей |
sendPhoto
Используйте этот метод для отправки фотографий. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп форума |
| photo | InputFile or String | Да | Фото для отправки. Передайте file_id в виде строки, чтобы отправить фотографию, которая существует на серверах Telegram (рекомендуется), передайте HTTP URL в виде строки, чтобы Telegram получил фотографию из Интернета, или загрузите новое фото с помощью multipart/form-data. Размер фотографии не должен превышать 10 МБ. Ширина и высота фотографии не должны превышать 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для частных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, пользовательской клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принудительного ответа от пользователя |
sendAudio
Используйте этот метод для отправки аудиофайлов, если вы хотите, чтобы клиенты Telegram отображали их в музыкальном плеере. Ваше аудио должно быть в формате .MP3 или .M4A. В случае успеха возвращается отправленное Сообщение. В настоящее время боты могут отправлять аудиофайлы размером до 50 МБ, этот лимит может быть изменен в будущем.
Для отправки голосовых сообщений используйте метод sendVoice вместо этого.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщения (темы) форума; только для супергрупп форума |
| audio | InputFile или String | Да | Аудиофайл для отправки. Передайте file_id как String, чтобы отправить аудиофайл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL как String, чтобы Telegram получил аудиофайл из Интернета, или загрузите новый с помощью multipart/form-data. Дополнительная информация о отправке файлов » |
| caption | String | Необязательный | Подпись к аудио, 0-1024 символов после парсинга сущностей |
| parse_mode | String | Необязательный | Режим для парсинга сущностей в подписи к аудио. См. опции форматирования для получения дополнительных сведений. |
| caption_entities | Массив MessageEntity | Необязательный | JSON-сериализованный список специальных сущностей, которые появляются в подписи, которые могут быть указаны вместо parse_mode |
| duration | Integer | Необязательный | Длительность аудио в секундах |
| performer | String | Необязательный | Исполнитель |
| title | String | Необязательный | Название трека |
| thumbnail | InputFile или String | Необязательный | Миниатюра отправленного файла; может быть проигнорирована, если серверная поддержка генерации миниатюр для файла доступна. Миниатюра должна быть в формате JPEG и размером менее 200 кБ. Ширина и высота миниатюры не должны превышать 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, кастомной клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принудительного ответа от пользователя |
sendDocument
Используйте этот метод для отправки общих файлов. В случае успеха возвращается отправленное Сообщение. Боты в настоящее время могут отправлять файлы любого типа размером до 50 МБ, этот лимит может быть изменен в будущем.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщения (топика) форума; только для супер-групп форума |
| document | InputFile или String | Да | Файл для отправки. Передайте file_id как String, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL как String, чтобы Telegram получил файл из Интернета, или загрузите новый, используя multipart/form-data. Дополнительная информация о отправке файлов » |
| thumbnail | InputFile или String | Необязательный | Миниатюра отправленного файла; может быть проигнорирована, если сервер поддерживает генерацию миниатюр для файла. Миниатюра должна быть в формате JPEG и размером менее 200 кБ. Ширина и высота миниатюры не должны превышать 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 | Массив 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для встраиваемой клавиатуры, пользовательской клавиатуры для ответа, инструкции по удалению клавиатуры для ответа или принуждению пользователя к ответу |
sendVideo
Используйте этот метод для отправки видеофайлов, клиенты Telegram поддерживают видео в формате MPEG4 (другие форматы могут быть отправлены как Документ). В случае успеха возвращается отправленное Сообщение. В данный момент боты могут отправлять видеофайлы размером до 50 МБ, этот лимит может быть изменен в будущем.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп форума |
| video | InputFile или String | Да | Видео для отправки. Передайте file_id как String, чтобы отправить видео, которое существует на серверах Telegram (рекомендуется), передайте HTTP URL как String, чтобы Telegram получил видео из Интернета, или загрузите новое видео, используя multipart/form-data. Дополнительная информация о отправке файлов » |
| duration | Integer | Необязательный | Длительность отправленного видео в секундах |
| width | Integer | Необязательный | Ширина видео |
| height | Integer | Необязательный | Высота видео |
| thumbnail | InputFile или String | Необязательный | Миниатюра отправленного файла; может быть проигнорирована, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и меньше 200 кБ по размеру. Ширина и высота миниатюры не должны превышать 320. Игнорируется, если файл не загружен с использованием multipart/form-data. Миниатюры не могут быть повторно использованы и могут быть загружены только как новый файл, поэтому вы можете передать “attach://<file_attach_name>”, если миниатюра была загружена с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация о отправке файлов » |
| cover | InputFile или String | Необязательный | Обложка для видео в сообщении. Передайте file_id, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL, чтобы Telegram получил файл из Интернета, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с использованием multipart/form-data под именем <file_attach_name>. Дополнительная информация о отправке файлов » |
| start_timestamp | Integer | Необязательный | Временная метка начала для видео в сообщении |
| caption | String | Необязательный | Подпись к видео (может также использоваться при повторной отправке видео по file_id), 0-1024 символов после парсинга сущностей |
| parse_mode | String | Необязательный | Режим для парсинга сущностей в подписи к видео. См. варианты форматирования для получения дополнительных сведений. |
| caption_entities | Массив 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный для inline keyboard, custom reply keyboard, инструкции по удалению клавиатуры ответа или принудительному ответу пользователя |
sendAnimation
Используйте этот метод для отправки анимационных файлов (GIF или видео H.264/MPEG-4 AVC без звука). В случае успеха возвращается отправленное Сообщение. Боты в настоящее время могут отправлять анимационные файлы размером до 50 МБ, этот лимит может быть изменен в будущем.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщения (топика) форума; только для супергрупп форума |
| animation | InputFile или String | Да | Анимация для отправки. Передайте file_id как String, чтобы отправить анимацию, которая существует на серверах Telegram (рекомендуется), передайте HTTP URL как String, чтобы Telegram получил анимацию из Интернета, или загрузите новую анимацию с помощью multipart/form-data. Дополнительная информация о отправке файлов » |
| duration | Integer | Необязательный | Длительность отправленной анимации в секундах |
| width | Integer | Необязательный | Ширина анимации |
| height | Integer | Необязательный | Высота анимации |
| thumbnail | InputFile или String | Необязательный | Миниатюра отправленного файла; может быть проигнорирована, если генерация миниатюры для файла поддерживается на стороне сервера. Миниатюра должна быть в формате JPEG и размером менее 200 кБ. Ширина и высота миниатюры не должны превышать 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для приватных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, кастомной клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или принуждению к ответу от пользователя |
sendVoice
Используйте этот метод для отправки аудиофайлов, если вы хотите, чтобы клиенты Telegram отображали файл как воспроизводимое голосовое сообщение. Для этого ваш аудиофайл должен быть в формате .OGG, закодированным с помощью OPUS, или в формате .MP3, или в формате .M4A (другие форматы могут быть отправлены как Аудио или Документ). В случае успеха возвращается отправленное Сообщение. В данный момент боты могут отправлять голосовые сообщения размером до 50 МБ, этот лимит может быть изменен в будущем.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп форума |
| voice | InputFile или String | Да | Аудиофайл для отправки. Передайте file_id как строку, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL как строку, чтобы Telegram получил файл из Интернета, или загрузите новый с помощью multipart/form-data. Дополнительная информация о отправке файлов » |
| caption | String | Необязательный | Подпись к голосовому сообщению, 0-1024 символа после разбора сущностей |
| parse_mode | String | Необязательный | Режим для разбора сущностей в подписи голосового сообщения. См. варианты форматирования для получения дополнительных сведений. |
| caption_entities | Массив MessageEntity | Необязательный | JSON-сериализованный список специальных сущностей, которые появляются в подписи, которые могут быть указаны вместо parse_mode |
| duration | Integer | Необязательный | Продолжительность голосового сообщения в секундах |
| disable_notification | Boolean | Необязательный | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Необязательный | Защищает содержимое отправленного сообщения от пересылки и сохранения |
| allow_paid_broadcast | Boolean | Необязательный | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты трансляции за плату в 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для встраиваемой клавиатуры, пользовательской клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принудительного ответа от пользователя |
sendVideoNote
Начиная с версии 4.0, клиенты Telegram поддерживают округленные квадратные MPEG4 видео длительностью до 1 минуты. Используйте этот метод для отправки видео сообщений. При успешной отправке возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщения (топика) форума; только для супергрупп форума |
| video_note | InputFile или String | Да | Видео заметка для отправки. Передайте file_id как String, чтобы отправить видео заметку, которая существует на серверах Telegram (рекомендуется) или загрузите новое видео с помощью multipart/form-data. Дополнительная информация об отправке файлов ». Отправка видео заметок по URL в настоящее время не поддерживается |
| duration | Integer | Необязательный | Длительность отправленного видео в секундах |
| length | Integer | Необязательный | Ширина и высота видео, т.е. диаметр видео сообщения |
| thumbnail | InputFile или String | Необязательный | Эскиз отправляемого файла; может быть проигнорирован, если генерация эскиза для файла поддерживается на стороне сервера. Эскиз должен быть в формате JPEG и размером менее 200 кБ. Ширина и высота эскиза не должны превышать 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 Telegram Stars за сообщение. Соответствующие Stars будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для встраиваемой клавиатуры, пользовательской клавиатуры для ответа, инструкции по удалению клавиатуры для ответа или для принуждения пользователя к ответу |
sendPaidMedia
Используйте этот метод для отправки платного медиа. В случае успеха отправленное Сообщение будет возвращено.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername). Если чат является каналом, все Telegram Stars, полученные от этого медиа, будут зачислены на баланс чата. В противном случае они будут зачислены на баланс бота. |
| star_count | Integer | Да | Количество Telegram Stars, которые необходимо заплатить для покупки доступа к медиа; от 1 до 2500 |
| media | Array of InputPaidMedia | Да | JSON-сериализованный массив, описывающий медиа для отправки; до 10 элементов |
| payload | 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 Telegram Stars за сообщение. Соответствующие Stars будут списаны с баланса бота |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для встроенной клавиатуры, пользовательской клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или принуждению пользователя к ответу |
sendMediaGroup
Используйте этот метод для отправки группы фотографий, видео, документов или аудио в виде альбома. Документы и аудиофайлы могут быть сгруппированы в альбоме только с сообщениями одного типа. В случае успешного выполнения возвращается массив Сообщений, которые были отправлены.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательно | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательно | Уникальный идентификатор целевой темы сообщений (топика) форума; только для супергрупп форума |
| media | Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto и InputMediaVideo | Да | JSON-сериализованный массив, описывающий сообщения, которые будут отправлены, должен содержать от 2 до 10 элементов |
| disable_notification | Boolean | Необязательно | Отправляет сообщения тихо. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Необязательно | Защищает содержимое отправленных сообщений от пересылки и сохранения |
| allow_paid_broadcast | Boolean | Необязательно | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя ограничения на трансляцию за плату 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательно | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательно | Описание сообщения, на которое нужно ответить |
sendLocation
Используйте этот метод для отправки точки на карте. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп форума |
| latitude | Float | Да | Широта местоположения |
| longitude | Float | Да | Долгота местоположения |
| horizontal_accuracy | Float | Необязательный | Радиус неопределенности для местоположения, измеряемый в метрах; 0-1500 |
| live_period | Integer | Необязательный | Период в секундах, в течение которого местоположение будет обновляться (см. Живые местоположения, должен быть между 60 и 86400, или 0x7FFFFFFF для живых местоположений, которые могут редактироваться бесконечно). |
| heading | Integer | Необязательный | Для живых местоположений направление, в котором движется пользователь, в градусах. Должен быть между 1 и 360, если указан. |
| proximity_alert_radius | Integer | Необязательный | Для живых местоположений максимальное расстояние для предупреждений о приближении другого участника чата, в метрах. Должен быть между 1 и 100000, если указан. |
| disable_notification | Boolean | Необязательный | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Необязательный | Защищает содержимое отправленного сообщения от пересылки и сохранения |
| allow_paid_broadcast | Boolean | Необязательный | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя ограничения на трансляцию за плату 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для встраиваемой клавиатуры, кастомной клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или принуждению пользователя к ответу |
sendVenue
Используйте этот метод для отправки информации о месте. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательно | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательно | Уникальный идентификатор целевой ветки сообщений (темы) форума; только для супергрупп форума |
| 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательно | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для частных чатов |
| reply_parameters | ReplyParameters | Необязательно | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательно | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, кастомной клавиатуры ответа, инструкции по удалению клавиатуры ответа или для принуждения ответа от пользователя |
sendContact
Используйте этот метод для отправки телефонных контактов. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщения (топика) форума; только для супергрупп форума |
| 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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для приватных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для встроенной клавиатуры, кастомной клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принуждения пользователя к ответу |
sendPoll
Используйте этот метод для отправки нативного опроса. В случае успеха будет возвращено отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| 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 | Да | Список из 2-10 вариантов ответов, сериализованный в формате JSON |
| is_anonymous | Boolean | Необязательный | True, если опрос должен быть анонимным, по умолчанию True |
| type | String | Необязательный | Тип опроса, “quiz” или “regular”, по умолчанию “regular” |
| allows_multiple_answers | Boolean | Необязательный | True, если опрос позволяет несколько ответов, игнорируется для опросов в режиме викторины, по умолчанию False |
| correct_option_id | Integer | Необязательный | Идентификатор правильного варианта ответа, основанный на 0, необходим для опросов в режиме викторины |
| explanation | String | Необязательный | Текст, который отображается, когда пользователь выбирает неправильный ответ или нажимает на иконку лампочки в опросе в стиле викторины, 0-200 символов с максимум 2 переносами строк после парсинга сущностей |
| explanation_parse_mode | String | Необязательный | Режим для парсинга сущностей в объяснении. См. варианты форматирования для получения дополнительных сведений. |
| explanation_entities | Array of MessageEntity | Необязательный | Список специальных сущностей, которые появляются в объяснении опроса, сериализованный в формате JSON. Его можно указать вместо explanation_parse_mode |
| open_period | Integer | Необязательный | Количество времени в секундах, в течение которого опрос будет активен после создания, 5-600. Не может использоваться вместе с close_date. |
| close_date | Integer | Необязательный | Момент времени (Unix timestamp), когда опрос будет автоматически закрыт. Должен быть как минимум через 5 секунд и не более чем через 600 секунд в будущем. Не может использоваться вместе с open_period. |
| is_closed | Boolean | Необязательный | Передайте True, если опрос должен быть немедленно закрыт. Это может быть полезно для предварительного просмотра опроса. |
| disable_notification | Boolean | Необязательный | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Необязательный | Защищает содержимое отправленного сообщения от пересылки и сохранения |
| allow_paid_broadcast | Boolean | Необязательный | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты трансляции за плату 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. Сериализованный в формате JSON объект для инлайн-клавиатуры, кастомной клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принуждения ответа от пользователя |
sendDice
Используйте этот метод для отправки анимированного эмодзи, который будет отображать случайное значение. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщения (топика) форума; только для супергрупп форума |
| emoji | String | Необязательный | Эмодзи, на основе которого строится анимация броска кубика. В настоящее время должен быть одним из “ ”, “ ”, “ ”, “ ”, “ ” или “ ”. Кубики могут иметь значения от 1 до 6 для “”, “” и “”, значения от 1 до 5 для “” и “”, и значения от 1 до 64 для “”. По умолчанию “” |
| disable_notification | Boolean | Необязательный | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Необязательный | Защищает содержимое отправленного сообщения от пересылки |
| allow_paid_broadcast | Boolean | Необязательный | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя ограничения на трансляцию за плату 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательный | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, пользовательской клавиатуры для ответа, инструкции по удалению клавиатуры для ответа или принуждению пользователя к ответу |
sendChatAction
Используйте этот метод, когда вам нужно сообщить пользователю, что что-то происходит на стороне бота. Статус устанавливается на 5 секунд или меньше (когда сообщение приходит от вашего бота, клиенты Telegram очищают его статус ввода). Возвращает True в случае успеха.
Пример: ImageBot требует некоторое время для обработки запроса и загрузки изображения. Вместо того чтобы отправлять текстовое сообщение вроде “Получение изображения, пожалуйста, подождите…”, бот может использовать sendChatAction с action = upload_photo. Пользователь увидит статус “отправка фото” для бота.
Мы рекомендуем использовать этот метод только в тех случаях, когда ответ от бота займет заметное количество времени.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено действие |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой ветки сообщений; только для супергрупп |
| action | String | Да | Тип действия для трансляции. Выберите одно, в зависимости от того, что пользователь собирается получить: typing для текстовых сообщений, upload_photo для фото, record_video или upload_video для видео, record_voice или upload_voice для голосовых заметок, upload_document для общих файлов, choose_sticker для стикеров, find_location для данных о местоположении, record_video_note или upload_video_note для видеозаметок. |
setMessageReaction
Используйте этот метод, чтобы изменить выбранные реакции на сообщение. На сервисные сообщения некоторых типов нельзя реагировать. Автоматически пересланные сообщения из канала в его группу обсуждений имеют такие же доступные реакции, как и сообщения в канале. Боты не могут использовать платные реакции. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Целое число | Да | Идентификатор целевого сообщения. Если сообщение принадлежит медиагруппе, реакция устанавливается на первое неудалённое сообщение в группе. |
| reaction | Массив ReactionType | Необязательный | JSON-сериализованный список типов реакций, которые нужно установить на сообщение. В настоящее время, как пользователи без премиум-статуса, боты могут установить до одной реакции на сообщение. Пользовательская реакция с эмодзи может быть использована, если она уже присутствует в сообщении или явно разрешена администраторами чата. Платные реакции не могут использоваться ботами. |
| is_big | Булевый | Необязательный | Передайте True, чтобы установить реакцию с большой анимацией |
getUserProfilePhotos
Используйте этот метод, чтобы получить список фотографий профиля пользователя. Возвращает объект UserProfilePhotos.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| 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
Используйте этот метод, чтобы получить основную информацию о файле и подготовить его к загрузке. В данный момент боты могут загружать файлы размером до 20 МБ. В случае успеха возвращается объект File. Файл затем можно загрузить по ссылке https://api.telegram.org/file/bot<token>/<file_path>, где <file_path> берется из ответа. Гарантируется, что ссылка будет действительна как минимум 1 час. Когда ссылка истечет, новую можно запросить, вызвав getFile снова.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| file_id | String | Да | Идентификатор файла для получения информации о нем |
Примечание: Эта функция может не сохранять оригинальное имя файла и MIME-тип. Вы должны сохранить MIME-тип и имя файла (если доступно) при получении объекта File.
banChatMember
Используйте этот метод, чтобы забанить пользователя в группе, супергруппе или канале. В случае супергрупп и каналов пользователь не сможет вернуться в чат самостоятельно, используя пригласительные ссылки и т. д., если его сначала не разбанить. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевой группы или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
| until_date | Целое число | Необязательный | Дата, когда пользователь будет разбанен; Unix время. Если пользователь забанен на более чем 366 дней или менее чем на 30 секунд от текущего времени, он считается забаненным навсегда. Применяется только для супергрупп и каналов. |
| revoke_messages | Булевый | Необязательный | Передайте True, чтобы удалить все сообщения из чата для пользователя, который удаляется. Если False, пользователь сможет видеть сообщения в группе, которые были отправлены до его удаления. Всегда True для супергрупп и каналов. |
unbanChatMember
Используйте этот метод, чтобы разблокировать ранее заблокированного пользователя в супергруппе или канале. Пользователь не вернется в группу или канал автоматически, но сможет присоединиться по ссылке и т.д. Бот должен быть администратором, чтобы это работало. По умолчанию этот метод гарантирует, что после вызова пользователь не является членом чата, но сможет присоединиться к нему. Поэтому, если пользователь является членом чата, он также будет удален из чата. Если вы не хотите этого, используйте параметр only_if_banned. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевой группы или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
| only_if_banned | Булевый | Необязательный | Не делать ничего, если пользователь не заблокирован |
restrictChatMember
Используйте этот метод, чтобы ограничить пользователя в супергруппе. Бот должен быть администратором в супергруппе, чтобы это работало, и должен иметь соответствующие права администратора. Передайте True для всех разрешений, чтобы снять ограничения с пользователя. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
| permissions | ChatPermissions | Да | JSON-сериализованный объект для новых разрешений пользователя |
| use_independent_chat_permissions | Булевый | Необязательный | Передайте 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 | Целое число | Необязательный | Дата, когда ограничения будут сняты с пользователя; Unix время. Если пользователь ограничен более чем на 366 дней или менее чем на 30 секунд от текущего времени, он считается ограниченным навсегда |
promoteChatMember
Используйте этот метод, чтобы повысить или понизить пользователя в супергруппе или канале. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Передайте False для всех булевых параметров, чтобы понизить пользователя. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
| is_anonymous | Булево | Необязательно | Передайте True, если присутствие администратора в чате скрыто |
| can_manage_chat | Булево | Необязательно | Передайте True, если администратор может получить доступ к журналу событий чата, получить список бустов, видеть скрытых участников супергруппы и канала, сообщать о спам-сообщениях и игнорировать медленный режим. Подразумевается любым другим правом администратора. |
| can_delete_messages | Булево | Необязательно | Передайте True, если администратор может удалять сообщения других пользователей |
| can_manage_video_chats | Булево | Необязательно | Передайте True, если администратор может управлять видеочатами |
| can_restrict_members | Булево | Необязательно | Передайте True, если администратор может ограничивать, запрещать или восстанавливать участников чата, или получать доступ к статистике супергруппы |
| can_promote_members | Булево | Необязательно | Передайте True, если администратор может добавлять новых администраторов с подмножеством своих собственных привилегий или понижать администраторов, которых он повысил, прямо или косвенно (повышенных администраторами, назначенными им) |
| can_change_info | Булево | Необязательно | Передайте True, если администратор может изменять название чата, фото и другие настройки |
| can_invite_users | Булево | Необязательно | Передайте True, если администратор может приглашать новых пользователей в чат |
| can_post_stories | Булево | Необязательно | Передайте True, если администратор может публиковать истории в чате |
| can_edit_stories | Булево | Необязательно | Передайте True, если администратор может редактировать истории, опубликованные другими пользователями, публиковать истории на странице чата, закреплять истории чата и получать доступ к архиву историй чата |
| can_delete_stories | Булево | Необязательно | Передайте True, если администратор может удалять истории, опубликованные другими пользователями |
| can_post_messages | Булево | Необязательно | Передайте True, если администратор может публиковать сообщения в канале или получать доступ к статистике канала; только для каналов |
| can_edit_messages | Булево | Необязательно | Передайте True, если администратор может редактировать сообщения других пользователей и может закреплять сообщения; только для каналов |
| can_pin_messages | Булево | Необязательно | Передайте True, если администратор может закреплять сообщения; только для супергрупп |
| can_manage_topics | Булево | Необязательно | Передайте True, если пользователю разрешено создавать, переименовывать, закрывать и открывать темы форума; только для супергрупп |
setChatAdministratorCustomTitle
Используйте этот метод, чтобы установить пользовательский титул для администратора в супергруппе, продвигаемой ботом. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
| custom_title | Строка | Да | Новый пользовательский титул для администратора; 0-16 символов, эмодзи не допускаются |
banChatSenderChat
Используйте этот метод, чтобы забанить чат канала в супергруппе или канале. Пока чат не будет разбанен, владелец забаненного чата не сможет отправлять сообщения от имени любого из своих каналов. Бот должен быть администратором в супергруппе или канале, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| sender_chat_id | Целое число | Да | Уникальный идентификатор целевого чата отправителя |
unbanChatSenderChat
Используйте этот метод, чтобы разблокировать ранее забаненный чат канала в супергруппе или канале. Бот должен быть администратором, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| sender_chat_id | Целое число | Да | Уникальный идентификатор целевого чата отправителя |
setChatPermissions
Используйте этот метод для установки стандартных разрешений чата для всех участников. Бот должен быть администратором в группе или супергруппе, чтобы это работало, и должен иметь права администратора can_restrict_members. Возвращает True в случае успеха.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| permissions | ChatPermissions | Да | Объект в формате JSON для новых стандартных разрешений чата |
| use_independent_chat_permissions | Булевый | Необязательно | Передайте 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 | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
Примечание: Каждый администратор в чате генерирует свои собственные ссылки приглашения. Боты не могут использовать ссылки приглашения, сгенерированные другими администраторами. Если вы хотите, чтобы ваш бот работал с ссылками приглашения, ему нужно будет сгенерировать свою собственную ссылку, используя exportChatInviteLink или вызвав метод getChat. Если вашему боту нужно сгенерировать новую основную ссылку приглашения, заменяющую предыдущую, используйте exportChatInviteLink снова.
createChatInviteLink
Используйте этот метод для создания дополнительной ссылки для приглашения в чат. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Ссылка может быть отменена с помощью метода revokeChatInviteLink. Возвращает новую ссылку для приглашения в виде объекта ChatInviteLink.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор для целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| name | Строка | Необязательный | Название ссылки для приглашения; 0-32 символа |
| expire_date | Целое число | Необязательный | Момент времени (Unix timestamp), когда ссылка истечет |
| member_limit | Целое число | Необязательный | Максимальное количество пользователей, которые могут быть членами чата одновременно после присоединения к чату по этой ссылке для приглашения; 1-99999 |
| creates_join_request | Логический | Необязательный | True, если пользователи, присоединяющиеся к чату по ссылке, должны быть одобрены администраторами чата. Если True, member_limit не может быть указан |
editChatInviteLink
Используйте этот метод для редактирования неосновной ссылки приглашения, созданной ботом. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает отредактированную ссылку приглашения в виде объекта ChatInviteLink.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| invite_link | Строка | Да | Ссылка приглашения для редактирования |
| name | Строка | Необязательный | Название ссылки приглашения; 0-32 символа |
| expire_date | Целое число | Необязательный | Момент времени (Unix timestamp), когда ссылка истечет |
| member_limit | Целое число | Необязательный | Максимальное количество пользователей, которые могут быть участниками чата одновременно после присоединения к чату через эту ссылку приглашения; 1-99999 |
| creates_join_request | Логическое | Необязательный | True, если пользователи, присоединяющиеся к чату через ссылку, должны быть одобрены администраторами чата. Если True, member_limit не может быть указан |
createChatSubscriptionInviteLink
Используйте этот метод для создания ссылки-приглашения на подписку для чата канала. Бот должен иметь права администратора can_invite_users. Ссылку можно отредактировать с помощью метода editChatSubscriptionInviteLink или отозвать с помощью метода revokeChatInviteLink. Возвращает новую ссылку-приглашение в виде объекта ChatInviteLink.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата канала или имя пользователя целевого канала (в формате @channelusername) |
| name | Строка | Необязательный | Название ссылки-приглашения; 0-32 символа |
| subscription_period | Целое число | Да | Количество секунд, в течение которого подписка будет активна до следующего платежа. В настоящее время она всегда должна составлять 2592000 (30 дней). |
| subscription_price | Целое число | Да | Количество Telegram Stars, которое пользователь должен заплатить изначально и после каждого последующего периода подписки, чтобы быть членом чата; 1-2500 |
editChatSubscriptionInviteLink
Используйте этот метод для редактирования ссылки на приглашение для подписки, созданной ботом. У бота должны быть права администратора can_invite_users. Возвращает отредактированную ссылку на приглашение в виде объекта ChatInviteLink.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| invite_link | Строка | Да | Ссылка на приглашение для редактирования |
| name | Строка | Необязательный | Имя ссылки на приглашение; 0-32 символа |
revokeChatInviteLink
Используйте этот метод, чтобы отозвать ссылку-приглашение, созданную ботом. Если основная ссылка отозвана, новая ссылка автоматически генерируется. Бот должен быть администратором в чате, чтобы это сработало, и должен иметь соответствующие права администратора. Возвращает отозванную ссылку-приглашение в виде объекта ChatInviteLink.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| invite_link | Строка | Да | Ссылка-приглашение для отзыва |
approveChatJoinRequest
Используйте этот метод для одобрения запроса на присоединение к чату. Бот должен быть администратором в чате, чтобы это работало, и должен иметь право администратора can_invite_users. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
declineChatJoinRequest
Используйте этот метод, чтобы отклонить запрос на присоединение к чату. Бот должен быть администратором в чате, чтобы это работало, и должен иметь право администратора can_invite_users. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| user_id | Integer | Да | Уникальный идентификатор целевого пользователя |
setChatPhoto
Используйте этот метод, чтобы установить новое фото профиля для чата. Фото не могут быть изменены для частных чатов. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| photo | InputFile | Да | Новое фото чата, загруженное с использованием multipart/form-data |
deleteChatPhoto
Используйте этот метод для удаления фотографии чата. Фотографии не могут быть изменены для частных чатов. Бот должен быть администратором в чате для того, чтобы это работало и должен иметь соответствующие права администратора. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
setChatTitle
Используйте этот метод, чтобы изменить название чата. Названия не могут быть изменены для приватных чатов. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| title | String | Да | Новое название чата, 1-128 символов |
setChatDescription
Используйте этот метод для изменения описания группы, супергруппы или канала. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| description | Строка | Необязательно | Новое описание чата, 0-255 символов |
pinChatMessage
Используйте этот метод, чтобы добавить сообщение в список закрепленных сообщений в чате. Если чат не является приватным, бот должен быть администратором в чате, чтобы это работало, и должен иметь право администратора 'can_pin_messages' в супергруппе или 'can_edit_messages' в канале. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательно | Уникальный идентификатор бизнес-соединения, от имени которого будет закреплено сообщение |
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Да | Идентификатор сообщения для закрепления |
| disable_notification | Boolean | Необязательно | Передайте True, если не нужно отправлять уведомление всем участникам чата о новом закрепленном сообщении. Уведомления всегда отключены в каналах и приватных чатах. |
unpinChatMessage
Используйте этот метод, чтобы удалить сообщение из списка закрепленных сообщений в чате. Если чат не является приватным, бот должен быть администратором в чате, чтобы это сработало, и должен иметь право администратора 'can_pin_messages' в супергруппе или 'can_edit_messages' в канале. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого сообщение будет откреплено |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Идентификатор сообщения для открепления. Обязателен, если указан business_connection_id. Если не указан, будет откреплено самое последнее закрепленное сообщение (по дате отправки). |
unpinAllChatMessages
Используйте этот метод, чтобы очистить список закрепленных сообщений в чате. Если чат не является приватным, бот должен быть администратором в чате, чтобы это работало, и должен иметь право администратора 'can_pin_messages' в супергруппе или 'can_edit_messages' в канале. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
leaveChat
Используйте этот метод, чтобы ваш бот покинул группу, супергруппу или канал. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
getChat
Используйте этот метод, чтобы получить актуальную информацию о чате. Возвращает объект ChatFullInfo в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
getChatAdministrators
Используйте этот метод, чтобы получить список администраторов в чате, которые не являются ботами. Возвращает массив объектов ChatMember.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
getChatMemberCount
Используйте этот метод, чтобы получить количество участников в чате. Возвращает Int в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
getChatMember
Используйте этот метод, чтобы получить информацию о члене чата. Метод гарантированно работает для других пользователей, только если бот является администратором в чате. Возвращает объект ChatMember в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы или канала (в формате @channelusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
setChatStickerSet
Используйте этот метод, чтобы установить новый набор стикеров для супергруппы. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие права администратора. Используйте поле can_set_sticker_set, которое может быть возвращено в запросах getChat, чтобы проверить, может ли бот использовать этот метод. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| sticker_set_name | Строка | Да | Имя набора стикеров, который будет установлен в качестве набора стикеров группы |
deleteChatStickerSet
Используйте этот метод для удаления набора стикеров группы из супергруппы. Бот должен быть администратором в чате, чтобы это работало, и должен иметь соответствующие административные права. Используйте поле can_set_sticker_set, которое опционально возвращается в запросах getChat, чтобы проверить, может ли бот использовать этот метод. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
getForumTopicIconStickers
Используйте этот метод, чтобы получить пользовательские эмодзи-наклейки, которые могут быть использованы в качестве иконки темы форума любым пользователем. Не требует параметров. Возвращает массив объектов Sticker.
createForumTopic
Используйте этот метод для создания темы в форуме супергруппы чата. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_manage_topics. Возвращает информацию о созданной теме в виде объекта ForumTopic.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| name | Строка | Да | Название темы, 1-128 символов |
| icon_color | Целое число | Необязательно | Цвет значка темы в формате RGB. В настоящее время должен быть одним из 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2) или 16478047 (0xFB6F5F) |
| icon_custom_emoji_id | Строка | Необязательно | Уникальный идентификатор пользовательского эмодзи, отображаемого в качестве значка темы. Используйте getForumTopicIconStickers, чтобы получить все допустимые идентификаторы пользовательских эмодзи. |
editForumTopic
Используйте этот метод для редактирования имени и иконки темы в чате супергруппы форума. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_manage_topics, если он не является создателем темы. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| message_thread_id | Целое число | Да | Уникальный идентификатор целевой ветки сообщений темы форума |
| name | Строка | Необязательно | Новое имя темы, 0-128 символов. Если не указано или пусто, текущее имя темы будет сохранено |
| icon_custom_emoji_id | Строка | Необязательно | Новый уникальный идентификатор пользовательского эмодзи, отображаемого в качестве иконки темы. Используйте getForumTopicIconStickers, чтобы получить все разрешенные идентификаторы пользовательских эмодзи. Передайте пустую строку, чтобы удалить иконку. Если не указано, текущая иконка будет сохранена |
closeForumTopic
Используйте этот метод для закрытия открытой темы в чате супергруппы форума. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_manage_topics, если он не является создателем темы. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| message_thread_id | Целое число | Да | Уникальный идентификатор целевой ветки сообщений темы форума |
reopenForumTopic
Используйте этот метод, чтобы открыть закрытую тему в чате форума супергруппы. Бот должен быть администратором в чате, чтобы это сработало, и должен иметь права администратора can_manage_topics, если он не является создателем темы. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| message_thread_id | Целое число | Да | Уникальный идентификатор целевой ветки сообщений темы форума |
deleteForumTopic
Используйте этот метод, чтобы удалить тему форума вместе со всеми её сообщениями в чате супергруппы. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_delete_messages. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| message_thread_id | Целое число | Да | Уникальный идентификатор целевой темы сообщений форума |
unpinAllForumTopicMessages
Используйте этот метод для очистки списка закрепленных сообщений в теме форума. Бот должен быть администратором в чате, чтобы это сработало, и должен иметь право администратора can_pin_messages в супергруппе. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| message_thread_id | Целое число | Да | Уникальный идентификатор целевой ветки сообщений темы форума |
editGeneralForumTopic
Используйте этот метод для редактирования названия темы 'Общее' в чате супергруппы форума. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_manage_topics. Возвращает True в случае успеха.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
| name | Строка | Да | Новое название темы, 1-128 символов |
closeGeneralForumTopic
Используйте этот метод, чтобы закрыть открытую 'Общую' тему в чате форум-супергруппы. Бот должен быть администратором в чате, чтобы это сработало, и должен иметь права администратора can_manage_topics. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
reopenGeneralForumTopic
Используйте этот метод для повторного открытия закрытой темы 'Общий' в чате супергруппы форума. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_manage_topics. Тема будет автоматически показана, если она была скрыта. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
hideGeneralForumTopic
Используйте этот метод, чтобы скрыть тему 'Общее' в чате форума супергруппы. Бот должен быть администратором в чате, чтобы это работало, и должен иметь права администратора can_manage_topics. Тема будет автоматически закрыта, если она была открыта. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
unhideGeneralForumTopic
Используйте этот метод, чтобы сделать видимым 'Общий' топик в форуме супергруппы. Бот должен быть администратором в чате, чтобы это сработало, и должен иметь права администратора can_manage_topics. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
unpinAllGeneralForumTopicMessages
Используйте этот метод для очистки списка закрепленных сообщений в общем форуме. Бот должен быть администратором в чате, чтобы это работало, и должен иметь право администратора can_pin_messages в супергруппе. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевой супергруппы (в формате @supergroupusername) |
answerCallbackQuery
Используйте этот метод для отправки ответов на запросы обратного вызова, отправленные из встраиваемых клавиатур. Ответ будет отображаться пользователю в виде уведомления в верхней части экрана чата или как предупреждение. В случае успеха возвращается True.
В качестве альтернативы пользователь может быть перенаправлен на указанный URL игры. Для того чтобы эта опция работала, вы должны сначала создать игру для вашего бота через @BotFather и принять условия. В противном случае вы можете использовать ссылки, такие как
t.me/your_bot?start=XXXX, которые открывают вашего бота с параметром.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| callback_query_id | String | Да | Уникальный идентификатор для запроса, на который нужно ответить |
| text | String | Необязательный | Текст уведомления. Если не указано, пользователю ничего не будет показано, 0-200 символов |
| show_alert | Boolean | Необязательный | Если True, клиент покажет предупреждение вместо уведомления в верхней части экрана чата. По умолчанию false. |
| url | String | Необязательный | URL, который будет открыт клиентом пользователя. Если вы создали Игру и приняли условия через @BotFather, укажите URL, который открывает вашу игру - обратите внимание, что это будет работать только в том случае, если запрос поступает от кнопки callback_game. В противном случае вы можете использовать ссылки, такие как t.me/your_bot?start=XXXX, которые открывают вашего бота с параметром. |
| cache_time | Integer | Необязательный | Максимальное время в секундах, в течение которого результат запроса обратного вызова может кэшироваться на стороне клиента. Приложения Telegram будут поддерживать кэширование, начиная с версии 3.14. По умолчанию 0. |
getUserChatBoosts
Используйте этот метод, чтобы получить список бустов, добавленных пользователем в чат. Требуются права администратора в чате. Возвращает объект UserChatBoosts.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор чата или имя пользователя канала (в формате @channelusername) |
| user_id | Целое число | Да | Уникальный идентификатор целевого пользователя |
getBusinessConnection
Используйте этот метод для получения информации о подключении бота к бизнес-аккаунту. Возвращает объект BusinessConnection в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Да | Уникальный идентификатор бизнес-соединения |
setMyCommands
Используйте этот метод, чтобы изменить список команд бота. См. это руководство для получения дополнительной информации о командах бота. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| commands | Массив BotCommand | Да | JSON-сериализованный список команд бота, который будет установлен в качестве списка команд бота. Можно указать не более 100 команд. |
| scope | BotCommandScope | Необязательный | JSON-сериализованный объект, описывающий область пользователей, для которых команды актуальны. По умолчанию используется BotCommandScopeDefault. |
| language_code | Строка | Необязательный | Двухбуквенный код языка ISO 639-1. Если пусто, команды будут применены ко всем пользователям из данной области, для которых нет специализированных команд. |
deleteMyCommands
Используйте этот метод для удаления списка команд бота для заданной области и языка пользователя. После удаления команды более высокого уровня будут показаны затронутым пользователям. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| scope | BotCommandScope | Необязательный | JSON-сериализованный объект, описывающий область пользователей, для которых команды имеют значение. По умолчанию используется BotCommandScopeDefault. |
| language_code | String | Необязательный | Двухбуквенный код языка ISO 639-1. Если пусто, команды будут применяться ко всем пользователям из заданной области, для которых нет специализированных команд |
getMyCommands
Используйте этот метод, чтобы получить текущий список команд бота для заданной области и языка пользователя. Возвращает массив объектов 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 или пустая строка |
setChatMenuButton
Используйте этот метод, чтобы изменить кнопку меню бота в личном чате или кнопку меню по умолчанию. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Integer | Необязательный | Уникальный идентификатор целевого личного чата. Если не указано, будет изменена кнопка меню бота по умолчанию |
| menu_button | MenuButton | Необязательный | Объект в формате JSON для новой кнопки меню бота. По умолчанию используется MenuButtonDefault |
getChatMenuButton
Используйте этот метод, чтобы получить текущее значение кнопки меню бота в приватном чате или кнопку меню по умолчанию. Возвращает MenuButton при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число | Необязательно | Уникальный идентификатор целевого приватного чата. Если не указано, будет возвращена кнопка меню бота по умолчанию |
setMyDefaultAdministratorRights
Используйте этот метод, чтобы изменить стандартные права администратора, запрашиваемые ботом, когда его добавляют в качестве администратора в группы или каналы. Эти права будут предложены пользователям, но они могут изменить список перед добавлением бота. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| rights | ChatAdministratorRights | Необязательный | JSON-сериализованный объект, описывающий новые стандартные права администратора. Если не указано, стандартные права администратора будут очищены. |
| for_channels | Boolean | Необязательный | Передайте True, чтобы изменить стандартные права администратора бота в каналах. В противном случае будут изменены стандартные права администратора бота для групп и супергрупп. |
getMyDefaultAdministratorRights
Используйте этот метод, чтобы получить текущие права администратора по умолчанию для бота. Возвращает ChatAdministratorRights в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| for_channels | Boolean | Необязательный | Передайте True, чтобы получить права администратора по умолчанию для бота в каналах. В противном случае будут возвращены права администратора по умолчанию для бота в группах и супергруппах. |
Методы инлайн-режима
Методы и объекты, используемые в инлайн-режиме, описаны в разделе инлайн-режима.
Обновление сообщений
Следующие методы позволяют изменить существующее сообщение в истории сообщений вместо отправки нового с результатом действия. Это особенно полезно для сообщений с инлайн-клавиатурами, использующими callback-запросы, но также может помочь сократить загромождение в беседах с обычными чат-ботами.
Обратите внимание, что в настоящее время возможно редактировать только сообщения без reply_markup или с инлайн-клавиатурами.
editMessageText
Используйте этот метод для редактирования текстовых и игровых сообщений. В случае успешного выполнения, если редактируемое сообщение не является инлайн-сообщением, будет возвращено редактированное Сообщение, в противном случае возвращается True. Обратите внимание, что бизнес-сообщения, которые не были отправлены ботом и не содержат инлайн-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено сообщение для редактирования |
| chat_id | Integer или String | Необязательный | Обязателен, если не указано inline_message_id. Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Обязателен, если не указано inline_message_id. Идентификатор сообщения для редактирования |
| inline_message_id | String | Необязательный | Обязателен, если не указаны chat_id и message_id. Идентификатор инлайн-сообщения |
| text | String | Да | Новый текст сообщения, 1-4096 символов после разбора сущностей |
| parse_mode | String | Необязательный | Режим для разбора сущностей в тексте сообщения. См. варианты форматирования для получения дополнительной информации. |
| entities | Array of MessageEntity | Необязательный | JSON-сериализованный список специальных сущностей, которые появляются в тексте сообщения, которые могут быть указаны вместо parse_mode |
| link_preview_options | LinkPreviewOptions | Необязательный | Опции генерации предпросмотра ссылки для сообщения |
| reply_markup | InlineKeyboardMarkup | Необязательный | JSON-сериализованный объект для инлайн-клавиатуры. |
editMessageCaption
Используйте этот метод для редактирования подписей к сообщениям. В случае успешного выполнения, если редактируемое сообщение не является инлайн-сообщением, возвращается редактируемое Сообщение, в противном случае возвращается True. Обратите внимание, что бизнес-сообщения, которые не были отправлены ботом и не содержат инлайн-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено сообщение для редактирования |
| chat_id | Integer или String | Необязательный | Обязателен, если не указан inline_message_id. Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Обязателен, если не указан inline_message_id. Идентификатор сообщения для редактирования |
| inline_message_id | String | Необязательный | Обязателен, если не указаны chat_id и message_id. Идентификатор инлайн-сообщения |
| 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-сериализованный объект для инлайн-клавиатуры. |
editMessageMedia
Используйте этот метод для редактирования анимационных, аудио, документальных, фото или видеосообщений, или для добавления медиа к текстовым сообщениям. Если сообщение является частью альбома сообщений, то его можно редактировать только на аудио для аудиоальбомов, только на документ для документальных альбомов и на фото или видео в противном случае. Когда редактируется встроенное сообщение, новый файл не может быть загружен; используйте ранее загруженный файл через его file_id или укажите URL. В случае успеха, если редактируемое сообщение не является встроенным, возвращается редактированное Сообщение, в противном случае возвращается True. Обратите внимание, что бизнес-сообщения, которые не были отправлены ботом и не содержат встроенной клавиатуры, можно редактировать только в течение 48 часов с момента их отправки.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено редактируемое сообщение |
| chat_id | Integer или String | Необязательный | Обязателен, если не указан inline_message_id. Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Обязателен, если не указан inline_message_id. Идентификатор сообщения для редактирования |
| inline_message_id | String | Необязательный | Обязателен, если не указаны chat_id и message_id. Идентификатор встроенного сообщения |
| media | InputMedia | Да | JSON-сериализованный объект для нового медиа-контента сообщения |
| reply_markup | InlineKeyboardMarkup | Необязательный | JSON-сериализованный объект для новой встроенной клавиатуры. |
editMessageLiveLocation
Используйте этот метод для редактирования сообщений с живой геолокацией. Геолокация может быть отредактирована до истечения live_period или до тех пор, пока редактирование не будет явно отключено вызовом stopMessageLiveLocation. В случае успеха, если редактируемое сообщение не является встроенным, возвращается отредактированное Сообщение, в противном случае возвращается True.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено сообщение для редактирования |
| chat_id | Integer или String | Необязательный | Обязательный, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Обязательный, если inline_message_id не указан. Идентификатор сообщения для редактирования |
| inline_message_id | String | Необязательный | Обязательный, если chat_id и message_id не указаны. Идентификатор встроенного сообщения |
| 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-сериализованный объект для новой встроенной клавиатуры. |
stopMessageLiveLocation
Используйте этот метод, чтобы остановить обновление сообщения с живой локацией до истечения live_period. В случае успеха, если сообщение не является инлайн-сообщением, возвращается отредактированное Сообщение, в противном случае возвращается True.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено сообщение для редактирования |
| chat_id | Integer или String | Необязательный | Обязателен, если inline_message_id не указан. Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Обязателен, если inline_message_id не указан. Идентификатор сообщения с живой локацией, которое нужно остановить |
| inline_message_id | String | Необязательный | Обязателен, если chat_id и message_id не указаны. Идентификатор инлайн-сообщения |
| reply_markup | InlineKeyboardMarkup | Необязательный | JSON-сериализованный объект для новой инлайн-клавиатуры. |
editMessageReplyMarkup
Используйте этот метод для редактирования только разметки ответа сообщений. В случае успеха, если редактируемое сообщение не является инлайн-сообщением, возвращается отредактированное Сообщение, в противном случае возвращается True. Обратите внимание, что бизнес-сообщения, которые не были отправлены ботом и не содержат инлайн-клавиатуру, могут быть отредактированы только в течение 48 часов с момента их отправки.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено редактируемое сообщение |
| chat_id | Integer или String | Необязательный | Обязателен, если не указано inline_message_id. Уникальный идентификатор для целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Необязательный | Обязателен, если не указано inline_message_id. Идентификатор сообщения для редактирования |
| inline_message_id | String | Необязательный | Обязателен, если не указаны chat_id и message_id. Идентификатор инлайн-сообщения |
| reply_markup | InlineKeyboardMarkup | Необязательный | JSON-сериализованный объект для инлайн-клавиатуры. |
stopPoll
Используйте этот метод, чтобы остановить опрос, который был отправлен ботом. При успешном выполнении возвращается остановленный Poll.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательно | Уникальный идентификатор бизнес-соединения, от имени которого было отправлено сообщение для редактирования |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Integer | Да | Идентификатор оригинального сообщения с опросом |
| reply_markup | InlineKeyboardMarkup | Необязательно | JSON-сериализованный объект для новой inline клавиатуры. |
deleteMessage
Используйте этот метод для удаления сообщения, включая служебные сообщения, с следующими ограничениями:
- Сообщение можно удалить только в том случае, если оно было отправлено менее 48 часов назад.
- Служебные сообщения о создании супергруппы, канала или темы форума нельзя удалить.
- Сообщение с кубиками в личном чате можно удалить только в том случае, если оно было отправлено более 24 часов назад.
- Боты могут удалять исходящие сообщения в личных чатах, группах и супергруппах.
- Боты могут удалять входящие сообщения в личных чатах.
- Боты, которым предоставлены права can_post_messages, могут удалять исходящие сообщения в каналах.
- Если бот является администратором группы, он может удалить любое сообщение там.
- Если у бота есть разрешение can_delete_messages в супергруппе или канале, он может удалить любое сообщение там.
Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_id | Целое число | Да | Идентификатор сообщения для удаления |
deleteMessages
Используйте этот метод для одновременного удаления нескольких сообщений. Если некоторые из указанных сообщений не могут быть найдены, они будут пропущены. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_ids | Массив целых чисел | Да | JSON-сериализованный список из 1-100 идентификаторов сообщений для удаления. См. deleteMessage для ограничений на удаляемые сообщения |
Стикеры
Следующие методы и объекты позволяют вашему боту работать со стикерами и наборами стикеров.
Стикер
Этот объект представляет собой стикер.
| Поле | Тип | Описание |
|---|---|---|
| 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, если стикер должен быть перекрашен в цвет текста в сообщениях, цвет значка Telegram Premium в статусе эмодзи, белый цвет на фотографиях чата или другой подходящий цвет в других местах |
| file_size | Integer | По желанию. Размер файла в байтах |
Набор стикеров
Этот объект представляет собой набор стикеров.
| Поле | Тип | Описание |
|---|---|---|
| name | String | Название набора стикеров |
| title | String | Заголовок набора стикеров |
| sticker_type | String | Тип стикеров в наборе, в настоящее время один из “regular”, “mask”, “custom_emoji” |
| stickers | 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 | InputFile или String | Добавленный стикер. Передайте file_id в виде строки, чтобы отправить файл, который уже существует на серверах Telegram, передайте HTTP URL в виде строки, чтобы Telegram получил файл из Интернета, загрузите новый файл, используя multipart/form-data, или передайте “attach://<file_attach_name>”, чтобы загрузить новый файл с именем <file_attach_name> с использованием multipart/form-data. Анимированные и видео стикеры нельзя загружать через HTTP URL. Дополнительная информация о отправке файлов » |
| format | String | Формат добавленного стикера, должен быть одним из “static” для .WEBP или .PNG изображения, “animated” для .TGS анимации, “video” для .WEBM видео |
| emoji_list | Массив строк | Список из 1-20 эмодзи, связанных со стикером |
| mask_position | MaskPosition | Необязательно. Позиция, где маска должна быть размещена на лицах. Только для стикеров “mask”. |
| keywords | Массив строк | Необязательно. Список из 0-20 ключевых слов для поиска стикера с общей длиной до 64 символов. Только для “regular” и “custom_emoji” стикеров. |
sendSticker
Используйте этот метод для отправки статических .WEBP, анимированных .TGS или видео .WEBM стикеров. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательно | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer или String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| message_thread_id | Integer | Необязательно | Уникальный идентификатор целевой темы сообщения (топика) форума; только для супергрупп форума |
| sticker | InputFile или String | Да | Стикер для отправки. Передайте file_id как String, чтобы отправить файл, который существует на серверах Telegram (рекомендуется), передайте HTTP URL как String, чтобы Telegram получил .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 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательно | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для частных чатов |
| reply_parameters | ReplyParameters | Необязательно | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup или ReplyKeyboardMarkup или ReplyKeyboardRemove или ForceReply | Необязательно | Дополнительные параметры интерфейса. JSON-сериализованный объект для инлайн-клавиатуры, пользовательской клавиатуры для ответов, инструкции по удалению клавиатуры для ответов или для принудительного ответа от пользователя |
getStickerSet
Используйте этот метод для получения набора стикеров. В случае успеха возвращается объект StickerSet.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| name | String | Да | Название набора стикеров |
getCustomEmojiStickers
Используйте этот метод для получения информации о пользовательских стикерах с эмодзи по их идентификаторам. Возвращает массив объектов Sticker.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| custom_emoji_ids | Array of String | Да | JSON-сериализованный список идентификаторов пользовательских эмодзи. Максимум можно указать 200 идентификаторов пользовательских эмодзи. |
uploadStickerFile
Используйте этот метод для загрузки файла со стикером для последующего использования в методах createNewStickerSet, addStickerToSet или replaceStickerInSet (файл может использоваться несколько раз). Возвращает загруженный File при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Идентификатор пользователя владельца файла со стикером |
| sticker | InputFile | Да | Файл со стикером в формате .WEBP, .PNG, .TGS или .WEBM. См. https://core.telegram.org/stickers для технических требований. Дополнительная информация о отправке файлов » |
| sticker_format | String | Да | Формат стикера, должен быть одним из “static”, “animated”, “video” |
createNewStickerSet
Используйте этот метод для создания нового набора стикеров, принадлежащего пользователю. Бот сможет редактировать созданный набор стикеров. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Идентификатор пользователя, владельца созданного набора стикеров |
| name | String | Да | Краткое имя набора стикеров, которое будет использоваться в t.me/addstickers/ URL (например, animals). Может содержать только английские буквы, цифры и символы подчеркивания. Должно начинаться с буквы, не может содержать подряд идущие символы подчеркивания и должно заканчиваться на "_by_<bot_username>". <bot_username> нечувствительно к регистру. 1-64 символа. |
| title | String | Да | Название набора стикеров, 1-64 символа |
| stickers | 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 | Необязательный | Изображение в формате .WEBP или .PNG с миниатюрой, должно быть размером до 128 килобайт и иметь ширину и высоту ровно 100px, или анимация .TGS с миниатюрой размером до 32 килобайт (см. https://core.telegram.org/stickers#animation-requirements для технических требований к анимированным стикерам), или видео .WEBM с миниатюрой размером до 32 килобайт; см. https://core.telegram.org/stickers#video-requirements для технических требований к видео стикерам. Передайте file_id как строку, чтобы отправить файл, который уже существует на серверах Telegram, передайте HTTP URL как строку, чтобы Telegram получил файл из Интернета, или загрузите новый файл, используя multipart/form-data. Дополнительная информация об отправке файлов ». Миниатюры анимированных и видео наборов стикеров не могут быть загружены через HTTP URL. Если не указано, миниатюра будет отброшена, и в качестве миниатюры будет использован первый стикер. |
| format | String | Да | Формат миниатюры, должен быть одним из “static” для изображения .WEBP или .PNG, “animated” для анимации .TGS, или “video” для видео .WEBM |
setCustomEmojiStickerSetThumbnail
Используйте этот метод для установки миниатюры набора стикеров с пользовательскими эмодзи. Возвращает True при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| name | String | Да | Название набора стикеров |
| custom_emoji_id | String | Необязательно | Идентификатор пользовательского эмодзи из набора стикеров; передайте пустую строку, чтобы удалить миниатюру и использовать первый стикер в качестве миниатюры. |
deleteStickerSet
Используйте этот метод для удаления набора стикеров, созданного ботом. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| name | String | Да | Название набора стикеров |
Подарок
Этот объект представляет собой подарок, который может быть отправлен ботом.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор подарка |
| sticker | Стикер | Стикер, представляющий подарок |
| star_count | Integer | Количество Telegram Stars, которое необходимо заплатить для отправки стикера |
| upgrade_star_count | Integer | Необязательно. Количество Telegram Stars, которое необходимо заплатить для улучшения подарка до уникального |
| total_count | Integer | Необязательно. Общее количество подарков этого типа, которые могут быть отправлены; только для ограниченных подарков |
| remaining_count | Integer | Необязательно. Количество оставшихся подарков этого типа, которые могут быть отправлены; только для ограниченных подарков |
Подарки
Этот объект представляет собой список подарков.
| Поле | Тип | Описание |
|---|---|---|
| gifts | Массив Gift | Список подарков |
getAvailableGifts
Возвращает список подарков, которые бот может отправить пользователям и чатам каналов. Не требует параметров. Возвращает объект Gifts.
sendGift
Отправляет подарок указанному пользователю или в канал. Подарок не может быть конвертирован в Telegram Stars получателем. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Необязательный | Обязателен, если не указан chat_id. Уникальный идентификатор целевого пользователя, который получит подарок. |
| chat_id | Integer или String | Необязательный | Обязателен, если не указан user_id. Уникальный идентификатор чата или имя пользователя канала (в формате @channelusername), который получит подарок. |
| gift_id | String | Да | Идентификатор подарка |
| pay_for_upgrade | Boolean | Необязательный | Передайте True, чтобы оплатить улучшение подарка с баланса бота, тем самым сделав улучшение бесплатным для получателя |
| text | String | Необязательный | Текст, который будет показан вместе с подарком; 0-128 символов |
| text_parse_mode | String | Необязательный | Режим для разбора сущностей в тексте. См. варианты форматирования для получения дополнительной информации. Сущности, отличные от “bold”, “italic”, “underline”, “strikethrough”, “spoiler” и “custom_emoji”, игнорируются. |
| text_entities | Array of MessageEntity | Необязательный | JSON-сериализованный список специальных сущностей, которые появляются в тексте подарка. Может быть указан вместо text_parse_mode. Сущности, отличные от “bold”, “italic”, “underline”, “strikethrough”, “spoiler” и “custom_emoji”, игнорируются. |
verifyUser
Подтверждает пользователя от имени организации, которую представляет бот. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Уникальный идентификатор целевого пользователя |
| custom_description | String | Необязательный | Пользовательское описание для подтверждения; 0-70 символов. Должно быть пустым, если организации не разрешено предоставлять пользовательское описание подтверждения. |
verifyChat
Подтверждает чат от имени организации, которую представляет бот. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Integer or String | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
| custom_description | String | Необязательный | Пользовательское описание для подтверждения; 0-70 символов. Должно быть пустым, если организации не разрешено предоставлять пользовательское описание для подтверждения. |
removeUserVerification
Удаляет верификацию у пользователя, который в данный момент верифицирован от имени организации, представленной ботом. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Уникальный идентификатор целевого пользователя |
removeChatVerification
Удаляет верификацию из чата, который в настоящее время подтвержден от имени организации, представленной ботом. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername) |
Инлайн-режим
Следующие методы и объекты позволяют вашему боту работать в инлайн-режиме.
Пожалуйста, ознакомьтесь с нашим Введением в инлайн-ботов для получения дополнительной информации.
Чтобы включить эту опцию, отправьте команду /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-сериализованный массив результатов для инлайн-запроса |
| cache_time | Integer | Необязательный | Максимальное время в секундах, в течение которого результат инлайн-запроса может кэшироваться на сервере. По умолчанию 300. |
| is_personal | Boolean | Необязательный | Передайте True, если результаты могут кэшироваться на стороне сервера только для пользователя, который отправил запрос. По умолчанию результаты могут быть возвращены любому пользователю, который отправляет тот же запрос. |
| next_offset | String | Необязательный | Передайте смещение, которое клиент должен отправить в следующем запросе с тем же текстом, чтобы получить больше результатов. Передайте пустую строку, если больше нет результатов или если вы не поддерживаете пагинацию. Длина смещения не может превышать 64 байта. |
| button | InlineQueryResultsButton | Необязательный | JSON-сериализованный объект, описывающий кнопку, которая будет показана над результатами инлайн-запроса |
InlineQueryResultsButton
Этот объект представляет кнопку, которая будет отображаться над результатами инлайн-запроса. Вы должны использовать ровно одно из дополнительных полей.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст метки на кнопке |
| web_app | WebAppInfo | Опционально. Описание Web App, который будет запущен, когда пользователь нажимает кнопку. Web App сможет вернуться к инлайн-режиму, используя метод switchInlineQuery внутри Web App. |
| start_parameter | String | Опционально. Параметр глубокой ссылки для сообщения /start, отправляемого боту, когда пользователь нажимает кнопку. 1-64 символа, разрешены только A-Z, a-z, 0-9, _ и -.Пример: Инлайн-бот, который отправляет видео с YouTube, может попросить пользователя подключить бота к своему аккаунту YouTube, чтобы адаптировать результаты поиска соответствующим образом. Для этого он отображает кнопку 'Подключите свой аккаунт YouTube' над результатами или даже до их отображения. Пользователь нажимает кнопку, переключается в личный чат с ботом и, делая это, передает параметр старта, который указывает боту вернуть ссылку OAuth. После этого бот может предложить кнопку switch_inline, чтобы пользователь мог легко вернуться в чат, где он хотел использовать инлайн-возможности бота. |
InlineQueryResult
Этот объект представляет один результат инлайн-запроса. Клиенты Telegram в настоящее время поддерживают результаты следующих 20 типов:
- InlineQueryResultCachedAudio
- InlineQueryResultCachedDocument
- InlineQueryResultCachedGif
- InlineQueryResultCachedMpeg4Gif
- InlineQueryResultCachedPhoto
- InlineQueryResultCachedSticker
- InlineQueryResultCachedVideo
- InlineQueryResultCachedVoice
- InlineQueryResultArticle
- InlineQueryResultAudio
- InlineQueryResultContact
- InlineQueryResultGame
- InlineQueryResultDocument
- InlineQueryResultGif
- InlineQueryResultLocation
- InlineQueryResultMpeg4Gif
- InlineQueryResultPhoto
- InlineQueryResultVenue
- InlineQueryResultVideo
- InlineQueryResultVoice
Примечание: Все URL-адреса, переданные в результатах инлайн-запросов, будут доступны конечным пользователям и, следовательно, должны считаться публичными.
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 | Действительная ссылка на 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 | Необязательно. Для живых местоположений максимальное расстояние для предупреждений о близости к другому участнику чата, в метрах. Должен быть между 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
Представляет Игру.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть game |
| id | String | Уникальный идентификатор для этого результата, 1-64 байта |
| game_short_name | String | Краткое название игры |
| reply_markup | InlineKeyboardMarkup | Необязательно. Встраиваемая клавиатура, прикрепленная к сообщению |
InlineQueryResultCachedPhoto
Представляет собой ссылку на фото, хранящееся на серверах Telegram. По умолчанию это фото будет отправлено пользователем с необязательной подписью. В качестве альтернативы вы можете использовать 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-файл, хранящийся на серверах Telegram. По умолчанию этот анимированный 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 без звука), хранящуюся на серверах Telegram. По умолчанию этот анимированный 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
Представляет собой ссылку на стикер, хранящийся на серверах Telegram. По умолчанию этот стикер будет отправлен пользователем. В качестве альтернативы вы можете использовать input_message_content, чтобы отправить сообщение с указанным содержимым вместо стикера.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть sticker |
| id | String | Уникальный идентификатор для этого результата, 1-64 байта |
| sticker_file_id | String | Действительный идентификатор файла стикера |
| reply_markup | InlineKeyboardMarkup | Необязательно. Инлайн клавиатура, прикрепленная к сообщению |
| input_message_content | InputMessageContent | Необязательно. Содержимое сообщения, которое будет отправлено вместо стикера |
InlineQueryResultCachedDocument
Представляет собой ссылку на файл, хранящийся на серверах Telegram. По умолчанию этот файл будет отправлен пользователем с необязательной подписью. В качестве альтернативы вы можете использовать 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
Представляет собой ссылку на видеофайл, хранящийся на серверах Telegram. По умолчанию этот видеофайл будет отправлен пользователем с необязательной подписью. В качестве альтернативы вы можете использовать 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
Представляет собой ссылку на голосовое сообщение, хранящееся на серверах Telegram. По умолчанию это голосовое сообщение будет отправлено пользователем. В качестве альтернативы вы можете использовать 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 аудиофайл, хранящийся на серверах Telegram. По умолчанию этот аудиофайл будет отправлен пользователем. В качестве альтернативы вы можете использовать input_message_content, чтобы отправить сообщение с указанным содержимым вместо аудио.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип результата, должен быть audio |
| id | String | Уникальный идентификатор для этого результата, 1-64 байта |
| audio_file_id | String | Действительный идентификатор файла для аудиофайла |
| caption | String | Необязательно. Подпись, 0-1024 символов после разбора сущностей |
| parse_mode | String | Необязательно. Режим для разбора сущностей в подписи к аудио. Смотрите варианты форматирования для получения дополнительной информации. |
| caption_entities | Массив MessageEntity | Необязательно. Список специальных сущностей, которые появляются в подписи, которые могут быть указаны вместо parse_mode |
| reply_markup | InlineKeyboardMarkup | Необязательно. Встраиваемая клавиатура, прикрепленная к сообщению |
| input_message_content | InputMessageContent | Необязательно. Содержимое сообщения, которое будет отправлено вместо аудио |
InputMessageContent
Этот объект представляет собой содержимое сообщения, которое будет отправлено в результате инлайн-запроса. В настоящее время клиенты Telegram поддерживают следующие 5 типов:
- InputTextMessageContent
- InputLocationMessageContent
- InputVenueMessageContent
- InputContactMessageContent
- InputInvoiceMessageContent
InputTextMessageContent
Представляет собой содержимое текстового сообщения, которое будет отправлено в результате инлайн-запроса.
| Поле | Тип | Описание |
|---|---|---|
| message_text | String | Текст сообщения, которое будет отправлено, 1-4096 символов |
| parse_mode | String | Необязательно. Режим для разбора сущностей в тексте сообщения. См. варианты форматирования для получения дополнительной информации. |
| entities | Array of MessageEntity | Необязательно. Список специальных сущностей, которые появляются в тексте сообщения и могут быть указаны вместо parse_mode |
| link_preview_options | LinkPreviewOptions | Необязательно. Опции генерации предпросмотра ссылки для сообщения |
InputLocationMessageContent
Представляет собой содержимое сообщения о местоположении, которое будет отправлено в результате инлайн-запроса.
| Поле | Тип | Описание |
|---|---|---|
| latitude | Float | Широта местоположения в градусах |
| longitude | Float | Долгота местоположения в градусах |
| horizontal_accuracy | Float | Необязательно. Радиус неопределенности для местоположения, измеряемый в метрах; 0-1500 |
| live_period | Integer | Необязательно. Период в секундах, в течение которого местоположение может обновляться, должен быть между 60 и 86400, или 0x7FFFFFFF для живых местоположений, которые можно редактировать бесконечно. |
| heading | Integer | Необязательно. Для живых местоположений, направление, в котором движется пользователь, в градусах. Должен быть между 1 и 360, если указан. |
| proximity_alert_radius | Integer | Необязательно. Для живых местоположений, максимальное расстояние для сигналов о приближении другого участника чата, в метрах. Должен быть между 1 и 100000, если указан. |
InputVenueMessageContent
Представляет собой содержимое сообщения о месте, которое будет отправлено в результате инлайн-запроса.
| Поле | Тип | Описание |
|---|---|---|
| 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
Представляет собой содержимое сообщения контакта, которое будет отправлено в результате интерактивного запроса.
| Поле | Тип | Описание |
|---|---|---|
| phone_number | String | Номер телефона контакта |
| first_name | String | Имя контакта |
| last_name | String | Необязательно. Фамилия контакта |
| vcard | String | Необязательно. Дополнительные данные о контакте в формате vCard, 0-2048 байт |
InputInvoiceMessageContent
Представляет собой содержимое сообщения с выставленным счетом, которое будет отправлено в результате инлайн-запроса.
| Поле | Тип | Описание |
|---|---|---|
| title | String | Название продукта, 1-32 символа |
| description | String | Описание продукта, 1-255 символов |
| payload | String | Заданная ботом нагрузка счета, 1-128 байт. Это не будет отображаться пользователю, используйте его для ваших внутренних процессов. |
| provider_token | String | Необязательно. Токен платежного провайдера, полученный через @BotFather. Передайте пустую строку для платежей в Telegram Stars. |
| currency | String | Трехбуквенный код валюты ISO 4217, смотрите больше о валютах. Передайте “XTR” для платежей в Telegram Stars. |
| prices | Array of LabeledPrice | Разбивка цены, список компонентов в формате JSON (например, цена продукта, налог, скидка, стоимость доставки, налог на доставку, бонус и т.д.). Должен содержать ровно один элемент для платежей в Telegram Stars. |
| max_tip_amount | Integer | Необязательно. Максимально допустимая сумма чаевых в наименьших единицах валюты (целое число, не float/double). Например, для максимальных чаевых в US$ 1.45 передайте max_tip_amount = 145. Смотрите параметр exp в currencies.json, он показывает количество знаков после десятичной точки для каждой валюты (2 для большинства валют). По умолчанию 0. Не поддерживается для платежей в Telegram Stars. |
| suggested_tip_amounts | Array of Integer | Необязательно. Массив предложенных сумм чаевых в формате JSON в наименьших единицах валюты (целое число, не 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, если вам требуется полное имя пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_phone_number | Boolean | Необязательно. Передайте True, если вам требуется номер телефона пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_email | Boolean | Необязательно. Передайте True, если вам требуется адрес электронной почты пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_shipping_address | Boolean | Необязательно. Передайте True, если вам требуется адрес доставки пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| send_phone_number_to_provider | Boolean | Необязательно. Передайте True, если номер телефона пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Telegram Stars. |
| send_email_to_provider | Boolean | Необязательно. Передайте True, если адрес электронной почты пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Telegram Stars. |
| is_flexible | Boolean | Необязательно. Передайте True, если окончательная цена зависит от способа доставки. Игнорируется для платежей в Telegram Stars. |
ChosenInlineResult
Представляет собой результат инлайн-запроса, который был выбран пользователем и отправлен его собеседнику.
| Поле | Тип | Описание |
|---|---|---|
| result_id | String | Уникальный идентификатор выбранного результата |
| from | User | Пользователь, который выбрал результат |
| location | Location | Необязательно. Местоположение отправителя, только для ботов, которым требуется местоположение пользователя |
| inline_message_id | String | Необязательно. Идентификатор отправленного инлайн-сообщения. Доступен только если к сообщению прикреплена инлайн-клавиатура. Также будет получен в callback queries и может быть использован для редактирования сообщения. |
| query | String | Запрос, который был использован для получения результата |
Примечание: Необходимо включить инлайн-обратную связь через @BotFather, чтобы получать эти объекты в обновлениях.
answerWebAppQuery
Используйте этот метод, чтобы установить результат взаимодействия с Web App и отправить соответствующее сообщение от имени пользователя в чат, из которого поступил запрос. В случае успеха возвращается объект SentWebAppMessage.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| web_app_query_id | String | Да | Уникальный идентификатор для запроса, на который нужно ответить |
| result | InlineQueryResult | Да | JSON-сериализованный объект, описывающий сообщение, которое нужно отправить |
SentWebAppMessage
Описывает встроенное сообщение, отправленное веб-приложением от имени пользователя.
| Поле | Тип | Описание |
|---|---|---|
| inline_message_id | String | Необязательно. Идентификатор отправленного встроенного сообщения. Доступен только в том случае, если к сообщению прикреплена встроенная клавиатура. |
savePreparedInlineMessage
Сохраняет сообщение, которое может быть отправлено пользователем Мини-приложения. Возвращает объект 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, если сообщение может быть отправлено в чаты каналов |
PreparedInlineMessage
Описание инлайн-сообщения, которое будет отправлено пользователем Мини-приложения.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор подготовленного сообщения |
| expiration_date | Integer | Дата истечения срока действия подготовленного сообщения в формате Unix time. Просроченные подготовленные сообщения больше не могут быть использованы |
Платежи
Ваш бот может принимать платежи от пользователей Telegram. Пожалуйста, ознакомьтесь с введением в платежи для получения дополнительной информации о процессе и о том, как настроить платежи для вашего бота.
sendInvoice
Используйте этот метод для отправки счетов. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| chat_id | Целое число или строка | Да | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername)
|
| message_thread_id | Целое число | Необязательный | Уникальный идентификатор целевой темы сообщения (темы) форума; только для супергрупп форума |
| title | Строка | Да | Название продукта, 1-32 символа |
| description | Строка | Да | Описание продукта, 1-255 символов |
| payload | Строка | Да | Загруженный ботом полезный груз счета, 1-128 байт. Это не будет отображаться пользователю, используйте его для ваших внутренних процессов. |
| provider_token | Строка | Необязательный | Токен платежного провайдера, полученный через @BotFather. Передайте пустую строку для платежей в Telegram Stars. |
| currency | Строка | Да | Трехбуквенный код валюты ISO 4217, см. подробнее о валютах. Передайте “XTR” для платежей в Telegram Stars. |
| prices | Массив LabeledPrice | Да | Разбивка цен, JSON-сериализованный список компонентов (например, цена продукта, налог, скидка, стоимость доставки, налог на доставку, бонус и т.д.). Должен содержать ровно один элемент для платежей в Telegram Stars. |
| max_tip_amount | Целое число | Необязательный | Максимально допустимая сумма чаевых в наименьших единицах валюты (целое число, не
float/double). Например, для максимальной суммы чаевых US$ 1.45 передайте max_tip_amount
= 145. Смотрите параметр exp в currencies.json, он показывает количество знаков после
запятой для каждой валюты (2 для большинства валют). По умолчанию 0. Не поддерживается для платежей в Telegram Stars.
|
| suggested_tip_amounts | Массив целых чисел | Необязательный | JSON-сериализованный массив предложенных сумм чаевых в наименьших единицах валюты (целое число, не float/double). Можно указать не более 4 предложенных сумм чаевых. Предложенные суммы чаевых должны быть положительными, переданы в строго возрастающем порядке и не должны превышать max_tip_amount. |
| start_parameter | Строка | Необязательный | Уникальный параметр глубокого связывания. Если оставить пустым, пересланные копии отправленного сообщения будут иметь кнопку Оплатить, позволяя нескольким пользователям оплачивать прямо из пересланного сообщения, используя один и тот же счет. Если не пустой, пересланные копии отправленного сообщения будут иметь кнопку URL с глубокой ссылкой на бота (вместо кнопки Оплатить), с использованием значения в качестве стартового параметра |
| provider_data | Строка | Необязательный | JSON-сериализованные данные о счете, которые будут переданы платежному провайдеру. Подробное описание необходимых полей должно быть предоставлено платежным провайдером. |
| photo_url | Строка | Необязательный | URL фотографии продукта для счета. Может быть фотографией товара или рекламным изображением для услуги. Людям больше нравится, когда они видят, за что они платят. |
| photo_size | Целое число | Необязательный | Размер фотографии в байтах |
| photo_width | Целое число | Необязательный | Ширина фотографии |
| photo_height | Целое число | Необязательный | Высота фотографии |
| need_name | Булевый | Необязательный | Передайте True, если вам нужно полное имя пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_phone_number | Булевый | Необязательный | Передайте True, если вам нужен номер телефона пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_email | Булевый | Необязательный | Передайте True, если вам нужен адрес электронной почты пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_shipping_address | Булевый | Необязательный | Передайте True, если вам нужен адрес доставки пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| send_phone_number_to_provider | Булевый | Необязательный | Передайте True, если номер телефона пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Telegram Stars. |
| send_email_to_provider | Boolean | Optional | Передайте True, если email пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Telegram Stars. |
| is_flexible | Boolean | Optional | Передайте True, если итоговая цена зависит от способа доставки. Игнорируется для платежей в Telegram Stars. |
| disable_notification | Boolean | Optional | Отправляет сообщение беззвучно. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Optional | Защищает содержимое отправленного сообщения от пересылки и сохранения |
| allow_paid_broadcast | Boolean | Optional | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя лимиты на рассылку за плату в 0.1 Telegram Stars за сообщение. Соответствующие Stars будут списаны с баланса бота. |
| message_effect_id | String | Optional | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для приватных чатов. |
| reply_parameters | ReplyParameters | Optional | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup | Optional | JSON-сериализованный объект для инлайн-клавиатуры. Если пусто,
будет показана одна кнопка "Оплатить общую сумму". Если не пусто, первая кнопка должна быть
кнопкой оплаты.
|
createInvoiceLink
Используйте этот метод для создания ссылки на счет. Возвращает созданную ссылку на счет в виде String при успешном выполнении.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет создана ссылка. Только для платежей в Telegram Stars. |
| title | String | Да | Название продукта, 1-32 символа |
| description | String | Да | Описание продукта, 1-255 символов |
| payload | String | Да | Определенный ботом полезный нагрузка счета, 1-128 байт. Это не будет отображаться пользователю, используйте его для ваших внутренних процессов. |
| provider_token | String | Необязательный | Токен платежного провайдера, полученный через @BotFather. Передайте пустую строку для платежей в Telegram Stars. |
| currency | String | Да | Трехбуквенный код валюты ISO 4217, см. больше о валютах. Передайте “XTR” для платежей в Telegram Stars. |
| prices | Array of LabeledPrice | Да | Разбивка цен, сериализованный в JSON список компонентов (например, цена продукта, налог, скидка, стоимость доставки, налог на доставку, бонус и т.д.). Должен содержать ровно один элемент для платежей в Telegram Stars. |
| subscription_period | Integer | Необязательный | Количество секунд, в течение которых подписка будет активна до следующего платежа. Валюта должна быть установлена на “XTR” (Telegram Stars), если параметр используется. В настоящее время он всегда должен быть 2592000 (30 дней), если указан. Любое количество подписок может быть активным для данного бота одновременно, включая несколько одновременных подписок от одного и того же пользователя. Цена подписки не должна превышать 2500 Telegram Stars. |
| max_tip_amount | Integer | Необязательный | Максимально допустимая сумма чаевых в наименьших единицах валюты (целое число, не
float/double). Например, для максимальных чаевых в US$ 1.45 передайте max_tip_amount =
145. См. параметр exp в currencies.json, он
показывает количество цифр после запятой для каждой валюты (2 для большинства валют). По умолчанию 0. Не
поддерживается для платежей в Telegram Stars.
|
| suggested_tip_amounts | Array of Integer | Необязательный | Сериализованный в JSON массив предложенных сумм чаевых в наименьших единицах валюты (целое число, не 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, если вам требуется полное имя пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_phone_number | Boolean | Необязательный | Передайте True, если вам требуется номер телефона пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_email | Boolean | Необязательный | Передайте True, если вам требуется адрес электронной почты пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| need_shipping_address | Boolean | Необязательный | Передайте True, если вам требуется адрес доставки пользователя для завершения заказа. Игнорируется для платежей в Telegram Stars. |
| send_phone_number_to_provider | Boolean | Необязательный | Передайте True, если номер телефона пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Telegram Stars. |
| send_email_to_provider | Boolean | Необязательный | Передайте True, если адрес электронной почты пользователя должен быть отправлен провайдеру. Игнорируется для платежей в Telegram Stars. |
| is_flexible | Boolean | Optional | Передайте True, если окончательная цена зависит от способа доставки. Игнорируется для платежей в Telegram Stars. |
answerShippingQuery
Если вы отправили счет с запросом адреса доставки и параметр is_flexible был указан, Bot API отправит Update с полем shipping_query боту. Используйте этот метод для ответа на запросы доставки. В случае успеха возвращается True.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| shipping_query_id | String | Да | Уникальный идентификатор запроса, на который нужно ответить |
| ok | Boolean | Да | Передайте True, если доставка по указанному адресу возможна, и False, если есть какие-либо проблемы (например, если доставка по указанному адресу невозможна) |
| shipping_options | Массив ShippingOption | Необязательный | Обязателен, если ok равно True. JSON-сериализованный массив доступных вариантов доставки. |
| error_message | String | Необязательный | Обязателен, если ok равно False. Сообщение об ошибке в понятной форме, объясняющее, почему невозможно завершить заказ (например, «Извините, доставка по вашему желаемому адресу недоступна»). Telegram отобразит это сообщение пользователю. |
answerPreCheckoutQuery
После того как пользователь подтвердил свои данные для оплаты и доставки, Bot API отправляет окончательное подтверждение в виде Update с полем pre_checkout_query. Используйте этот метод для ответа на такие запросы перед оформлением заказа. В случае успеха возвращается True. Примечание: Bot API должен получить ответ в течение 10 секунд после отправки запроса на предзаказ.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| pre_checkout_query_id | String | Да | Уникальный идентификатор запроса, на который необходимо ответить |
| ok | Boolean | Да | Укажите True, если все в порядке (товары доступны и т.д.) и бот готов продолжить выполнение заказа. Используйте False, если есть какие-либо проблемы. |
| error_message | String | Необязательно | Обязателен, если ok равно False. Сообщение об ошибке в понятной форме, которое объясняет причину невозможности продолжения оформления заказа (например, "Извините, кто-то только что купил последние наши потрясающие черные футболки, пока вы заполняли свои данные для оплаты. Пожалуйста, выберите другой цвет или изделие!"). Telegram отобразит это сообщение пользователю. |
getStarTransactions
Возвращает транзакции Telegram Star бота в хронологическом порядке. В случае успеха возвращает объект StarTransactions.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| offset | Integer | Необязательный | Количество транзакций, которые нужно пропустить в ответе |
| limit | Integer | Необязательный | Максимальное количество транзакций для получения. Принимаются значения от 1 до 100. По умолчанию 100. |
refundStarPayment
Возвращает успешный платеж в Telegram Stars. Возвращает True при успехе.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Идентификатор пользователя, чей платеж будет возвращен |
| telegram_payment_charge_id | String | Да | Идентификатор платежа Telegram |
editUserStarSubscription
Позволяет боту отменить или повторно активировать продление подписки, оплаченной в Telegram Stars. Возвращает True в случае успеха.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Идентификатор пользователя, подписка которого будет изменена |
| telegram_payment_charge_id | String | Да | Идентификатор платежа Telegram для подписки |
| is_canceled | Boolean | Да | Передайте True, чтобы отменить продление подписки пользователя; подписка должна быть активной до конца текущего периода подписки. Передайте False, чтобы разрешить пользователю повторно активировать подписку, которая была ранее отменена ботом. |
LabeledPrice
Этот объект представляет собой часть цены на товары или услуги.
| Поле | Тип | Описание |
|---|---|---|
| label | String | Название части |
| amount | Integer | Цена продукта в наименьших единицах валюты (целое число, не
float/double). Например, для цены US$ 1.45 укажите amount = 145. См.
параметр exp в currencies.json, он показывает
количество цифр после десятичной точки для каждой валюты (2 для большинства валют).
|
Счет
Этот объект содержит основную информацию о счете.
| Поле | Тип | Описание |
|---|---|---|
| title | String | Название продукта |
| description | String | Описание продукта |
| start_parameter | String | Уникальный параметр глубокого связывания бота, который можно использовать для генерации этого счета |
| currency | String | Трехбуквенный код валюты ISO 4217 валюты, или “XTR” для платежей в Telegram Stars |
| total_amount | Integer | Общая цена в самых мелких единицах валюты (целое число, не
дробное/двойное). Например, для цены 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 | Необязательно. Номер телефона пользователя |
| String | Необязательно. Электронная почта пользователя | |
| shipping_address | ShippingAddress | Необязательно. Адрес доставки пользователя |
ShippingOption
Этот объект представляет собой один вариант доставки.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Идентификатор варианта доставки |
| title | String | Название варианта |
| prices | Array of LabeledPrice | Список ценовых частей |
УспешныйПлатеж
Этот объект содержит основную информацию о успешном платеже. Обратите внимание, что если покупатель инициирует возврат средств у соответствующего платежного провайдера после этой транзакции, средства могут быть списаны с вашего баланса. Это вне контроля Telegram.
| Поле | Тип | Описание |
|---|---|---|
| currency | String | Трехбуквенный код валюты ISO 4217 валюты, или “XTR” для платежей в Telegram Stars |
| 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 | Идентификатор платежа Telegram |
| provider_payment_charge_id | String | Идентификатор платежа провайдера |
ВозвращенныйПлатеж
Этот объект содержит основную информацию о возвращенном платеже.
| Поле | Тип | Описание |
|---|---|---|
| currency | String | Трехбуквенный код валюты ISO 4217 валюты, или “XTR” для платежей в Telegram Stars. В настоящее время всегда “XTR” |
| total_amount | Integer | Общая сумма возврата в наименьших единицах валюты (целое число, не с
плавающей запятой). Например, для цены US$ 1.45, total_amount = 145. См.
параметр exp в currencies.json, он показывает
количество цифр после десятичной точки для каждой валюты (2 для большинства валют).
|
| invoice_payload | String | Заданная ботом нагрузка счета |
| telegram_payment_charge_id | String | Идентификатор платежа Telegram |
| provider_payment_charge_id | String | Необязательно. Идентификатор платежа провайдера |
ShippingQuery
Этот объект содержит информацию о входящем запросе на доставку.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор запроса |
| from | User | Пользователь, отправивший запрос |
| invoice_payload | String | Заданный ботом полезный нагрузка счета |
| shipping_address | ShippingAddress | Указанный пользователем адрес доставки |
PreCheckoutQuery
Этот объект содержит информацию о входящем запросе на предварительную оплату.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор запроса |
| from | User | Пользователь, отправивший запрос |
| currency | String | Трехбуквенный код валюты ISO 4217 валюты, или “XTR” для платежей в Telegram Stars |
| 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 | Целое число | Количество Telegram Stars, полученных аффилиатом за каждые 1000 Telegram Stars, полученных ботом от привлеченных пользователей |
| amount | Целое число | Целое количество Telegram Stars, полученных аффилиатом из транзакции, округленное до 0; может быть отрицательным для возвратов |
| nanostar_amount | Целое число | Необязательно. Количество 1/1000000000 долей Telegram Stars, полученных аффилиатом; от -999999999 до 999999999; может быть отрицательным для возвратов |
TransactionPartner
Этот объект описывает источник транзакции или её получателя для исходящих транзакций. В настоящее время это может быть одним из
- TransactionPartnerUser
- TransactionPartnerChat
- TransactionPartnerAffiliateProgram
- TransactionPartnerFragment
- TransactionPartnerTelegramAds
- TransactionPartnerTelegramApi
- TransactionPartnerOther
TransactionPartnerUser
Описание транзакции с пользователем.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип партнера по транзакции, всегда “user” |
| user | User | Информация о пользователе |
| affiliate | AffiliateInfo | Необязательно. Информация о партнере, который получил комиссию через эту транзакцию |
| invoice_payload | String | Необязательно. Указанная ботом нагрузка счета |
| subscription_period | Integer | Необязательно. Продолжительность оплаченной подписки |
| paid_media | Array of PaidMedia | Необязательно. Информация о оплаченных медиа, купленных пользователем |
| paid_media_payload | String | Необязательно. Указанная ботом нагрузка оплаченных медиа |
| gift | Gift | Необязательно. Подарок, отправленный пользователю ботом |
TransactionPartnerChat
Описание транзакции с чатом.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип партнера по транзакции, всегда “chat” |
| chat | Chat | Информация о чате |
| gift | Gift | Необязательно. Подарок, отправленный в чат ботом |
TransactionPartnerAffiliateProgram
Описание партнерской программы, которая выдала комиссию за привлечение, полученную через эту транзакцию.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип партнера по транзакции, всегда “affiliate_program” |
| sponsor_user | User | Необязательно. Информация о боте, который спонсировал партнерскую программу |
| commission_per_mille | Integer | Количество Telegram Stars, полученных ботом за каждые 1000 Telegram Stars, полученных спонсором партнерской программы от привлеченных пользователей |
TransactionPartnerFragment
Описывает транзакцию вывода с Fragment.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип партнера по транзакции, всегда “fragment” |
| withdrawal_state | RevenueWithdrawalState | Необязательно. Состояние транзакции, если транзакция является исходящей |
TransactionPartnerTelegramAds
Описывает транзакцию вывода на платформу Telegram Ads.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип партнера по транзакции, всегда “telegram_ads” |
TransactionPartnerTelegramApi
Описание транзакции с оплатой за платные трансляции.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип партнера по транзакции, всегда “telegram_api” |
| request_count | Integer | Количество успешных запросов, которые превысили обычные лимиты и, следовательно, были оплачены |
TransactionPartnerOther
Описание транзакции с неизвестным источником или получателем.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Тип транзакционного партнера, всегда “other” |
StarTransaction
Описание транзакции Telegram Star. Обратите внимание, что если покупатель инициирует возврат средств у платежного провайдера, у которого он приобрел Stars (например, Apple, Google) после этой транзакции, возвращенные Stars будут вычтены из баланса бота. Это вне контроля Telegram.
| Поле | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор транзакции. Совпадает с идентификатором оригинальной транзакции для возвратных транзакций. Совпадает с SuccessfulPayment.telegram_payment_charge_id для успешных входящих платежей от пользователей. |
| amount | Integer | Целочисленное количество Telegram Stars, переданных транзакцией |
| nanostar_amount | Integer | Необязательно. Количество 1/1000000000 долей Telegram Stars, переданных транзакцией; от 0 до 999999999 |
| date | Integer | Дата создания транзакции в формате Unix time |
| source | TransactionPartner | Необязательно. Источник входящей транзакции (например, пользователь, покупающий товары или услуги, Fragment, возвращающий неудачный вывод средств). Только для входящих транзакций |
| receiver | TransactionPartner | Необязательно. Получатель исходящей транзакции (например, пользователь для возврата покупки, Fragment для вывода средств). Только для исходящих транзакций |
StarTransactions
Содержит список транзакций Telegram Star.
| Поле | Тип | Описание |
|---|---|---|
| transactions | Массив StarTransaction | Список транзакций |
Telegram Passport
Telegram Passport — это единый метод авторизации для сервисов, которые требуют личной идентификации. Пользователи могут загрузить свои документы один раз, а затем мгновенно делиться своими данными с сервисами, которые требуют реального удостоверения личности (финансы, ICO и т.д.). Пожалуйста, смотрите руководство для получения подробной информации.
PassportData
Описывает данные Telegram Passport, переданные боту пользователем.
| Поле | Тип | Описание |
|---|---|---|
| data | Массив EncryptedPassportElement | Массив с информацией о документах и других элементах Telegram Passport, которые были переданы боту |
| credentials | EncryptedCredentials | Зашифрованные учетные данные, необходимые для расшифровки данных |
PassportFile
Этот объект представляет файл, загруженный в Telegram Passport. В настоящее время все файлы Telegram Passport находятся в формате JPEG после расшифровки и не превышают 10 МБ.
| Поле | Тип | Описание |
|---|---|---|
| file_id | String | Идентификатор этого файла, который можно использовать для загрузки или повторного использования файла |
| file_unique_id | String | Уникальный идентификатор этого файла, который должен оставаться неизменным со временем и для разных ботов. Не может быть использован для загрузки или повторного использования файла. |
| file_size | Integer | Размер файла в байтах |
| file_date | Integer | Unix-время, когда файл был загружен |
EncryptedPassportElement
Описание документов или других элементов Telegram 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 | Необязательно. Данные элемента Telegram Passport в формате Base64, зашифрованные и предоставленные пользователем; доступны только для типов “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” и “address”. Могут быть расшифрованы и проверены с использованием сопутствующих EncryptedCredentials. |
| phone_number | String | Необязательно. Подтвержденный номер телефона пользователя; доступен только для типа “phone_number” |
| 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. |
| translation | 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. См. Документацию по Telegram Passport для полного описания процессов расшифровки и аутентификации данных.
| Поле | Тип | Описание |
|---|---|---|
| data | String | Base64-кодированные зашифрованные данные в формате JSON с уникальной нагрузкой пользователя, хэшами данных и секретами, необходимыми для расшифровки и аутентификации EncryptedPassportElement |
| hash | String | Base64-кодированный хэш данных для аутентификации данных |
| secret | String | Base64-кодированный секрет, зашифрованный с помощью публичного RSA-ключа бота, необходимый для расшифровки данных |
setPassportDataErrors
Информирует пользователя о том, что некоторые элементы Telegram Passport, которые он предоставил, содержат ошибки. Пользователь не сможет повторно отправить свой Паспорт вам, пока ошибки не будут исправлены (содержимое поля, для которого вы вернули ошибку, должно измениться). Возвращает True в случае успеха.
Используйте это, если данные, отправленные пользователем, не соответствуют стандартам, которые требует ваш сервис, по любой причине. Например, если дата рождения кажется недействительной, отправленный документ нечеткий, скан показывает признаки подделки и т.д. Укажите некоторые детали в сообщении об ошибке, чтобы пользователь знал, как исправить проблемы.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Идентификатор пользователя |
| errors | Array of PassportElementError | Да | JSON-сериализованный массив, описывающий ошибки |
PassportElementError
Этот объект представляет собой ошибку в элементе Telegram Passport, который был отправлен и которую должен решить пользователь. Это должно быть одно из:
- PassportElementErrorDataField
- PassportElementErrorFrontSide
- PassportElementErrorReverseSide
- PassportElementErrorSelfie
- PassportElementErrorFile
- PassportElementErrorFiles
- PassportElementErrorTranslationFile
- PassportElementErrorTranslationFiles
- PassportElementErrorUnspecified
PassportElementErrorDataField
Представляет собой проблему в одном из полей данных, предоставленных пользователем. Ошибка считается исправленной, когда значение поля изменяется.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник ошибки, должен быть data |
| type | String | Раздел Telegram 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 | Секция Telegram Passport пользователя, в которой возникла проблема, одна из “passport”, “driver_license”, “identity_card”, “internal_passport” |
| file_hash | String | Base64-кодированный хэш файла с лицевой стороной документа |
| message | String | Сообщение об ошибке |
PassportElementErrorReverseSide
Представляет собой проблему с обратной стороной документа. Ошибка считается разрешенной, когда файл с обратной стороной документа изменяется.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник ошибки, должен быть reverse_side |
| type | String | Секция Telegram Passport пользователя, в которой возникла проблема, одна из “driver_license”, “identity_card” |
| file_hash | String | Base64-кодированный хэш файла с обратной стороной документа |
| message | String | Сообщение об ошибке |
PassportElementErrorSelfie
Представляет собой проблему с селфи документа. Ошибка считается исправленной, когда файл с селфи изменяется.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник ошибки, должен быть selfie |
| type | String | Раздел Telegram Passport пользователя, в котором возникла проблема, один из “passport”, “driver_license”, “identity_card”, “internal_passport” |
| file_hash | String | Base64-кодированный хэш файла с селфи |
| message | String | Сообщение об ошибке |
PassportElementErrorFile
Представляет собой проблему с сканированием документа. Ошибка считается устраненной, когда файл со сканированием документа изменяется.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник ошибки, должен быть file |
| type | String | Секция Telegram Passport пользователя, в которой возникла проблема, одна из “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
| file_hash | String | Base64-кодированный хэш файла |
| message | String | Сообщение об ошибке |
PassportElementErrorFiles
Представляет собой проблему с списком сканов. Ошибка считается устраненной, когда список файлов, содержащих сканы, изменяется.
| Поле | Тип | Описание |
|---|---|---|
| source | String | Источник ошибки, должен быть files |
| type | String | Раздел Telegram 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 | Тип элемента Telegram 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 | Тип элемента Telegram 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 | Тип элемента Telegram Passport пользователя, в котором возникла проблема |
| element_hash | String | Base64-кодированный хэш элемента |
| message | String | Сообщение об ошибке |
Игры
Ваш бот может предлагать пользователям HTML5 игры, чтобы играть в одиночку или соревноваться друг с другом в группах и в чатах один на один. Создавайте игры через @BotFather с помощью команды /newgame. Обратите внимание, что такая сила требует ответственности: вам необходимо принять условия для каждой игры, которую будут предлагать ваши боты.
- Игры — это новый тип контента в Telegram, представленный объектами Game и InlineQueryResultGame.
- После того как вы создали игру через BotFather, вы можете отправлять игры в чаты как обычные сообщения, используя метод sendGame, или использовать инлайн-режим с InlineQueryResultGame.
- Если вы отправите сообщение об игре без каких-либо кнопок, оно автоматически получит кнопку 'Играть в GameName'. Когда эта кнопка нажата, ваш бот получает CallbackQuery с game_short_name запрашиваемой игры. Вы предоставляете правильный URL для этого конкретного пользователя, и приложение открывает игру в браузере внутри приложения.
- Вы можете вручную добавить несколько кнопок к вашему сообщению об игре. Обратите внимание, что первая кнопка в первом ряду должна всегда запускать игру, используя поле callback_game в InlineKeyboardButton. Вы можете добавлять дополнительные кнопки по своему усмотрению: например, для описания правил или для открытия официального сообщества игры.
- Чтобы сделать вашу игру более привлекательной, вы можете загрузить GIF-анимацию, демонстрирующую игру пользователям через BotFather (см. Lumberjack в качестве примера).
- Сообщение об игре также будет отображать высокие результаты для текущего чата. Используйте setGameScore, чтобы опубликовать высокие результаты в чат с игрой, добавьте параметр disable_edit_message, чтобы отключить автоматическое обновление сообщения с текущей таблицей результатов.
- Используйте getGameHighScores, чтобы получить данные для таблиц высоких результатов в игре.
- Вы также можете добавить дополнительную кнопку для обмена, чтобы пользователи могли делиться своим лучшим результатом в разных чатах.
- Для примеров того, что можно сделать с помощью этого нового функционала, проверьте ботов @gamebot и @gamee.
sendGame
Используйте этот метод для отправки игры. В случае успеха возвращается отправленное Сообщение.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| business_connection_id | String | Необязательный | Уникальный идентификатор бизнес-соединения, от имени которого будет отправлено сообщение |
| chat_id | Integer | Да | Уникальный идентификатор целевого чата |
| message_thread_id | Integer | Необязательный | Уникальный идентификатор целевой темы сообщений (темы) форума; только для супергрупп форума |
| game_short_name | String | Да | Краткое имя игры, служит уникальным идентификатором для игры. Настройте свои игры через @BotFather. |
| disable_notification | Boolean | Необязательный | Отправляет сообщение тихо. Пользователи получат уведомление без звука. |
| protect_content | Boolean | Необязательный | Защищает содержимое отправленного сообщения от пересылки и сохранения |
| allow_paid_broadcast | Boolean | Необязательный | Передайте True, чтобы разрешить до 1000 сообщений в секунду, игнорируя ограничения на рассылку за плату в 0.1 Telegram Stars за сообщение. Соответствующие звезды будут списаны с баланса бота |
| message_effect_id | String | Необязательный | Уникальный идентификатор эффекта сообщения, который будет добавлен к сообщению; только для личных чатов |
| reply_parameters | ReplyParameters | Необязательный | Описание сообщения, на которое нужно ответить |
| reply_markup | InlineKeyboardMarkup | Необязательный | JSON-сериализованный объект для встраиваемой клавиатуры. Если пусто, будет показана одна кнопка 'Играть в game_title'. Если не пусто, первая кнопка должна запускать игру. |
Игра
Этот объект представляет собой игру. Используйте 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
Используйте этот метод, чтобы установить счет указанного пользователя в игровом сообщении. В случае успеха, если сообщение не является инлайн-сообщением, возвращается Сообщение, в противном случае возвращается True. Возвращается ошибка, если новый счет не больше текущего счета пользователя в чате, а force равно False.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| user_id | Integer | Да | Идентификатор пользователя |
| score | Integer | Да | Новый счет, должен быть неотрицательным |
| force | 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 не указаны. Идентификатор инлайн-сообщения |
getGameHighScores
Используйте этот метод, чтобы получить данные для таблиц высоких результатов. Он вернет результат указанного пользователя и нескольких его соседей в игре. Возвращает массив объектов 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. Идентификатор инлайн сообщения |
GameHighScore
Этот объект представляет одну строку таблицы рекордов для игры.
| Поле | Тип | Описание |
|---|---|---|
| position | Integer | Позиция в таблице рекордов для игры |
| user | User | Пользователь |
| score | Integer | Результат |
И это всё, что у нас есть на данный момент.
Если у вас есть какие-либо вопросы, пожалуйста, ознакомьтесь с нашим FAQ по ботам »