Data about the message
OptionalanimationMessage is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set
OptionalaudioMessage is an audio file, information about the file
OptionalauthorSender 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
OptionalauthorTrue, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message
OptionalauthorSignature of the post author for messages in channels, or the custom title of an anonymous group administrator
OptionalautoService message: auto-delete timer settings changed in the chat
OptionalautomaticTrue, if the message is a channel post that was automatically forwarded to the connected discussion group
OptionalboostService message: user boosted the chat
OptionalbusinessUnique 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
OptionalcaptionCaption for the animation, audio, document, photo, video or voice
OptionalcaptionFor messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
OptionalchannelService 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
OptionalchatSender 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.
OptionalchatService message: chat background set
OptionalchatService message: a chat was shared with the bot
OptionalchecklistMessage is a checklist
OptionalchecklistIdentifier of the specific checklist task that is being replied to
OptionalchecklistService message: tasks were added to a checklist
OptionalchecklistService message: some tasks in a checklist were marked as done or not done
OptionalconnectedThe domain name of the website on which the user has logged in. More about Telegram Login
OptionalcontactMessage is a shared contact, information about the contact
OptionalcontentFor text messages, the actual UTF-8 text of the message
Date the message was sent in Unix time. It is always a positive number, representing a valid date
OptionaldeleteService message: the chat photo was deleted
OptionaldiceMessage is a dice with random value
OptionaldirectService message: the price for paid messages in the corresponding direct messages chat of a channel has changed
OptionalmessageStarCount?: numberOptionaldirectInformation about the direct messages chat topic that contains the message.
Unique identifier of the topic.
Information about the user that created the topic. Currently, it is always present.
OptionaldocumentMessage is a general file, information about the file
OptionaleditedDate the message was last edited in Unix time
OptionaleffectUnique identifier of the message effect added to the message
OptionalentitiesFor text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
OptionalexternalInformation about the message that is being replied to, which may come from another chat or forum topic
OptionalforumIf the message is sent to a forum topic
OptionalforumService message: forum topic closed
OptionalforumService message: forum topic created
OptionalforumService message: forum topic edited
OptionalforumService message: forum topic reopened
OptionalforwardInformation about the original message for forwarded messages
OptionalgameMessage is a game, information about the game. More about games
OptionalgeneralService message: the 'General' forum topic hidden
OptionalgeneralService message: the 'General' forum topic unhidden
OptionalgiftService message: a regular gift was sent or received
OptionalgiveawayThe message is a scheduled giveaway message
OptionalgiveawayService message: a giveaway without public winners was completed
OptionalgiveawayService message: a scheduled giveaway was created
OptionalstarCount?: numberOptionalgiveawayA giveaway with public winners was completed
OptionalgroupService message: the group has been created
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
OptionalinTrue, if the message is sent to a forum topic
OptionalisTrue, 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.
OptionalleftA member was removed from the group, information about them (this member may be the bot itself)
OptionallinkOptions used for link preview generation for the message, if it is a text message and link preview options were changed
OptionallocationMessage is a shared location, information about the location
OptionalmemberMember that were added to the message group or supergroup and information about them
OptionalmigrateThe supergroup has been migrated from a group with the specified identifier
OptionalnewNew members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
OptionalnewA chat photo was change to this value
OptionalnewA chat title was changed to this value
OptionaloriginalFor 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
OptionalpaidMessage contains paid media; information about the paid media
OptionalpaidService message: the price for paid messages has changed in the chat; The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message
OptionalpaidThe number of Telegram Stars that were paid by the sender of the message to send it
OptionalpassportTelegram Passport data
OptionalphotoMessage is a photo, available sizes of the photo
OptionalpollMessage is a native poll, information about the poll
OptionalprotectedTrue, if the message can't be forwarded
OptionalproximityService message. A user in the chat triggered another user's proximity alert while sharing Live Location
OptionalquoteFor replies that quote part of the original message, the quoted part of the message
OptionalrefundedMessage is a service message about a refunded payment, information about the payment. More about payments
OptionalsenderIf the sender of the message boosted the chat, the number of boosts added by the user
OptionalsenderThe 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.
OptionalsenderChat that sent the message originally
OptionalshowTrue, if the caption must be shown above the message media
OptionalstickerMessage is a sticker, information about the sticker
OptionalstoryFor replies to a story, the original message
OptionalsuccessfulMessage is a service message about a successful payment, information about the payment. More about payments
OptionalsuggestedService message: approval of a suggested post has failed
OptionalsuggestedService message: a suggested post was approved
OptionalsuggestedService message: a suggested post was declined
OptionalsuggestedInformation 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.
OptionalsuggestedService message: payment for a suggested post was received
OptionalsuggestedService message: payment for a suggested post was refunded
OptionalsupergroupService 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
OptionalthreadUnique identifier of a message thread or a forum topic to which the message belongs; for supergroups only
OptionaluniqueService message: a unique gift was sent or received
OptionalusersService message: users were shared with the bot
OptionalvenueMessage is a venue, information about the venue
OptionalviaBot through which the message was sent
OptionalvideoMessage is a video, information about the video
OptionalvideoService message: video chat ended
OptionalvideoService message: new participants invited to a video chat
OptionalvideoService message: video chat scheduled
OptionalvideoService message: video chat started
OptionalvideoMessage is a video note, information about the video message
OptionalvoiceMessage is a voice message, information about the file
OptionalwebService message: data sent by a Web App
OptionalwriteService 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
OptionalappName?: stringOptionalauthorAttachmentMenu?: booleanOptionalauthorRequest?: booleanThe client that instantiated this
Date the message was sent. It is always a positive number, representing a valid date
Return the timestamp message was sent, in milliseconds
Date the message was last edited
Return the timestamp message was last edited, in milliseconds
Protected_Data about the message
Protected_ProtectedUpdates the current instance with new data and returns a clone of the updated instance
The data to update the instance with
A clone of the updated instance
Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat.
OptionalsendDate: numberPoint in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future.
Optionaloptions: ICollectorOptions<string, Message>message collector options
Optionaloptions: ICollectorOptions<string, Message> & { errors?: string[] }message collector options
Optionaloptions: ICollectorOptions<string, MessageReactionUpdated>reaction collector options
Optionaloptions: ICollectorOptions<string, MessageReactionUpdated> & { errors?: string[] }reaction collector options
Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Optionaloptions: Omit<out parameters
Returns the message id of the sent message on success.
Optionaloptions: ICollectorOptions<string, Message>message collector options
Optionaloptions: ICollectorOptions<string, CallbackQuery>inline keyboard collector options
Optionaloptions: ICollectorOptions<string, MessageReactionUpdated>reaction collector options
Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat.
Optionalcomment: stringComment for the creator of the suggested post; 0-128 characters.
Returns True on success.
Use this method to delete a message, including service messages, with the following limitations:
Returns True on success.
Use this method to edit text and game messages.
New text of the message, 1-4096 characters after entities parsing
Optionaloptions: Omit<out parameters
On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
Use this method to edit captions of messages.
Optionalcaption: stringNew caption of the message, 0-1024 characters after entities parsing
Optionaloptions: Omit<out parameters
On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
Use this method to edit a checklist on behalf of a connected business account.
Unique identifier of the business connection on behalf of which the message will be sent.
An object for the new checklist.
Optionaloptions: Omit<out parameters.
On success, the edited Message is returned.
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation.
Latitude of new location
Longitude of new location
Optionaloptions: Omit<out parameters
On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to edit animation, audio, document, photo, video messages or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL.
An object for a new media content of the message
Optionaloptions: Omit<out parameters
On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
Use this method to edit only the reply markup of messages.
An object for an inline keyboard
Optionaloptions: Omit<out parameters
On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Optionaloptions: Omit<out parameters
On success, the sent Message is returned.
Checking if the message has been edited
Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.
Optionaloptions: { businessConnectionId?: string; notification?: boolean }options for pinned message
OptionalbusinessConnectionId?: stringUnique identifier of the business connection on behalf of which the message will be pinned
Optionalnotification?: booleanPass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats
Returns True on success.
Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message.
A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots
OptionalisBig: booleanPass True to set the reaction with a big animation
Returns True on success.
Reply to the current message
Text of the message to be sent, 1-4096 characters after entities parsing
Optionaloptions: Omit<out parameters
On success, the sent Message is returned.
Use this method to stop updating a live location message before live_period expires.
Optionaloptions: Omit<out parameters
On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
Flatten an object. Any properties that are collections will get converted to an array of keys.
OptionalpropsRecursive: booleanOptional. If true, calls toJSON method on nested objects.
Optional. Specific properties to include/exclude, or rename.
Flattened object.
Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively.
OptionalbusinessConnectionId: stringUnique identifier of the business connection on behalf of which the message will be unpinned
Returns True on success.
Returns the id instance Chat, User, ChatMember and other
The client that instantiated this