telegramx.js

Message

interface

This object represents a message.

Declaration

interface Message

Properties

animationproperty#
animation?: Animation;

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

audioproperty#
audio?: Audio;

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

author_signatureproperty#
author_signature?: string;

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

boost_addedproperty#
boost_added?: ChatBoostAdded;

Optional. Service message: user boosted the chat

business_connection_idproperty#
business_connection_id?: string;

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

caption_entitiesproperty#
caption_entities?: MessageEntity[];

Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption

captionproperty#
caption?: string;

Optional. Caption for the animation, audio, document, paid media, photo, video or voice

channel_chat_createdproperty#
channel_chat_created?: boolean;

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

chat_background_setproperty#
chat_background_set?: ChatBackground;

Optional. Service message: chat background set

chat_owner_changedproperty#
chat_owner_changed?: ChatOwnerChanged;

Optional. Service message: chat owner has changed

chat_owner_leftproperty#
chat_owner_left?: ChatOwnerLeft;

Optional. Service message: chat owner has left

chat_sharedproperty#
chat_shared?: ChatShared;

Optional. Service message: a chat was shared with the bot

chatproperty#
chat: Chat;

Chat the message belongs to

checklist_tasks_addedproperty#
checklist_tasks_added?: ChecklistTasksAdded;

Optional. Service message: tasks were added to a checklist

checklist_tasks_doneproperty#
checklist_tasks_done?: ChecklistTasksDone;

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

checklistproperty#
checklist?: Checklist;

Optional. Message is a checklist

connected_websiteproperty#
connected_website?: string;

Optional. The domain name of the website on which the user has logged in. More about Telegram Login: https://core.telegram.org/widgets/login

contactproperty#
contact?: Contact;

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

dateproperty#
date: number;

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

delete_chat_photoproperty#
delete_chat_photo?: boolean;

Optional. Service message: the chat photo was deleted

diceproperty#
dice?: Dice;

Optional. Message is a dice with random value

direct_message_price_changedproperty#
direct_message_price_changed?: DirectMessagePriceChanged;

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

direct_messages_topicproperty#
direct_messages_topic?: DirectMessagesTopic;

Optional. Information about the direct messages chat topic that contains the message

documentproperty#
document?: Document;

Optional. Message is a general file, information about the file

edit_dateproperty#
edit_date?: number;

Optional. Date the message was last edited in Unix time

effect_idproperty#
effect_id?: string;

Optional. Unique identifier of the message effect added to the message

entitiesproperty#
entities?: MessageEntity[];

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

external_replyproperty#
external_reply?: ExternalReplyInfo;

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

forum_topic_closedproperty#
forum_topic_closed?: ForumTopicClosed;

Optional. Service message: forum topic closed

forum_topic_createdproperty#
forum_topic_created?: ForumTopicCreated;

Optional. Service message: forum topic created

forum_topic_editedproperty#
forum_topic_edited?: ForumTopicEdited;

Optional. Service message: forum topic edited

forum_topic_reopenedproperty#
forum_topic_reopened?: ForumTopicReopened;

Optional. Service message: forum topic reopened

forward_originproperty#
forward_origin?: MessageOrigin;

Optional. Information about the original message for forwarded messages

fromproperty#
from?: User;

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

gameproperty#
game?: Game;

Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games

general_forum_topic_hiddenproperty#
general_forum_topic_hidden?: GeneralForumTopicHidden;

Optional. Service message: the 'General' forum topic hidden

general_forum_topic_unhiddenproperty#
general_forum_topic_unhidden?: GeneralForumTopicUnhidden;

Optional. Service message: the 'General' forum topic unhidden

gift_upgrade_sentproperty#
gift_upgrade_sent?: GiftInfo;

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

giftproperty#
gift?: GiftInfo;

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

giveaway_completedproperty#
giveaway_completed?: GiveawayCompleted;

Optional. Service message: a giveaway without public winners was completed

giveaway_createdproperty#
giveaway_created?: GiveawayCreated;

Optional. Service message: a scheduled giveaway was created

giveaway_winnersproperty#
giveaway_winners?: GiveawayWinners;

Optional. A giveaway with public winners was completed

giveawayproperty#
giveaway?: Giveaway;

Optional. The message is a scheduled giveaway message

group_chat_createdproperty#
group_chat_created?: boolean;

Optional. Service message: the group has been created

guest_bot_caller_chatproperty#
guest_bot_caller_chat?: Chat;

Optional. For a message sent by a guest bot, this is the chat whose original message triggered the bot's response

guest_bot_caller_userproperty#
guest_bot_caller_user?: User;

Optional. For a message sent by a guest bot, this is the user whose original message triggered the bot's response

guest_query_idproperty#
guest_query_id?: string;

Optional. The unique identifier for the guest query. Use this identifier with the method answerGuestQuery to send a response message. If non-empty, the message belongs to the chat where the guest bot was summoned, which may not coincide with other existing bot chats sharing the same identifier.

has_media_spoilerproperty#
has_media_spoiler?: boolean;

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

has_protected_contentproperty#
has_protected_content?: boolean;

Optional. True, if the message can't be forwarded

invoiceproperty#
invoice?: Invoice;

Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments

is_automatic_forwardproperty#
is_automatic_forward?: boolean;

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

is_from_offlineproperty#
is_from_offline?: boolean;

Optional. 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_postproperty#
is_paid_post?: boolean;

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

is_topic_messageproperty#
is_topic_message?: boolean;

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

left_chat_memberproperty#
left_chat_member?: User;

