Interface Message

This object represents a message.

interface Message {
    animation?: Animation;
    audio?: Audio;
    author_signature?: string;
    boost_added?: ChatBoostAdded;
    business_connection_id?: string;
    caption?: string;
    caption_entities?: MessageEntity[];
    channel_chat_created?: true;
    chat: Chat;
    chat_background_set?: ChatBackground;
    chat_shared?: ChatShared;
    connected_website?: string;
    contact?: Contact;
    date: number;
    delete_chat_photo?: true;
    dice?: Dice;
    document?: Document;
    edit_date?: number;
    effect_id?: string;
    entities?: MessageEntity[];
    external_reply?: ExternalReplyInfo;
    forum_topic_closed?: ForumTopicClosed;
    forum_topic_created?: ForumTopicCreated;
    forum_topic_edited?: ForumTopicEdited;
    forum_topic_reopened?: ForumTopicReopened;
    forward_origin?: MessageOrigin;
    from?: User;
    game?: Game;
    general_forum_topic_hidden?: GeneralForumTopicHidden;
    general_forum_topic_unhidden?: GeneralForumTopicUnhidden;
    giveaway?: Giveaway;
    giveaway_completed?: GiveawayCompleted;
    giveaway_created?: GiveawayCreated;
    giveaway_winners?: GiveawayWinners;
    group_chat_created?: true;
    has_media_spoiler?: true;
    has_protected_content?: true;
    invoice?: Invoice;
    is_automatic_forward?: true;
    is_from_offline?: true;
    is_topic_message?: boolean;
    left_chat_member?: User;
    link_preview_options?: LinkPreviewOptions;
    location?: Location;
    media_group_id?: string;
    message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged;
    message_id: number;
    message_thread_id?: number;
    migrate_from_chat_id?: number;
    migrate_to_chat_id?: number;
    new_chat_members?: User[];
    new_chat_photo?: PhotoSize[];
    new_chat_title?: string;
    paid_media?: PaidMediaInfo;
    passport_data?: PassportData;
    photo?: PhotoSize[];
    pinned_message?: MaybeInaccessibleMessage;
    poll?: Poll;
    proximity_alert_triggered?: ProximityAlertTriggered;
    quote?: TextQuote;
    refunded_payment?: RefundedPayment;
    reply_markup?: InlineKeyboardMarkup;
    reply_to_message?: ReplyMessage;
    reply_to_story?: Story;
    sender_boost_count?: number;
    sender_business_bot?: User;
    sender_chat?: Chat;
    show_caption_above_media?: true;
    sticker?: Sticker;
    story?: Story;
    successful_payment?: SuccessfulPayment;
    supergroup_chat_created?: true;
    text?: string;
    users_shared?: UsersShared;
    venue?: Venue;
    via_bot?: User;
    video?: Video;
    video_chat_ended?: VideoChatEnded;
    video_chat_participants_invited?: VideoChatParticipantsInvited;
    video_chat_scheduled?: VideoChatScheduled;
    video_chat_started?: VideoChatStarted;
    video_note?: VideoNote;
    voice?: Voice;
    web_app_data?: WebAppData;
    write_access_allowed?: WriteAccessAllowed;
}

Hierarchy (view full)

Properties

animation? audio? author_signature? boost_added? business_connection_id? caption? caption_entities? channel_chat_created? chat chat_background_set? chat_shared? connected_website? contact? date delete_chat_photo? dice? document? edit_date? effect_id? entities? external_reply? forum_topic_closed? forum_topic_created? forum_topic_edited? forum_topic_reopened? forward_origin? from? game? general_forum_topic_hidden? general_forum_topic_unhidden? giveaway? giveaway_completed? giveaway_created? giveaway_winners? group_chat_created? has_media_spoiler? has_protected_content? invoice? is_automatic_forward? is_from_offline? is_topic_message? left_chat_member? link_preview_options? location? media_group_id? message_auto_delete_timer_changed? message_id message_thread_id? migrate_from_chat_id? migrate_to_chat_id? new_chat_members? new_chat_photo? new_chat_title? paid_media? passport_data? photo? pinned_message? poll? proximity_alert_triggered? quote? refunded_payment? reply_markup? reply_to_message? reply_to_story? sender_boost_count? sender_business_bot? sender_chat? show_caption_above_media? sticker? story? successful_payment? supergroup_chat_created? text? users_shared? venue? via_bot? video? video_chat_ended? video_chat_participants_invited? video_chat_scheduled? video_chat_started? video_note? voice? web_app_data? write_access_allowed?

