Message

This object represents a message. ↗

106 fields, 3 required.

Used by

Fields

message_id number Required
Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent.

date number Required
Date the message was sent in Unix time. It is always a positive number, representing a valid date.

chat Chat Required
Chat the message belongs to.

message_thread_id number
Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only.

direct_messages_topic DirectMessagesTopic
Information about the direct messages chat topic that contains the message.

from User
Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats.

sender_chat Chat
Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel’s discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats.

sender_boost_count number
If the sender of the message boosted the chat, the number of boosts added by the user.

sender_business_bot User
The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

sender_tag string
Tag or custom title of the sender of the message; for supergroups only.

business_connection_id string
Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

forward_origin MessageOrigin
Information about the original message for forwarded messages.

is_topic_message boolean
True, if the message is sent to a topic in a forum supergroup or a private chat with the bot.

is_automatic_forward boolean
True, if the message is a channel post that was automatically forwarded to the connected discussion group.

reply_to_message Message
For replies in the same chat and message thread, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

external_reply ExternalReplyInfo
Information about the message that is being replied to, which may come from another chat or forum topic.

quote TextQuote
For replies that quote part of the original message, the quoted part of the message.

reply_to_story Story
For replies to a story, the original story.

reply_to_checklist_task_id number
Identifier of the specific checklist task that is being replied to.

via_bot User
Bot through which the message was sent.

edit_date number
Date the message was last edited in Unix time.

has_protected_content boolean
True, if the message can’t be forwarded.

is_from_offline boolean
True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message.

is_paid_post boolean
True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can’t be edited.

media_group_id string
The unique identifier inside this chat of a media message group this message belongs to.

author_signature string
Signature of the post author for messages in channels, or the custom title of an anonymous group administrator.

paid_star_count number
The number of Telegram Stars that were paid by the sender of the message to send it.

text string
For text messages, the actual UTF-8 text of the message.

entities MessageEntity[]
For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.

link_preview_options LinkPreviewOptions
Options used for link preview generation for the message, if it is a text message and link preview options were changed.

suggested_post_info SuggestedPostInfo
Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can’t be edited.

effect_id string
Unique identifier of the message effect added to the message.

animation Animation
Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set.

audio Audio
Message is an audio file, information about the file.

document Document
Message is a general file, information about the file.

paid_media PaidMediaInfo
Message contains paid media; information about the paid media.

photo PhotoSize[]
Message is a photo, available sizes of the photo.

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
Message is a video note, information about the video message.

voice Voice
Message is a voice message, information about the file.

caption string
Caption for the animation, audio, document, paid media, 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.

show_caption_above_media boolean
True, if the caption must be shown above the message media.

has_media_spoiler boolean
True, if the message media is covered by a spoiler animation.

checklist Checklist
Message is a checklist.

contact Contact
Message is a shared contact, information about the contact.

dice Dice
Message is a dice with random value.

game Game
Message is a game, information about the game. More about games ».

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 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).

chat_owner_left ChatOwnerLeft
Service message: chat owner has left.

chat_owner_changed ChatOwnerChanged
Service message: chat owner has changed.

new_chat_title string
A chat title was changed to this value.

new_chat_photo PhotoSize[]
A chat photo was change to this value.

delete_chat_photo boolean
Service message: the chat photo was deleted.

group_chat_created boolean
Service message: the group has been created.

supergroup_chat_created boolean
Service message: the supergroup has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.

channel_chat_created boolean
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
Service message: auto-delete timer settings changed in the chat.

migrate_to_chat_id number
The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

migrate_from_chat_id number
The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

pinned_message MaybeInaccessibleMessage
Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

invoice Invoice
Message is an invoice for a payment, information about the invoice. More about payments ».

successful_payment SuccessfulPayment
Message is a service message about a successful payment, information about the payment. More about payments ».

refunded_payment RefundedPayment
Message is a service message about a refunded payment, information about the payment. More about payments ».

users_shared UsersShared
Service message: users were shared with the bot.

chat_shared ChatShared
Service message: a chat was shared with the bot.

gift GiftInfo
Service message: a regular gift was sent or received.

unique_gift UniqueGiftInfo
Service message: a unique gift was sent or received.

gift_upgrade_sent GiftInfo
Service message: upgrade of a gift was purchased after the gift was sent.

connected_website string
The domain name of the website on which the user has logged in. More about Telegram Login ».

write_access_allowed WriteAccessAllowed
Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method 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.

boost_added ChatBoostAdded
Service message: user boosted the chat.

chat_background_set ChatBackground
Service message: chat background set.

checklist_tasks_done ChecklistTasksDone
Service message: some tasks in a checklist were marked as done or not done.

checklist_tasks_added ChecklistTasksAdded
Service message: tasks were added to a checklist.

direct_message_price_changed DirectMessagePriceChanged
Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed.

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.

giveaway_created GiveawayCreated
Service message: a scheduled giveaway was created.

giveaway Giveaway
The message is a scheduled giveaway message.

giveaway_winners GiveawayWinners
A giveaway with public winners was completed.

giveaway_completed GiveawayCompleted
Service message: a giveaway without public winners was completed.

paid_message_price_changed PaidMessagePriceChanged
Service message: the price for paid messages has changed in the chat.

suggested_post_approved SuggestedPostApproved
Service message: a suggested post was approved.

suggested_post_approval_failed SuggestedPostApprovalFailed
Service message: approval of a suggested post has failed.

suggested_post_declined SuggestedPostDeclined
Service message: a suggested post was declined.

suggested_post_paid SuggestedPostPaid
Service message: payment for a suggested post was received.

suggested_post_refunded SuggestedPostRefunded
Service message: payment for a suggested post was refunded.

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
Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.