Optional. A member was removed from the group, information about them (this member may be the bot itself)

live_photoproperty#
live_photo?: LivePhoto;

Optional. Message is a live photo, information about the live photo. For backward compatibility, when this field is set, the photo field will also be set.

locationproperty#
location?: Location;

Optional. Message is a shared location, information about the location

managed_bot_createdproperty#
managed_bot_created?: ManagedBotCreated;

Optional. Service message: user created a bot that will be managed by the current bot

media_group_idproperty#
media_group_id?: string;

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

message_auto_delete_timer_changedproperty#
message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged;

Optional. Service message: auto-delete timer settings changed in the chat

message_idproperty#
message_id: number;

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.

message_thread_idproperty#
message_thread_id?: number;

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

migrate_from_chat_idproperty#
migrate_from_chat_id?: number;

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

migrate_to_chat_idproperty#
migrate_to_chat_id?: number;

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

new_chat_membersproperty#
new_chat_members?: User[];

Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

new_chat_photoproperty#
new_chat_photo?: PhotoSize[];

Optional. A chat photo was change to this value

new_chat_titleproperty#
new_chat_title?: string;

Optional. A chat title was changed to this value

passport_dataproperty#
passport_data?: PassportData;

Optional. Telegram Passport data

photoproperty#
photo?: PhotoSize[];

Optional. Message is a photo, available sizes of the photo

pinned_messageproperty#
pinned_message?: MaybeInaccessibleMessage;

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

poll_option_addedproperty#
poll_option_added?: PollOptionAdded;

Optional. Service message: answer option was added to a poll

poll_option_deletedproperty#
poll_option_deleted?: PollOptionDeleted;

Optional. Service message: answer option was deleted from a poll

pollproperty#
poll?: Poll;

Optional. Message is a native poll, information about the poll

proximity_alert_triggeredproperty#
proximity_alert_triggered?: ProximityAlertTriggered;

Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.

quoteproperty#
quote?: TextQuote;

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

refunded_paymentproperty#
refunded_payment?: RefundedPayment;

Optional. Message is a service message about a refunded payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments

reply_markupproperty#
reply_markup?: InlineKeyboardMarkup;

Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.

reply_to_checklist_task_idproperty#
reply_to_checklist_task_id?: number;

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

reply_to_messageproperty#
reply_to_message?: Message;

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

reply_to_poll_option_idproperty#
reply_to_poll_option_id?: string;

Optional. Persistent identifier of the specific poll option that is being replied to

reply_to_storyproperty#
reply_to_story?: Story;

Optional. For replies to a story, the original story

rich_messageproperty#
rich_message?: RichMessage;

Optional. Message is a rich formatted message

sender_boost_countproperty#
sender_boost_count?: number;

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

sender_business_botproperty#
sender_business_bot?: User;

Optional. 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_chatproperty#
sender_chat?: Chat;

Optional. 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_tagproperty#
sender_tag?: string;

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

show_caption_above_mediaproperty#
show_caption_above_media?: boolean;

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

stickerproperty#
sticker?: Sticker;

Optional. Message is a sticker, information about the sticker

storyproperty#
story?: Story;

Optional. Message is a forwarded story

successful_paymentproperty#
successful_payment?: SuccessfulPayment;

Optional. Message is a service message about a successful payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments

suggested_post_approval_failedproperty#
suggested_post_approval_failed?: SuggestedPostApprovalFailed;

Optional. Service message: approval of a suggested post has failed

suggested_post_approvedproperty#
suggested_post_approved?: SuggestedPostApproved;

Optional. Service message: a suggested post was approved

suggested_post_declinedproperty#
suggested_post_declined?: SuggestedPostDeclined;

Optional. Service message: a suggested post was declined

suggested_post_infoproperty#
suggested_post_info?: SuggestedPostInfo;

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

suggested_post_paidproperty#
suggested_post_paid?: SuggestedPostPaid;

Optional. Service message: payment for a suggested post was received

suggested_post_refundedproperty#
suggested_post_refunded?: SuggestedPostRefunded;

Optional. Service message: payment for a suggested post was refunded

supergroup_chat_createdproperty#
supergroup_chat_created?: boolean;

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

textproperty#
text?: string;

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

unique_giftproperty#
unique_gift?: UniqueGiftInfo;

Optional. Service message: a unique gift was sent or received

users_sharedproperty#
users_shared?: UsersShared;

Optional. Service message: users were shared with the bot

venueproperty#
venue?: Venue;

Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set.

via_botproperty#
via_bot?: User;

Optional. Bot through which the message was sent

video_chat_endedproperty#
video_chat_ended?: VideoChatEnded;

Optional. Service message: video chat ended

video_chat_participants_invitedproperty#
video_chat_participants_invited?: VideoChatParticipantsInvited;

Optional. Service message: new participants invited to a video chat

video_chat_scheduledproperty#
video_chat_scheduled?: VideoChatScheduled;

Optional. Service message: video chat scheduled

video_chat_startedproperty#
video_chat_started?: VideoChatStarted;

Optional. Service message: video chat started

video_noteproperty#
video_note?: VideoNote;

Optional. Message is a video note, information about the video message

videoproperty#
video?: Video;

Optional. Message is a video, information about the video

voiceproperty#
voice?: Voice;

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

web_app_dataproperty#
web_app_data?: WebAppData;

Optional. Service message: data sent by a Web App

write_access_allowedproperty#
write_access_allowed?: WriteAccessAllowed;

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