Properties

Optional animation

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

Optional audio

audio?: Audio

Message is an audio file, information about the file

Optional author_signature

author_signature?: string

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

Optional boost_added

boost_added?: ChatBoostAdded

Service message: user boosted the chat

Optional business_connection_id

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.

Optional caption

caption?: string

Caption for the animation, audio, document, photo, video or voice

Optional caption_entities

caption_entities?: MessageEntity[]

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

Optional channel_chat_created

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.

chat

chat: Chat

Chat the message belongs to

Optional chat_background_set

chat_background_set?: ChatBackground

Optional chat_shared

chat_shared?: ChatShared

Service message: a chat was shared with the bot

Optional connected_website

connected_website?: string

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

Optional contact

contact?: Contact

Message is a shared contact, information about the contact

date

date: number

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

Optional delete_chat_photo

delete_chat_photo?: true

Service message: the chat photo was deleted

Optional dice

dice?: Dice

Message is a dice with random value

Optional document

document?: Document

Message is a general file, information about the file

Optional edit_date

edit_date?: number

Date the message was last edited in Unix time

Optional effect_id

effect_id?: string

Unique identifier of the message effect added to the message

Optional entities

entities?: MessageEntity[]

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

Optional external_reply

external_reply?: ExternalReplyInfo

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

Optional forum_topic_closed

forum_topic_closed?: ForumTopicClosed

Service message: forum topic closed

Optional forum_topic_created

forum_topic_created?: ForumTopicCreated

Service message: forum topic created

Optional forum_topic_edited

forum_topic_edited?: ForumTopicEdited

Service message: forum topic edited

Optional forum_topic_reopened

forum_topic_reopened?: ForumTopicReopened

Service message: forum topic reopened

Optional forward_origin

forward_origin?: MessageOrigin

Information about the original message for forwarded messages

Optional from

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

Optional game

game?: Game

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

Optional general_forum_topic_hidden

general_forum_topic_hidden?: GeneralForumTopicHidden

Service message: the 'General' forum topic hidden

Optional general_forum_topic_unhidden

general_forum_topic_unhidden?: GeneralForumTopicUnhidden

Service message: the 'General' forum topic unhidden

Optional giveaway

giveaway?: Giveaway

The message is a scheduled giveaway message

Optional giveaway_completed

giveaway_completed?: GiveawayCompleted

Service message: a giveaway without public winners was completed

Optional giveaway_created

giveaway_created?: GiveawayCreated

Service message: a scheduled giveaway was created

Optional giveaway_winners

giveaway_winners?: GiveawayWinners

A giveaway with public winners was completed

Optional group_chat_created

group_chat_created?: true

Service message: the group has been created

Optional has_media_spoiler

has_media_spoiler?: true

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

Optional has_protected_content

has_protected_content?: true

True, if the message can't be forwarded

Optional invoice

invoice?: Invoice

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

Optional is_automatic_forward

is_automatic_forward?: true

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

Optional is_from_offline

is_from_offline?: true

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

Optional is_topic_message

is_topic_message?: boolean

True, if the message is sent to a forum topic

Optional left_chat_member

left_chat_member?: User

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

Optional link_preview_options

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

Optional location

location?: Location

Message is a shared location, information about the location

Optional media_group_id

media_group_id?: string

The unique identifier of a media message group this message belongs to

Optional message_auto_delete_timer_changed

message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged

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

message_id

message_id: number

Unique message identifier inside this chat

Optional message_thread_id

message_thread_id?: number

Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only

Optional migrate_from_chat_id

migrate_from_chat_id?: number

