Типы получаемых данных от API Telegram Bot

В данном разделе собраны типы данных, которые вы можете получить от API Telegram. ВНИМАНИЕ: Все методы вы можете найти в оригинальной документации на английском языке.

Обновления (Update)

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

Имя поля Тип данных Описание
update_id Число (integer) update_id - это уникальный идентификатор обновления. Идентификаторы обновлений начинаются с определенного положительного числа и увеличиваются последовательно. Этот ID особенно полезен, если вы используете вебхуки, так как он позволяет игнорировать повторяющиеся обновления или восстанавливать правильную последовательность обновлений, если они выходят из порядка. Если новых обновлений нет как минимум неделю, то идентификатор следующего обновления будет выбран случайным образом, а не последовательно.
message Сообщение (тип данных Message) Сообщение - это новое входящее сообщение любого типа - текст, фото, стикер и т. д.Отредактированное сообщение - это новая версия сообщения, которое уже известно боту и было отредактировано. Опционально.
edited_message Сообщение (тип данных Message) Отредактированное сообщение - это новая версия сообщения, которое уже известно боту и было отредактировано.Опционально.
channel_post Сообщение (тип данных Message) Пост с канала - это новый входящий пост в канале любого типа - текст, фото, стикер и т. д.Опционально.
edited_channel_post Сообщение (тип данных Message) Отредактированный пост с канала - это новая версия канального поста, который уже известен боту и был отредактирован.Опционально.
inline_query Инлайн-запрос (тип данных InlineQuery) Inline-запрос - это новый входящий inline-запрос.Опционально.
chosen_inline_result ChosenInlineResult (тип данных ChosenInlineResult) Это результат встроенного запроса, который был выбран пользователем и отправлен его собеседнику в чате.Опционально.<
callback_query CallbackQuery - тип данных Это новый входящий обратный запрос.
shipping_query ShippingQuery - тип данных Это новый входящий запрос о доставке. Он актуален только для счетов с гибкой ценой.Опционально.
pre_checkout_query PreCheckoutQuery - тип данных Это новый входящий запрос о предварительной проверке. В нем содержится полная информация о покупке.Опционально.
poll Poll - тип данных Это новое состояние опроса. Боты получают обновления только о остановленных опросах и опросах, которые были отправлены ботом.Опционально.
poll_answer PollAnswer - тип данных Это изменение ответа пользователя в опросе без анонимности. Боты получают новые голоса только в опросах, которые были отправлены самим ботом.Опционально.
my_chat_member ChatMemberUpdated - тип данных Дополнительно. Статус участника чата бота был обновлен в чате. В личных чатах это обновление получается только тогда, когда пользователь блокирует или разблокирует бота.Опционально.
chat_member ChatMemberUpdated - тип данных Дополнительно. Статус участника чата был обновлен в чате. Бот должен быть администратором в чате и явно указать "chat_member" в списке разрешенных обновлений, чтобы получать эти обновления.Опционально.
chat_join_request ChatJoinRequest - тип данных Запрос на присоединение к чату был отправлен. Бот должен иметь право администратора "can_invite_users" в чате, чтобы получать эти обновления. Опционально.

Сообщение (Message)

Это данные о сообщении в Telegram.

