telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface Message

    Telegram Bot API: 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?: boolean;
        chat: Chat;
        chat_background_set?: ChatBackground;
        chat_owner_changed?: ChatOwnerChanged;
        chat_owner_left?: ChatOwnerLeft;
        chat_shared?: ChatShared;
        checklist?: Checklist;
        checklist_tasks_added?: ChecklistTasksAdded;
        checklist_tasks_done?: ChecklistTasksDone;
        community_chat_added?: CommunityChatAdded;
        community_chat_joined?: CommunityChatJoined;
        community_chat_removed?: CommunityChatRemoved;
        connected_website?: string;
        contact?: Contact;
        date: number;
        delete_chat_photo?: boolean;
        dice?: Dice;
        direct_message_price_changed?: DirectMessagePriceChanged;
        direct_messages_topic?: DirectMessagesTopic;
        document?: Document;
        edit_date?: number;
        effect_id?: string;
        entities?: MessageEntity[];
        ephemeral_message_id?: number;
        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;
        gift?: GiftInfo;
        gift_upgrade_sent?: GiftInfo;
        giveaway?: Giveaway;
        giveaway_completed?: GiveawayCompleted;
        giveaway_created?: GiveawayCreated;
        giveaway_winners?: GiveawayWinners;
        group_chat_created?: boolean;
        guest_bot_caller_chat?: Chat;
        guest_bot_caller_user?: User;
        guest_query_id?: string;
        has_media_spoiler?: boolean;
        has_protected_content?: boolean;
        invoice?: Invoice;
        is_automatic_forward?: boolean;
        is_from_offline?: boolean;
        is_paid_post?: boolean;
        is_topic_message?: boolean;
        left_chat_member?: User;
        link_preview_options?: LinkPreviewOptions;
        live_photo?: LivePhoto;
        location?: Location;
        managed_bot_created?: ManagedBotCreated;
        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;
        paid_message_price_changed?: PaidMessagePriceChanged;
        paid_star_count?: number;
        passport_data?: PassportData;
        photo?: PhotoSize[];
        pinned_message?: Message;
        poll?: Poll;
        poll_option_added?: PollOptionAdded;
        poll_option_deleted?: PollOptionDeleted;
        proximity_alert_triggered?: ProximityAlertTriggered;
        quote?: TextQuote;
        receiver_user?: User;
        refunded_payment?: RefundedPayment;
        reply_markup?: InlineKeyboardMarkup;
        reply_to_checklist_task_id?: number;
        reply_to_message?: Message;
        reply_to_poll_option_id?: string;
        reply_to_story?: Story;
        rich_message?: RichMessage;
        sender_boost_count?: number;
        sender_business_bot?: User;
        sender_chat?: Chat;
        sender_tag?: string;
        show_caption_above_media?: boolean;
        sticker?: Sticker;
        story?: Story;
        successful_payment?: SuccessfulPayment;
        suggested_post_approval_failed?: SuggestedPostApprovalFailed;
        suggested_post_approved?: SuggestedPostApproved;
        suggested_post_declined?: SuggestedPostDeclined;
        suggested_post_info?: SuggestedPostInfo;
        suggested_post_paid?: SuggestedPostPaid;
        suggested_post_refunded?: SuggestedPostRefunded;
        supergroup_chat_created?: boolean;
        text?: string;
        unique_gift?: UniqueGiftInfo;
        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;
    }
    Index
    animation? audio? author_signature? boost_added? business_connection_id? caption? caption_entities? channel_chat_created? chat chat_background_set? chat_owner_changed? chat_owner_left? chat_shared? checklist? checklist_tasks_added? checklist_tasks_done? community_chat_added? community_chat_joined? community_chat_removed? connected_website? contact? date delete_chat_photo? dice? direct_message_price_changed? direct_messages_topic? document? edit_date? effect_id? entities? ephemeral_message_id? 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? gift? gift_upgrade_sent? giveaway? giveaway_completed? giveaway_created? giveaway_winners? group_chat_created? guest_bot_caller_chat? guest_bot_caller_user? guest_query_id? has_media_spoiler? has_protected_content? invoice? is_automatic_forward? is_from_offline? is_paid_post? is_topic_message? left_chat_member? link_preview_options? live_photo? location? managed_bot_created? 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? paid_message_price_changed? paid_star_count? passport_data? photo? pinned_message? poll? poll_option_added? poll_option_deleted? proximity_alert_triggered? quote? receiver_user? refunded_payment? reply_markup? reply_to_checklist_task_id? reply_to_message? reply_to_poll_option_id? reply_to_story? rich_message? sender_boost_count? sender_business_bot? sender_chat? sender_tag? show_caption_above_media? sticker? story? successful_payment? suggested_post_approval_failed? suggested_post_approved? suggested_post_declined? suggested_post_info? suggested_post_paid? suggested_post_refunded? supergroup_chat_created? text? unique_gift? 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?
    animation?: Animation

    Message is an animation, information about the animation.

    audio?: Audio

    Message is an audio file, information about the file.

    author_signature?: string

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

    boost_added?: ChatBoostAdded

    Service message: user boosted the chat.

    business_connection_id?: string

    Unique identifier of the business connection from which the message was received.

    caption?: string

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

    caption_entities?: MessageEntity[]

    For messages with a caption, special entities like substrings that appear in the caption.

    channel_chat_created?: boolean

    Service message: the channel has been created.

    chat: Chat

    Chat the message belongs to.

    chat_background_set?: ChatBackground

    Service message: chat background set.

    chat_owner_changed?: ChatOwnerChanged

    Service message: chat owner has changed.

    chat_owner_left?: ChatOwnerLeft

    Service message: chat owner has left.

    chat_shared?: ChatShared

    Service message: a chat was shared with the bot.

    checklist?: Checklist

    Message is a checklist.

    checklist_tasks_added?: ChecklistTasksAdded

    Service message: tasks were added to a checklist.

    checklist_tasks_done?: ChecklistTasksDone

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

    community_chat_added?: CommunityChatAdded

    Service message: chat or bot added to a Community.

    community_chat_joined?: CommunityChatJoined

    Service message: a user joined the chat from a community (Bot API 10.3+).

    community_chat_removed?: CommunityChatRemoved

    Service message: chat or bot removed from a Community.

    connected_website?: string

    The domain name of the website on which the user has logged in.

    contact?: Contact

    Message is a shared contact, information about the contact.

    date: number

    Date the message was sent in Unix time.

    delete_chat_photo?: boolean

    Service message: the chat photo was deleted.

    dice?: Dice

    Message is a dice with random value.

    direct_message_price_changed?: DirectMessagePriceChanged

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

    direct_messages_topic?: DirectMessagesTopic

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

    document?: Document

    Message is a general file, information about the file.

    edit_date?: number

    Date the message was last edited in Unix time.

    effect_id?: string

    Unique identifier of the message effect added to the message.

    entities?: MessageEntity[]

    For text messages, special entities like substrings that appear in the text.

    ephemeral_message_id?: number

    Ephemeral message identifier.

    external_reply?: ExternalReplyInfo

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

    forum_topic_closed?: ForumTopicClosed

    Service message: forum topic closed.

    forum_topic_created?: ForumTopicCreated

    Service message: forum topic created.

    forum_topic_edited?: ForumTopicEdited

    Service message: forum topic edited.

    forum_topic_reopened?: ForumTopicReopened

    Service message: forum topic reopened.

    forward_origin?: MessageOrigin

    Information about the original message for forwarded messages.

    from?: User

    Sender of the message; empty for messages sent to channels.

    game?: Game

    Message is a game, information about the game.

    general_forum_topic_hidden?: GeneralForumTopicHidden

    Service message: the 'General' forum topic hidden.

    general_forum_topic_unhidden?: GeneralForumTopicUnhidden

    Service message: the 'General' forum topic unhidden.

    gift?: GiftInfo

    Service message: a regular gift was sent or received.

    gift_upgrade_sent?: GiftInfo

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

    giveaway?: Giveaway

    The message is a scheduled giveaway.

    giveaway_completed?: GiveawayCompleted

    Service message: a giveaway without public winners was completed.

    giveaway_created?: GiveawayCreated

    Service message: a scheduled giveaway was created.

    giveaway_winners?: GiveawayWinners

    A giveaway with public winners was completed.

    group_chat_created?: boolean

    Service message: the group has been created.

    guest_bot_caller_chat?: Chat

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

    guest_bot_caller_user?: User

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

    guest_query_id?: string

    The unique identifier for the guest query, usable with the method answerGuestQuery.

    has_media_spoiler?: boolean

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

    Optionalhas_protected_content

    has_protected_content?: boolean

    True, if the message can't be forwarded.

    invoice?: Invoice

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

    is_automatic_forward?: boolean

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

    is_from_offline?: boolean

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

    Optionalis_paid_post

    is_paid_post?: boolean

    True, if the message is a paid post.

    is_topic_message?: boolean

    True, if the message is sent to a forum topic.

    left_chat_member?: User

    A member was removed in the group, information about them.

    link_preview_options?: LinkPreviewOptions

    Options used for link preview generation for the message.

    live_photo?: LivePhoto

    Live photo attachment.

    location?: Location

    Message is a shared location, information about the location.

    managed_bot_created?: ManagedBotCreated

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

    media_group_id?: string

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

    message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged

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

    message_id: number

    Unique message identifier inside this chat.

    message_thread_id?: number

    Unique identifier of a message thread to which the message belongs; for supergroups only.

    migrate_from_chat_id?: number

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

    migrate_to_chat_id?: number

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

    new_chat_members?: User[]

    New members that were added to the group or supergroup and information about them.

    new_chat_photo?: PhotoSize[]

    A chat photo was change to this value.

    new_chat_title?: string

    A chat title was changed to this value.

    paid_media?: PaidMediaInfo

    Message contains paid media; information about the paid media.

    paid_message_price_changed?: PaidMessagePriceChanged

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

    paid_star_count?: number

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

    passport_data?: PassportData

    Telegram Passport data.

    photo?: PhotoSize[]

    Message is a photo, available sizes of the photo.

    pinned_message?: Message

    Specified message was pinned.

    poll?: Poll

    Message is a native poll, information about the poll.

    poll_option_added?: PollOptionAdded

    Service message: answer option was added to a poll.

    poll_option_deleted?: PollOptionDeleted

    Service message: answer option was deleted from a poll.

    proximity_alert_triggered?: ProximityAlertTriggered

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

    quote?: TextQuote

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

    receiver_user?: User

    Receiver user of an ephemeral message.

    refunded_payment?: RefundedPayment

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

    reply_markup?: InlineKeyboardMarkup

    Inline keyboard attached to the message.

    reply_to_checklist_task_id?: number

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

    reply_to_message?: Message

    For replies in the same chat and message thread, the original message.

    reply_to_poll_option_id?: string

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

    Optionalreply_to_story

    reply_to_story?: Story

    For replies to a story, the original story.

    rich_message?: RichMessage

    Rich formatted message content.

    sender_boost_count?: number

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

    sender_business_bot?: User

    The bot that actually sent the message on behalf of the business account.

    sender_chat?: Chat

    Sender of the message, sent on behalf of a chat.

    sender_tag?: string

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

    show_caption_above_media?: boolean

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

    sticker?: Sticker

    Message is a sticker, information about the sticker.

    Optionalstory

    story?: Story

    Message is a forwarded story, information about the story.

    successful_payment?: SuccessfulPayment

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

    Optionalsuggested_post_approval_failed

    suggested_post_approval_failed?: SuggestedPostApprovalFailed

    Service message: approval of a suggested post has failed.

    Optionalsuggested_post_approved

    suggested_post_approved?: SuggestedPostApproved

    Service message: a suggested post was approved.

    Optionalsuggested_post_declined

    suggested_post_declined?: SuggestedPostDeclined

    Service message: a suggested post was declined.

    Optionalsuggested_post_info

    suggested_post_info?: SuggestedPostInfo

    Information about suggested post parameters if the message is a suggested post in a channel direct messages chat.

    Optionalsuggested_post_paid

    suggested_post_paid?: SuggestedPostPaid

    Service message: payment for a suggested post was received.

    Optionalsuggested_post_refunded

    suggested_post_refunded?: SuggestedPostRefunded

    Service message: payment for a suggested post was refunded.

    supergroup_chat_created?: boolean

    Service message: the supergroup has been created.

    Optionaltext

    text?: string

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

    unique_gift?: UniqueGiftInfo

    Service message: a unique gift was sent or received.

    users_shared?: UsersShared

    Service message: users were shared with the bot.

    venue?: Venue

    Message is a venue, information about the venue.

    via_bot?: User

    Bot through which the message was sent.

    video?: Video

    Message is a video, information about the video.

    video_chat_ended?: VideoChatEnded

    Service message: video chat ended.

    video_chat_participants_invited?: VideoChatParticipantsInvited

    Service message: new participants invited to a video chat.

    video_chat_scheduled?: VideoChatScheduled

    Service message: video chat scheduled.

    video_chat_started?: VideoChatStarted

    Service message: video chat started.

    video_note?: VideoNote

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

    voice?: Voice

    Message is a voice message, information about the file.

    web_app_data?: WebAppData

    Service message: data sent by a Web App to the bot.

    write_access_allowed?: WriteAccessAllowed

    Service message: the user allowed the bot to write messages after adding it to the attachment menu.

    Settings
    Member Visibility

    On This Page
    Properties
    animationaudioauthor_signatureboost_addedbusiness_connection_idcaptioncaption_entitieschannel_chat_createdchatchat_background_setchat_owner_changedchat_owner_leftchat_sharedchecklistchecklist_tasks_addedchecklist_tasks_donecommunity_chat_addedcommunity_chat_joinedcommunity_chat_removedconnected_websitecontactdatedelete_chat_photodicedirect_message_price_changeddirect_messages_topicdocumentedit_dateeffect_identitiesephemeral_message_idexternal_replyforum_topic_closedforum_topic_createdforum_topic_editedforum_topic_reopenedforward_originfromgamegeneral_forum_topic_hiddengeneral_forum_topic_unhiddengiftgift_upgrade_sentgiveawaygiveaway_completedgiveaway_createdgiveaway_winnersgroup_chat_createdguest_bot_caller_chatguest_bot_caller_userguest_query_idhas_media_spoilerhas_protected_contentinvoiceis_automatic_forwardis_from_offlineis_paid_postis_topic_messageleft_chat_memberlink_preview_optionslive_photolocationmanaged_bot_createdmedia_group_idmessage_auto_delete_timer_changedmessage_idmessage_thread_idmigrate_from_chat_idmigrate_to_chat_idnew_chat_membersnew_chat_photonew_chat_titlepaid_mediapaid_message_price_changedpaid_star_countpassport_dataphotopinned_messagepollpoll_option_addedpoll_option_deletedproximity_alert_triggeredquotereceiver_userrefunded_paymentreply_markupreply_to_checklist_task_idreply_to_messagereply_to_poll_option_idreply_to_storyrich_messagesender_boost_countsender_business_botsender_chatsender_tagshow_caption_above_mediastickerstorysuccessful_paymentsuggested_post_approval_failedsuggested_post_approvedsuggested_post_declinedsuggested_post_infosuggested_post_paidsuggested_post_refundedsupergroup_chat_createdtextunique_giftusers_sharedvenuevia_botvideovideo_chat_endedvideo_chat_participants_invitedvideo_chat_scheduledvideo_chat_startedvideo_notevoiceweb_app_datawrite_access_allowed