ultra-telegram-framework
    Preparing search index...

    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?: 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;
        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[];
        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?: MaybeInaccessibleMessage;
        poll?: Poll;
        poll_option_added?: PollOptionAdded;
        poll_option_deleted?: PollOptionDeleted;
        proximity_alert_triggered?: ProximityAlertTriggered;
        quote?: TextQuote;
        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;
        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

    Properties

    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? connected_website? contact? date delete_chat_photo? dice? direct_message_price_changed? direct_messages_topic? 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? 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? refunded_payment? reply_markup? reply_to_checklist_task_id? reply_to_message? reply_to_poll_option_id? reply_to_story? 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?

    Properties

    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

    audio?: Audio

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

    author_signature?: string

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

    boost_added?: ChatBoostAdded

    Optional. Service message: user boosted the chat

    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?: string

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

    caption_entities?: MessageEntity[]

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

    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: Chat

    Chat the message belongs to

    chat_background_set?: ChatBackground

    Optional. Service message: chat background set

    chat_owner_changed?: ChatOwnerChanged

    Optional. Service message: chat owner has changed

    chat_owner_left?: ChatOwnerLeft

    Optional. Service message: chat owner has left

    chat_shared?: ChatShared

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

    checklist?: Checklist

    Optional. Message is a checklist

    checklist_tasks_added?: ChecklistTasksAdded

    Optional. Service message: tasks were added to a checklist

    checklist_tasks_done?: ChecklistTasksDone

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

    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

    contact?: Contact

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

    date: number

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

    delete_chat_photo?: boolean

    Optional. Service message: the chat photo was deleted

    dice?: Dice

    Optional. Message is a dice with random value

    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_topic?: DirectMessagesTopic

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

    document?: Document

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

    edit_date?: number

    Optional. Date the message was last edited in Unix time

    effect_id?: string

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

    entities?: MessageEntity[]

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

    external_reply?: ExternalReplyInfo

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

    forum_topic_closed?: ForumTopicClosed

    Optional. Service message: forum topic closed

    forum_topic_created?: ForumTopicCreated

    Optional. Service message: forum topic created

    forum_topic_edited?: ForumTopicEdited

    Optional. Service message: forum topic edited

    forum_topic_reopened?: ForumTopicReopened

    Optional. Service message: forum topic reopened

    forward_origin?: MessageOrigin

    Optional. Information about the original message for forwarded messages

    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

    game?: Game

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

    general_forum_topic_hidden?: GeneralForumTopicHidden

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

    general_forum_topic_unhidden?: GeneralForumTopicUnhidden

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

    gift?: GiftInfo

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

    gift_upgrade_sent?: GiftInfo

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

    giveaway?: Giveaway

    Optional. The message is a scheduled giveaway message

    giveaway_completed?: GiveawayCompleted

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

    giveaway_created?: GiveawayCreated

    Optional. Service message: a scheduled giveaway was created

    giveaway_winners?: GiveawayWinners

    Optional. A giveaway with public winners was completed

    group_chat_created?: boolean

    Optional. Service message: the group has been created

    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_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_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_spoiler?: boolean

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

    Optionalhas_protected_content

    has_protected_content?: boolean

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

    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_forward?: boolean

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

    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

    Optionalis_paid_post

    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_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_member?: User

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

    link_preview_options?: LinkPreviewOptions

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

    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

    location?: Location

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

    managed_bot_created?: ManagedBotCreated

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

    media_group_id?: string

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

    message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged

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

    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_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_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_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_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_photo?: PhotoSize[]

    Optional. A chat photo was change to this value

    new_chat_title?: string

    Optional. A chat title was changed to this value

    paid_media?: PaidMediaInfo

    Optional. Message contains paid media; information about the paid media

    paid_message_price_changed?: PaidMessagePriceChanged

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

    paid_star_count?: number

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

    passport_data?: PassportData

    Optional. Telegram Passport data

    photo?: PhotoSize[]

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

    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?: Poll

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

    poll_option_added?: PollOptionAdded

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

    poll_option_deleted?: PollOptionDeleted

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

    proximity_alert_triggered?: ProximityAlertTriggered

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

    quote?: TextQuote

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

    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_markup?: InlineKeyboardMarkup

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

    reply_to_checklist_task_id?: number

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

    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_id?: string

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

    Optionalreply_to_story

    reply_to_story?: Story

    Optional. For replies to a story, the original story

    sender_boost_count?: number

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

    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_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_tag?: string

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

    show_caption_above_media?: boolean

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

    sticker?: Sticker

    Optional. Message is a sticker, information about the sticker

    Optionalstory

    story?: Story

    Optional. Message is a forwarded story

    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

    Optionalsuggested_post_approval_failed

    suggested_post_approval_failed?: SuggestedPostApprovalFailed

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

    Optionalsuggested_post_approved

    suggested_post_approved?: SuggestedPostApproved

    Optional. Service message: a suggested post was approved

    Optionalsuggested_post_declined

    suggested_post_declined?: SuggestedPostDeclined

    Optional. Service message: a suggested post was declined

    Optionalsuggested_post_info

    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.

    Optionalsuggested_post_paid

    suggested_post_paid?: SuggestedPostPaid

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

    Optionalsuggested_post_refunded

    suggested_post_refunded?: SuggestedPostRefunded

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

    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.

    Optionaltext

    text?: string

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

    unique_gift?: UniqueGiftInfo

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

    users_shared?: UsersShared

    Optional. Service message: users were shared with the bot

    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_bot?: User

    Optional. Bot through which the message was sent

    video?: Video

    Optional. Message is a video, information about the video

    video_chat_ended?: VideoChatEnded

    Optional. Service message: video chat ended

    video_chat_participants_invited?: VideoChatParticipantsInvited

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

    video_chat_scheduled?: VideoChatScheduled

    Optional. Service message: video chat scheduled

    video_chat_started?: VideoChatStarted

    Optional. Service message: video chat started

    video_note?: VideoNote

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

    voice?: Voice

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

    web_app_data?: WebAppData

    Optional. Service message: data sent by a Web App

    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

    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_doneconnected_websitecontactdatedelete_chat_photodicedirect_message_price_changeddirect_messages_topicdocumentedit_dateeffect_identitiesexternal_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_triggeredquoterefunded_paymentreply_markupreply_to_checklist_task_idreply_to_messagereply_to_poll_option_idreply_to_storysender_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