Имя поля Тип данных Описание
message_id Число (Integer) Уникальный идентификатор сообщения внутри текущего чата.
message_thread_id Число (Integer) Опционально.. Уникальный идентификатор потока сообщений, к которому принадлежит сообщение; только для супергрупп.
from User Опционально.. Отправитель сообщения; пусто для сообщений, отправленных в каналы. Для обратной совместимости в неканальных чатах поле содержит фиктивного пользователя-отправителя, если сообщение было отправлено от имени чата.
sender_chat Chat Опционально.. Отправитель сообщения, отправленного от имени чата/канала. Например, сам канал для публикаций на канале, сама супергруппа для анонимных сообщений от администраторов групп, связанный канал для сообщений, автоматически пересылаемых в группу для обсуждения. Для обратной совместимости поле from содержит поддельного пользователя-отправителя в чатах, если сообщение было отправлено от имени чата.
date Число (Integer) Дата в формате Unix time.
chat Chat Чат, которому принадлежит сообщение
forward_from User Опционально.. Для пересылаемых сообщений. Отправитель исходного сообщения.
forward_from_chat Chat Опционально.. Для сообщений, пересылаемых из каналов или от анонимных администраторов, информация об исходном чате отправителя.
forward_from_message_id Число (Integer) Опционально.. Для сообщений, пересылаемых из каналов, идентификатор исходного сообщения в канале.
forward_signature String Опционально.. Для пересылаемых сообщений, которые изначально были отправлены в каналах или анонимным администратором чата, подпись отправителя сообщения, если она присутствует.
forward_sender_name String Опционально.. Имя отправителя сообщения, пересылаемого от пользователей, которые запретили добавлять ссылку на свою учетную запись в пересылаемые сообщения.
forward_date Число (Integer) Опционально.. Дата оригинального сообщения для пересылаемых сообщений. В формате Unix time.
is_topic_message True Опционально.. Если True сообщение отправлено в топик форума.
is_automatic_forward True Опционально.. Если True то это сообщение с канала, которое было автоматически было отправлено в группу для обсуждения.
reply_to_message Message Опционально.. Для ответов — исходное сообщение. Обратите внимание, что объект Message в этом поле не будет содержать дополнительных полей reply_to_message, даже если он сам является ответом.
via_bot User Опционально.. Бот, через которого было отправлено сообщение.
edit_date Число (Integer) Опционально.. Дата редактирования сообщения в формате Unix time.
has_protected_content True Опционально.. Если True то сообщение нельзя переслать.
media_group_id String Опционально.. Уникальный идентификатор группы мультимедиа сообщений, к которой принадлежит данное сообщение.
author_signature String Опционально.. Подпись автора поста для сообщений в каналах или произвольный заголовок анонимного администратора группы.
text String Опционально.. Для текстовых сообщений — сам текст сообщения в кодировке UTF-8.
entities Array of MessageEntity Опционально.. Для текстовых сообщений. Специальные объекты, такие как имена пользователей, URL-адреса, команды бота и т.д., которые появляются в тексте.
animation Animation Опционально.. Сообщение — анимация, информация об анимации. В целях обратной совместимости, если это поле установлено, поле document также будет установлено.
audio Audio Опционально.. Сообщение — аудиофайл, информация о файле.
document Document Опционально.. Message is a general file, information about the file
photo Array of PhotoSize Опционально.. Сообщение фотография, доступные размеры фотографии.
sticker Sticker Опционально.. Message is a sticker, information about the sticker
story Story Опционально.. Message is a forwarded story
video Video Опционально.. Message is a video, information about the video
video_note VideoNote Опционально.. Сообщение – видеозаметка, информация о видео сообщении.
voice Voice Опционально.. Message is a voice message, information about the file
caption String Опционально.. Caption for the animation, audio, document, photo, video or voice
caption_entities Массив из типов данных MessageEntity Опционально.. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
has_media_spoiler True Опционально.. True, if the message media is covered by a spoiler animation
contact Contact Опционально.. Message is a shared contact, information about the contact
dice Dice Опционально.. Сообщение представляет собой игральную кость со случайным значением.
game Game Опционально.. Message is a game, information about the game.
poll Poll Опционально.. Message is a native poll, information about the poll
venue Venue Опционально.. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set
location Location Опционально.. Message is a shared location, information about the location
new_chat_members Array of User Опционально.. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
left_chat_member User Опционально.. A member was removed from the group, information about them (this member may be the bot itself)
new_chat_title String Опционально.. A chat title was changed to this value
new_chat_photo Array of PhotoSize Опционально.. A chat photo was change to this value
delete_chat_photo True Опционально.. Сервисное сообщение: фото в чате удалено
group_chat_created True Опционально.. Сервисное сообщение: группа создана
supergroup_chat_created True Опционально.. Сервисное сообщение: супергруппа создана. Это поле нельзя получить в сообщении, поступающем через обновления, поскольку бот не может быть членом супергруппы при ее создании. Его можно найти только в ответе_to_message, если кто-то отвечает на самое первое сообщение в непосредственно созданной супергруппе.
channel_chat_created True Опционально.. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.
message_auto_delete_timer_changed MessageAutoDeleteTimerChanged Опционально.. Сервисное сообщение: в чате изменены настройки таймера автоудаления
migrate_to_chat_id Число (Integer) Опционально.. Группа перенесена в супергруппу с указанным идентификатором. Это число может иметь более 32 значащих битов, и в некоторых языках программирования могут возникнуть трудности или неявные дефекты при его интерпретации. Но он имеет не более 52 значащих битов, поэтому 64-битное целое число со знаком или тип с плавающей запятой двойной точности безопасны для хранения этого идентификатора.
migrate_from_chat_id Число (Integer) Опционально.. Когда вы видите это поле в сообщении, это означает, что супергруппа была перенесена из другой группы с указанным идентификатором. Важно знать, что этот идентификатор может содержать более 32 значащих битов, и некоторые языки программирования могут испытывать проблемы с его правильным интерпретированием. Однако он имеет не более 52 значащих битов, поэтому безопасно использовать знаковое 64-битное целое число или число с двойной точностью с плавающей запятой для хранения этого идентификатора.
pinned_message Message Опционально.. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
invoice Invoice Опционально.. Message is an invoice for a payment, information about the invoice.
successful_payment SuccessfulPayment Опционально.. Message is a service message about a successful payment, information about the payment.
user_shared UserShared Опционально.. Service message: a user was shared with the bot
chat_shared ChatShared Опционально.. Service message: a chat was shared with the bot
connected_website String Опционально.. The domain name of the website on which the user has logged in.
write_access_allowed WriteAccessAllowed Опционально.. Служебное сообщение: пользователь разрешил боту отправлять сообщения после добавления его в приложение или боковое меню, запуска веб-приложения по ссылке или принятия явного запроса от веб-приложения, отправленного методом requestWriteAccess.
passport_data PassportData Опционально.. Telegram Passport data
proximity_alert_triggered ProximityAlertTriggered Опционально.. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
forum_topic_created ForumTopicCreated Опционально.. Service message: forum topic created
forum_topic_edited ForumTopicEdited Опционально.. Service message: forum topic edited
forum_topic_closed ForumTopicClosed Опционально.. Service message: forum topic closed
forum_topic_reopened ForumTopicReopened Опционально.. Service message: forum topic reopened
general_forum_topic_hidden GeneralForumTopicHidden Опционально.. Service message: the 'General' forum topic hidden
general_forum_topic_unhidden GeneralForumTopicUnhidden Опционально.. Service message: the 'General' forum topic unhidden
video_chat_scheduled VideoChatScheduled Опционально.. Service message: video chat scheduled
video_chat_started VideoChatStarted Опционально.. Service message: video chat started
video_chat_ended VideoChatEnded Опционально.. Service message: video chat ended
video_chat_participants_invited VideoChatParticipantsInvited Опционально.. Service message: new participants invited to a video chat
web_app_data WebAppData Опционально.. Service message: data sent by a Web App
reply_markup InlineKeyboardMarkup Опционально.. Встроенная клавиатура, прикрепленная к сообщению. Кнопки login_url представлены как обычные кнопки url.

Опубликовано: 13 ноября 2023
Последнее обновление: 16 ноября 2023
Автор: Семен