The supergroup has been migrated from a group with the specified identifier.

Optional migrate_to_chat_id

migrate_to_chat_id?: number

The group has been migrated to a supergroup with the specified identifier.

Optional new_chat_members

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)

Optional new_chat_photo

new_chat_photo?: PhotoSize[]

A chat photo was change to this value

Optional new_chat_title

new_chat_title?: string

A chat title was changed to this value

Optional paid_media

paid_media?: PaidMediaInfo

Message contains paid media; information about the paid media

Optional passport_data

passport_data?: PassportData

Telegram Passport data

Optional photo

photo?: PhotoSize[]

Message is a photo, available sizes of the photo

Optional pinned_message

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.

Optional poll

poll?: Poll

Message is a native poll, information about the poll

Optional proximity_alert_triggered

proximity_alert_triggered?: ProximityAlertTriggered

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

Optional quote

quote?: TextQuote

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

Optional refunded_payment

refunded_payment?: RefundedPayment

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

Optional reply_markup

reply_markup?: InlineKeyboardMarkup

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

Optional reply_to_message

reply_to_message?: ReplyMessage

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.

Optional reply_to_story

reply_to_story?: Story

For replies to a story, the original message

Optional sender_boost_count

sender_boost_count?: number

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

Optional sender_business_bot

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.

Optional sender_chat

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.

Optional show_caption_above_media

show_caption_above_media?: true

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

Optional sticker

sticker?: Sticker

Message is a sticker, information about the sticker

Optional story

story?: Story

Message is a forwarded story

Optional successful_payment

successful_payment?: SuccessfulPayment

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

Optional supergroup_chat_created

supergroup_chat_created?: true

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.

Optional text

text?: string

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

Optional users_shared

users_shared?: UsersShared

Service message: users were shared with the bot

Optional venue

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

Optional via_bot

via_bot?: User

Bot through which the message was sent

Optional video

video?: Video

Message is a video, information about the video

Optional video_chat_ended

video_chat_ended?: VideoChatEnded

Service message: video chat ended

Optional video_chat_participants_invited

video_chat_participants_invited?: VideoChatParticipantsInvited

Service message: new participants invited to a video chat

Optional video_chat_scheduled

video_chat_scheduled?: VideoChatScheduled

Service message: video chat scheduled

Optional video_chat_started

video_chat_started?: VideoChatStarted

Service message: video chat started

Optional video_note

video_note?: VideoNote

Message is a video note, information about the video message

Optional voice

voice?: Voice

Message is a voice message, information about the file

Optional web_app_data

web_app_data?: WebAppData

Service message: data sent by a Web App

Optional write_access_allowed

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

Settings

Member Visibility

Theme

On This Page

animationaudioauthor_signatureboost_addedbusiness_connection_idcaptioncaption_entitieschannel_chat_createdchatchat_background_setchat_sharedconnected_websitecontactdatedelete_chat_photodicedocumentedit_dateeffect_identitiesexternal_replyforum_topic_closedforum_topic_createdforum_topic_editedforum_topic_reopenedforward_originfromgamegeneral_forum_topic_hiddengeneral_forum_topic_unhiddengiveawaygiveaway_completedgiveaway_createdgiveaway_winnersgroup_chat_createdhas_media_spoilerhas_protected_contentinvoiceis_automatic_forwardis_from_offlineis_topic_messageleft_chat_memberlink_preview_optionslocationmedia_group_idmessage_auto_delete_timer_changedmessage_idmessage_thread_idmigrate_from_chat_idmigrate_to_chat_idnew_chat_membersnew_chat_photonew_chat_titlepaid_mediapassport_dataphotopinned_messagepollproximity_alert_triggeredquoterefunded_paymentreply_markupreply_to_messagereply_to_storysender_boost_countsender_business_botsender_chatshow_caption_above_mediastickerstorysuccessful_paymentsupergroup_chat_createdtextusers_sharedvenuevia_botvideovideo_chat_endedvideo_chat_participants_invitedvideo_chat_scheduledvideo_chat_startedvideo_notevoiceweb_app_datawrite_access_allowed