@telegraf/types

import type { Chat, File, Gift, UniqueGift, User } from "./manage.js"; import type { InlineKeyboardMarkup } from "./markup.js"; import type { PassportData } from "./passport.js"; import type { Invoice, RefundedPayment, SuccessfulPayment } from "./payment.js"; export declare namespace Message { interface ServiceMessage { /** Unique message identifier inside this chat */ message_id: number; /** Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only */ message_thread_id?: number; /** Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */ from?: User; /** Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */ sender_chat?: Chat; /** Date the message was sent in Unix time. It is always a positive number, representing a valid date. */ date: number; /** Chat the message belongs to */ chat: Chat; /** True, if the message is sent to a forum topic */ is_topic_message?: boolean; } interface CommonMessage extends ServiceMessage { /** If the sender of the message boosted the chat, the number of boosts added by the user */ sender_boost_count?: number; /** 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. */ business_connection_id?: string; /** Information about the original message for forwarded messages */ forward_origin?: MessageOrigin; /** True, if the message is a channel post that was automatically forwarded to the connected discussion group */ is_automatic_forward?: true; /** 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_message?: ReplyMessage; /** Information about the message that is being replied to, which may come from another chat or forum topic */ external_reply?: ExternalReplyInfo; /** For replies that quote part of the original message, the quoted part of the message */ quote?: TextQuote; /** For replies to a story, the original story */ reply_to_story?: Story; /** Bot through which the message was sent */ via_bot?: User; /** Date the message was last edited in Unix time */ edit_date?: number; /** True, if the message can't be forwarded */ has_protected_content?: 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 */ is_from_offline?: true; /** Signature of the post author for messages in channels, or the custom title of an anonymous group administrator */ author_signature?: string; /** The number of Telegram Stars that were paid by the sender of the message to send it */ paid_star_count?: number; /** Options used for link preview generation for the message, if it is a text message and link preview options were changed */ link_preview_options?: LinkPreviewOptions; /** Unique identifier of the message effect added to the message */ effect_id?: string; /** Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. */ reply_markup?: InlineKeyboardMarkup; } interface BusinessSentMessage { /** 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_business_bot?: User; } interface TextMessage extends CommonMessage { /** For text messages, the actual UTF-8 text of the message */ text: string; /** For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text */ entities?: MessageEntity[]; } interface CaptionableMessage extends CommonMessage { /** Caption for the animation, audio, document, photo, video or voice */ caption?: string; /** For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption */ caption_entities?: MessageEntity[]; } interface MediaMessage extends CaptionableMessage { /** The unique identifier of a media message group this message belongs to */ media_group_id?: string; /** True, if the message media is covered by a spoiler animation */ has_media_spoiler?: true; } interface AudioMessage extends MediaMessage { /** Message is an audio file, information about the file */ audio: Audio; } interface DocumentMessage extends MediaMessage { /** Message is a general file, information about the file */ document: Document; } interface PaidMediaMessage extends CaptionableMessage { /** Message contains paid media; information about the paid media */ paid_media: PaidMediaInfo; } interface AnimationMessage extends DocumentMessage { /** Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set */ animation: Animation; /** True, if the caption must be shown above the message media */ show_caption_above_media?: true; } interface PhotoMessage extends MediaMessage { /** Message is a photo, available sizes of the photo */ photo: PhotoSize[]; /** True, if the caption must be shown above the message media */ show_caption_above_media?: true; } interface StickerMessage extends CommonMessage { /** Message is a sticker, information about the sticker */ sticker: Sticker; } interface StoryMessage extends CommonMessage { /** Message is a forwarded story. Currently holds no information */ story: Story; } interface VideoMessage extends MediaMessage { /** Message is a video, information about the video */ video: Video; /** True, if the caption must be shown above the message media */ show_caption_above_media?: true; } interface VideoNoteMessage extends CommonMessage { /** Message is a video note, information about the video message */ video_note: VideoNote; } interface VoiceMessage extends CaptionableMessage { /** Message is a voice message, information about the file */ voice: Voice; } interface ContactMessage extends CommonMessage { /** Message is a shared contact, information about the contact */ contact: Contact; } interface DiceMessage extends CommonMessage { /** Message is a dice with random value */ dice: Dice; } interface GameMessage extends CommonMessage { /** Message is a game, information about the game. More about games » */ game: Game; } interface PollMessage extends CommonMessage { /** Message is a native poll, information about the poll */ poll: Poll; } interface LocationMessage extends CommonMessage { /** Message is a shared location, information about the location */ location: Location; } interface VenueMessage extends LocationMessage { /** Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set */ venue: Venue; } interface NewChatMembersMessage extends ServiceMessage { /** 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_members: User[]; } interface LeftChatMemberMessage extends ServiceMessage { /** A member was removed from the group, information about them (this member may be the bot itself) */ left_chat_member: User; } interface NewChatTitleMessage extends ServiceMessage { /** A chat title was changed to this value */ new_chat_title: string; } interface NewChatPhotoMessage extends ServiceMessage { /** A chat photo was change to this value */ new_chat_photo: PhotoSize[]; } interface DeleteChatPhotoMessage extends ServiceMessage { /** Service message: the chat photo was deleted */ delete_chat_photo: true; } interface GroupChatCreatedMessage extends ServiceMessage { /** Service message: the group has been created */ group_chat_created: true; } interface SupergroupChatCreated extends ServiceMessage { /** 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. */ supergroup_chat_created: true; } interface ChannelChatCreatedMessage extends ServiceMessage { /** 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. */ channel_chat_created: true; } interface MessageAutoDeleteTimerChangedMessage extends ServiceMessage { /** Service message: auto-delete timer settings changed in the chat */ message_auto_delete_timer_changed: MessageAutoDeleteTimerChanged; } interface MigrateToChatIdMessage extends ServiceMessage { /** The group has been migrated to a supergroup with the specified identifier. */ migrate_to_chat_id: number; } interface MigrateFromChatIdMessage extends ServiceMessage { /** The supergroup has been migrated from a group with the specified identifier. */ migrate_from_chat_id: number; } interface PinnedMessageMessage extends ServiceMessage { /** Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply. */ pinned_message: Omit<MaybeInaccessibleMessage, "reply_to_message">; } interface InvoiceMessage extends ServiceMessage { /** Message is an invoice for a payment, information about the invoice. */ invoice: Invoice; } interface SuccessfulPaymentMessage extends ServiceMessage { /** Message is a service message about a successful payment, information about the payment. */ successful_payment: SuccessfulPayment; } interface RefundedPaymentMessage extends ServiceMessage { /** Message is a service message about a refunded payment, information about the payment. */ refunded_payment: RefundedPayment; } interface UsersSharedMessage extends ServiceMessage { /** Service message: a user was shared with the bot */ users_shared: UsersShared; } interface ChatSharedMessage extends ServiceMessage { /** Service message: a chat was shared with the bot */ chat_shared: ChatShared; } interface GiftMessage extends ServiceMessage { /** Service message: a regular gift was sent or received */ gift: GiftInfo; } interface UniqueGiftMessage extends ServiceMessage { /** Service message: a unique gift was sent or received */ unique_gift: UniqueGiftInfo; } interface ConnectedWebsiteMessage extends ServiceMessage { /** The domain name of the website on which the user has logged in. More about Telegram Login » */ connected_website: string; } interface WriteAccessAllowedMessage extends ServiceMessage { /** Service message: the user allowed the bot added to the attachment menu to write messages */ write_access_allowed: WriteAccessAllowed; } interface PassportDataMessage extends ServiceMessage { /** Telegram Passport data */ passport_data: PassportData; } interface ProximityAlertTriggeredMessage extends ServiceMessage { /** Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. */ proximity_alert_triggered: ProximityAlertTriggered; } interface BoostAddedMessage extends ServiceMessage { /** Service message: user boosted the chat */ boost_added: ChatBoostAdded; } interface ChatBackgroundSetMessage extends ServiceMessage { /** Service message: chat background set */ chat_background_set: ChatBackground; } interface ForumTopicCreatedMessage extends ServiceMessage { /** Service message: forum topic created */ forum_topic_created: ForumTopicCreated; } interface ForumTopicEditedMessage extends ServiceMessage { /** Service message: forum topic edited */ forum_topic_edited: ForumTopicEdited; } interface ForumTopicClosedMessage extends ServiceMessage { /** Service message: forum topic closed */ forum_topic_closed: ForumTopicClosed; } interface ForumTopicReopenedMessage extends ServiceMessage { /** Service message: forum topic reopened */ forum_topic_reopened: ForumTopicReopened; } interface GeneralForumTopicHiddenMessage extends ServiceMessage { /** Service message: the 'General' forum topic hidden */ general_forum_topic_hidden: GeneralForumTopicHidden; } interface GeneralForumTopicUnhiddenMessage extends ServiceMessage { /** Service message: the 'General' forum topic unhidden */ general_forum_topic_unhidden: GeneralForumTopicUnhidden; } interface GiveawayCreatedMessage extends ServiceMessage { /** Service message: a scheduled giveaway was created */ giveaway_created: GiveawayCreated; } interface GiveawayMessage extends ServiceMessage { /** The message is a scheduled giveaway message */ giveaway: Giveaway; } interface GiveawayWinnersMessage extends ServiceMessage { /** A giveaway with public winners was completed */ giveaway_winners: GiveawayWinners; } interface GiveawayCompletedMessage extends ServiceMessage { /** Service message: a giveaway without public winners was completed */ giveaway_completed: GiveawayCompleted; } interface PaidMessagePriceChangedMessage extends ServiceMessage { /** Service message: the price for paid messages has changed in the chat */ paid_message_price_changed: PaidMessagePriceChanged; } interface VideoChatScheduledMessage extends ServiceMessage { /** Service message: video chat scheduled */ video_chat_scheduled: VideoChatScheduled; } interface VideoChatStartedMessage extends ServiceMessage { /** Service message: video chat started */ video_chat_started: VideoChatStarted; } interface VideoChatEndedMessage extends ServiceMessage { /** Service message: video chat ended */ video_chat_ended: VideoChatEnded; } interface VideoChatParticipantsInvitedMessage extends ServiceMessage { /** Service message: new participants invited to a video chat */ video_chat_participants_invited: VideoChatParticipantsInvited; } interface WebAppDataMessage extends ServiceMessage { /** Service message: data sent by a Web App */ web_app_data: WebAppData; } } /** Helper type that bundles all possible `Message.ServiceMessage`s. More specifically, bundles all messages that do not have a `reply_to_message` field, i.e. are not a `Message.CommonMessage`. */ export type ServiceMessageBundle = Message.NewChatMembersMessage | Message.LeftChatMemberMessage | Message.NewChatTitleMessage | Message.NewChatPhotoMessage | Message.DeleteChatPhotoMessage | Message.GroupChatCreatedMessage | Message.SupergroupChatCreated | Message.ChannelChatCreatedMessage | Message.MessageAutoDeleteTimerChangedMessage | Message.MigrateToChatIdMessage | Message.MigrateFromChatIdMessage | Message.PinnedMessageMessage | Message.InvoiceMessage | Message.SuccessfulPaymentMessage | Message.UsersSharedMessage | Message.ChatSharedMessage | Message.GiftMessage | Message.UniqueGiftMessage | Message.ConnectedWebsiteMessage | Message.WriteAccessAllowedMessage | Message.PassportDataMessage | Message.ProximityAlertTriggeredMessage | Message.BoostAddedMessage | Message.ForumTopicCreatedMessage | Message.ForumTopicEditedMessage | Message.ForumTopicClosedMessage | Message.ForumTopicReopenedMessage | Message.GeneralForumTopicHiddenMessage | Message.GeneralForumTopicUnhiddenMessage | Message.GiveawayCreatedMessage | Message.GiveawayMessage | Message.GiveawayWinnersMessage | Message.GiveawayCompletedMessage | Message.VideoChatScheduledMessage | Message.VideoChatStartedMessage | Message.VideoChatEndedMessage | Message.VideoChatParticipantsInvitedMessage | Message.WebAppDataMessage; /** Helper type that bundles all possible `Message.CommonMessage`s. More specifically, bundles all messages that do have a `reply_to_message` field, i.e. are a `Message.CommonMessage`. */ export type CommonMessageBundle = Message.AnimationMessage | Message.AudioMessage | Message.ContactMessage | Message.DiceMessage | Message.DocumentMessage | Message.GameMessage | Message.LocationMessage | Message.PhotoMessage | Message.PollMessage | Message.StickerMessage | Message.StoryMessage | Message.TextMessage | Message.VenueMessage | Message.VideoMessage | Message.VideoNoteMessage | Message.VoiceMessage; /** Helper type that represents a message which occurs in a `reply_to_message` field. */ type ReplyMessage = ServiceMessageBundle | (CommonMessageBundle & { reply_to_message: undefined; }); /** This object represents a message. */ export type Message = ServiceMessageBundle | CommonMessageBundle; /** This object represents a unique message identifier. */ export interface MessageId { /** Unique message identifier. 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_id: number; } /** This object describes a message that was deleted or is otherwise inaccessible to the bot. */ export interface InaccessibleMessage { /** Chat the message belonged to. */ chat: Chat; /** Unique message identifier inside the chat. */ message_id: number; /** Always 0. The field can be used to differentiate regular and inaccessible messages. */ date: 0; } /** This object describes a message that can be inaccessible to the bot. It can be one of - Message - InaccessibleMessage */ export type MaybeInaccessibleMessage = Message | InaccessibleMessage; /** Describes an inline message sent by a Web App on behalf of a user. */ export interface SentWebAppMessage { /** Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. */ inline_message_id: string; } /** Describes an inline message to be sent by a user of a Mini App. */ export interface PreparedInlineMessage { /** Unique identifier of the prepared message */ id: string; /** Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used */ expiration_date: number; } /** The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, spoiler text, block quotations as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use markdown-style or HTML-style formatting. Note that Telegram clients will display an **alert** to the user before opening an inline link ('Open this link?' together with the full URL). Message entities can be nested, providing following restrictions are met: - If two entities have common characters, then one of them is fully contained inside another. - bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code. - blockquote and expandable_blockquote entities can't be nested. - All other entities can't contain each other. Links `tg://user?id=<user_id>` can be used to mention a user by their identifier without using a username. Please note: - These links will work only if they are used inside an inline link or in an inline keyboard button. For example, they will not work, when used in a message text. - Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot. You can find the list of programming and markup languages for which syntax highlighting is supported at [libprisma#supported-languages](https://github.com/TelegramMessenger/libprisma#supported-languages). #### MarkdownV2 style To use this mode, pass *MarkdownV2* in the *parse_mode* field. Use the following syntax in your message: ``` *bold \*text* _italic \*text_ __underline__ ~strikethrough~ ||spoiler|| *bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold* [inline URL](http://www.example.com/) [inline mention of a user](tg://user?id=123456789) ![👍](tg://emoji?id=5368324170671202286) `inline fixed-width code` ``` pre-formatted fixed-width code block ``` ```python pre-formatted fixed-width code block written in the Python programming language ``` >Block quotation started >Block quotation continued >Block quotation continued >Block quotation continued >The last line of the block quotation **>The expandable block quotation started right after the previous block quotation >It is separated from the previous block quotation by an empty bold entity >Expandable block quotation continued >Hidden by default part of the expandable block quotation started >Expandable block quotation continued >The last line of the expandable block quotation with the expandability mark|| ``` Please note: - Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character. - Inside `pre` and `code` entities, all '`' and '\' characters must be escaped with a preceding '\' character. - Inside the `(...)` part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character. - In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'. In case of ambiguity between italic and underline entities __ is always greadily treated from left to right as beginning or end of an underline entity, so instead of ___italic underline___ use ___italic underline_**__, adding an empty bold entity as a separator. - A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker. - Custom emoji entities can only be used by bots that purchased additional usernames on Fragment. #### HTML style To use this mode, pass *HTML* in the *parse_mode* field. The following tags are currently supported: ```html bold, bold italic, italic underline, <ins>underline</ins> <s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del> spoiler, <tg-spoiler>spoiler</tg-spoiler> bold italic bold <s>italic bold strikethrough italic bold strikethrough spoiler</s> underline italic bold bold <a href="http://www.example.com/">inline URL</a> <a href="tg://user?id=123456789">inline mention of a user</a> <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji> <code>inline fixed-width code</code> <pre>pre-formatted fixed-width code block</pre> <pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre> <blockquote>Block quotation started\nBlock quotation continued\nThe last line of the block quotation</blockquote> <blockquote expandable>Expandable block quotation started\nExpandable block quotation continued\nExpandable block quotation continued\nHidden by default part of the block quotation started\nExpandable block quotation continued\nThe last line of the block quotation</blockquote> ``` Please note: - Only the tags mentioned above are currently supported. - All `<`, `>` and `&` symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (`<` with `<`, `>` with `>` and `&` with `&`). - All numerical HTML entities are supported. - The API currently supports only the following named HTML entities: `<`, `>`, `&` and `"`. - Use nested `pre` and `code` tags, to define programming language for pre entity. - Programming language can't be specified for standalone `code` tags. - A valid emoji must be used as the content of the tg-emoji tag. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker. - Custom emoji entities can only be used by bots that purchased additional usernames on Fragment. #### Markdown style This is a legacy mode, retained for backward compatibility. To use this mode, pass *Markdown* in the *parse_mode* field. Use the following syntax in your message: ``` *bold text* _italic text_ [inline URL](http://www.example.com/) [inline mention of a user](tg://user?id=123456789) `inline fixed-width code` ``` pre-formatted fixed-width code block ``` ```python pre-formatted fixed-width code block written in the Python programming language ``` ``` Please note: - Entities must not be nested, use parse mode MarkdownV2 instead. There is no way to specify “underline”, “strikethrough”, “spoiler”, “blockquote”, “expandable_blockquote” and “custom_emoji” entities, use parse mode MarkdownV2 instead. - To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them. - Escaping inside entities is not allowed, so entity must be closed first and reopened again: use `_snake_\__case_` for italic `snake_case` and `*2*\**2=4*` for bold `2*2=4`. */ export type ParseMode = "Markdown" | "MarkdownV2" | "HTML"; export declare namespace MessageEntity { interface Abstract { /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) */ type: string; /** Offset in UTF-16 code units to the start of the entity */ offset: number; /** Length of the entity in UTF-16 code units */ length: number; } interface Mention extends Abstract { type: "mention"; } interface Hashtag extends Abstract { type: "hashtag"; } interface Cashtag extends Abstract { type: "cashtag"; } interface BotCommand extends Abstract { type: "bot_command"; } interface Url extends Abstract { type: "url"; } interface Email extends Abstract { type: "email"; } interface PhoneNumber extends Abstract { type: "phone_number"; } interface Bold extends Abstract { type: "bold"; } interface Blockquote extends Abstract { type: "blockquote"; } interface ExpandableBlockquote extends Abstract { type: "expandable_blockquote"; } interface Italic extends Abstract { type: "italic"; } interface Underline extends Abstract { type: "underline"; } interface Strikethrough extends Abstract { type: "strikethrough"; } interface Spoiler extends Abstract { type: "spoiler"; } interface Code extends Abstract { type: "code"; } interface PreMessage extends Abstract { type: "pre"; /** For “pre” only, the programming language of the entity text */ language?: string; } interface TextLink extends Abstract { type: "text_link"; /** For “text_link” only, URL that will be opened after user taps on the text */ url: string; } interface TextMention extends Abstract { type: "text_mention"; /** For “text_mention” only, the mentioned user */ user: User; } interface CustomEmoji extends Abstract { type: "custom_emoji"; /** For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker */ custom_emoji_id: string; } } /** This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. */ export type MessageEntity = MessageEntity.Mention | MessageEntity.Hashtag | MessageEntity.Cashtag | MessageEntity.BotCommand | MessageEntity.Url | MessageEntity.Email | MessageEntity.PhoneNumber | MessageEntity.Bold | MessageEntity.Blockquote | MessageEntity.ExpandableBlockquote | MessageEntity.Italic | MessageEntity.Underline | MessageEntity.Strikethrough | MessageEntity.Spoiler | MessageEntity.Code | MessageEntity.PreMessage | MessageEntity.TextLink | MessageEntity.TextMention | MessageEntity.CustomEmoji; /** This object contains information about the quoted part of a message that is replied to by the given message. */ export interface TextQuote { /** Text of the quoted part of a message that is replied to by the given message */ text: string; /** Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. */ entities?: MessageEntity[]; /** Approximate quote position in the original message in UTF-16 code units as specified by the sender */ position: number; /** True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server. */ is_manual?: true; } /** Base properties shared by all ExternalReplyInfo variants */ export interface AbstractExternalReply { /** Origin of the message replied to by the given message */ origin: MessageOrigin; /** Chat the original message belongs to. Available only if the chat is a supergroup or a channel. */ chat?: Chat; /** Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. */ message_id?: number; /** Options used for link preview generation for the original message, if it is a text message */ link_preview_options?: LinkPreviewOptions; } /** Properties shared by Animation, Photo, and Video ExternalReplyInfo */ export interface AbstractExternalReplyMedia { /** True, if the message media is covered by a spoiler animation */ has_media_spoiler?: true; } export interface ExternalReplyAnimation extends AbstractExternalReply, AbstractExternalReplyMedia { /** Message is an animation, information about the animation */ animation: Animation; } export interface ExternalReplyAudio extends AbstractExternalReply { /** Message is an audio file, information about the file */ audio: Audio; } export interface ExternalReplyDocument extends AbstractExternalReply { /** Message is a general file, information about the file */ document: Document; } export interface ExternalReplyPaidMedia extends AbstractExternalReply { /** Message contains paid media; information about the paid media */ paid_media: PaidMediaInfo; } export interface ExternalReplyPhoto extends AbstractExternalReply, AbstractExternalReplyMedia { /** Message is a photo, available sizes of the photo */ photo: PhotoSize[]; } export interface ExternalReplySticker extends AbstractExternalReply { /** Message is a sticker, information about the sticker */ sticker: Sticker; } export interface ExternalReplyStory extends AbstractExternalReply { /** Message is a forwarded story */ story: Story; } export interface ExternalReplyVideo extends AbstractExternalReply, AbstractExternalReplyMedia { /** Message is a video, information about the video */ video: Video; } export interface ExternalReplyVideoNote extends AbstractExternalReply { /** Message is a video note, information about the video message */ video_note: VideoNote; } export interface ExternalReplyVoice extends AbstractExternalReply { /** Message is a voice message, information about the file */ voice: Voice; } export interface ExternalReplyContact extends AbstractExternalReply { /** Message is a shared contact, information about the contact */ contact: Contact; } export interface ExternalReplyDice extends AbstractExternalReply { /** Message is a dice with random value */ dice: Dice; } export interface ExternalReplyGame extends AbstractExternalReply { /** Message is a game, information about the game. More about games » */ game: Game; } export interface ExternalReplyGiveaway extends AbstractExternalReply { /** Message is a scheduled giveaway, information about the giveaway */ giveaway: Giveaway; } export interface ExternalReplyGiveawayWinners extends AbstractExternalReply { /** A giveaway with public winners was completed */ giveaway_winners: GiveawayWinners; } export interface ExternalReplyInvoice extends AbstractExternalReply { /** Message is an invoice for a payment, information about the invoice. More about payments » */ invoice: Invoice; } export interface ExternalReplyLocation extends AbstractExternalReply { /** Message is a shared location, information about the location */ location: Location; } export interface ExternalReplyPoll extends AbstractExternalReply { /** Message is a native poll, information about the poll */ poll: Poll; } export interface ExternalReplyVenue extends AbstractExternalReply { /** Message is a venue, information about the venue */ venue: Venue; } /** This object contains information about a message that is being replied to, which may come from another chat or forum topic. */ export type ExternalReplyInfo = ExternalReplyAnimation | ExternalReplyAudio | ExternalReplyDocument | ExternalReplyPhoto | ExternalReplySticker | ExternalReplyStory | ExternalReplyVideo | ExternalReplyVideoNote | ExternalReplyVoice | ExternalReplyContact | ExternalReplyDice | ExternalReplyGame | ExternalReplyGiveaway | ExternalReplyGiveawayWinners | ExternalReplyInvoice | ExternalReplyLocation | ExternalReplyPoll | ExternalReplyVenue; /** Describes reply parameters for the message that is being sent. */ export interface ReplyParameters { /** Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified */ message_id: number; /** If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format `@channelusername`). Not supported for messages sent on behalf of a business account. */ chat_id?: number | string; /** Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account. */ allow_sending_without_reply?: boolean; /** Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message. */ quote?: string; /** Mode for parsing entities in the quote. See formatting options for more details. */ quote_parse_mode?: ParseMode; /** A list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. */ quote_entities?: MessageEntity[]; /** Position of the quote in the original message in UTF-16 code units */ quote_position?: number; } /** This object describes the origin of a message. It can be one of - MessageOriginUser - MessageOriginHiddenUser - MessageOriginChat - MessageOriginChannel */ type MessageOrigin = MessageOriginUser | MessageOriginHiddenUser | MessageOriginChat | MessageOriginChannel; export interface AbstractMessageOrigin { /** Type of the message origin */ type: string; /** Date the message was sent originally in Unix time */ date: number; } /** The message was originally sent by a known user. */ export interface MessageOriginUser extends AbstractMessageOrigin { type: "user"; /** User that sent the message originally */ sender_user: User; } /** The message was originally sent by an unknown user. */ export interface MessageOriginHiddenUser extends AbstractMessageOrigin { type: "hidden_user"; /** Name of the user that sent the message originally */ sender_user_name: string; } /** The message was originally sent on behalf of a chat to a group chat. */ export interface MessageOriginChat extends AbstractMessageOrigin { type: "chat"; /** Chat that sent the message originally */ sender_chat: Chat; /** For messages originally sent by an anonymous chat administrator, original message author signature */ author_signature?: string; } /** The message was originally sent to a channel chat. */ export interface MessageOriginChannel extends AbstractMessageOrigin { type: "channel"; /** Channel chat to which the message was originally sent */ chat: Chat; /** Unique message identifier inside the chat */ message_id: number; /** Signature of the original post author */ author_signature?: string; } /** This object represents one size of a photo or a file / sticker thumbnail. */ export interface PhotoSize { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Photo width */ width: number; /** Photo height */ height: number; /** File size in bytes */ file_size?: number; } /** This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). */ export interface Animation { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Video width as defined by the sender */ width: number; /** Video height as defined by the sender */ height: number; /** Duration of the video in seconds as defined by the sender */ duration: number; /** Animation thumbnail as defined by the sender */ thumbnail?: PhotoSize; /** Original animation filename as defined by the sender */ file_name?: string; /** MIME type of the file as defined by the sender */ mime_type?: string; /** File size in bytes */ file_size?: number; } /** This object represents an audio file to be treated as music by the Telegram clients. */ export interface Audio { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Duration of the audio in seconds as defined by the sender */ duration: number; /** Performer of the audio as defined by the sender or by audio tags */ performer?: string; /** Title of the audio as defined by the sender or by audio tags */ title?: string; /** Original filename as defined by the sender */ file_name?: string; /** MIME type of the file as defined by the sender */ mime_type?: string; /** File size in bytes */ file_size?: number; /** Thumbnail of the album cover to which the music file belongs */ thumbnail?: PhotoSize; } /** This object represents a general file (as opposed to photos, voice messages and audio files). */ export interface Document { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Document thumbnail as defined by the sender */ thumbnail?: PhotoSize; /** Original filename as defined by the sender */ file_name?: string; /** MIME type of the file as defined by the sender */ mime_type?: string; /** File size in bytes */ file_size?: number; } /** This object represents a story. */ export interface Story { /** Chat that posted the story */ chat: Chat; /** Unique identifier for the story in the chat */ id: number; } /** This object represents a video file. */ export interface Video { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Video width as defined by the sender */ width: number; /** Video height as defined by the sender */ height: number; /** Duration of the video in seconds as defined by the sender */ duration: number; /** Video thumbnail */ thumbnail?: PhotoSize; /** Available sizes of the cover of the video in the message */ cover?: PhotoSize[]; /** Timestamp in seconds from which the video will play in the message */ start_timestamp?: number; /** Original filename as defined by the sender */ file_name?: string; /** MIME type of the file as defined by the sender */ mime_type?: string; /** File size in bytes */ file_size?: number; } /** This object represents a video message (available in Telegram apps as of v.4.0). */ export interface VideoNote { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Video width and height (diameter of the video message) as defined by the sender */ length: number; /** Duration of the video in seconds as defined by the sender */ duration: number; /** Video thumbnail */ thumbnail?: PhotoSize; /** File size in bytes */ file_size?: number; } /** This object represents a voice note. */ export interface Voice { /** Identifier for this file, which can be used to download or reuse the file */ file_id: string; /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */ file_unique_id: string; /** Duration of the audio in seconds as defined by the sender */ duration: number; /** MIME type of the file as defined by the sender */ mime_type?: string; /** File size in bytes */ file_size?: number; } /** Describes the paid media added to a message. */ export interface PaidMediaInfo { /** The number of Telegram Stars that must be paid to buy access to the media */ star_count: number; /** Information about the paid media */ paid_media: PaidMedia[]; } declare namespace PaidMedia { /** The paid media isn't available before the payment. */ interface PaidMediaPreview { /** Type of the paid media, always “preview” */ type: string; /** Media width as defined by the sender */ width?: number; /** Media height as defined by the sender */ height?: number; /** Duration of the media in seconds as defined by the sender */ duration?: number; } /** The paid media is a photo. */ interface PaidMediaPhoto { /** Type of the paid media, always “photo” */ type: string; /** The photo */ photo: PhotoSize[]; } /** The paid media is a video. */ interface PaidMediaVideo { /** Type of the paid media, always “video” */ type: string; /** The video */ video: Video; } } /** This object describes paid media. Currently, it can be one of - PaidMediaPreview - PaidMediaPhoto - PaidMediaVideo */ export type PaidMedia = PaidMedia.PaidMediaPreview | PaidMedia.PaidMediaPhoto | PaidMedia.PaidMediaVideo; /** This object represents a phone contact. */ export interface Contact { /** Contact's phone number */ phone_number: string; /** Contact's first name */ first_name: string; /** Contact's last name */ last_name?: string; /** Contact's user identifier in Telegram. */ user_id?: number; /** Additional data about the contact in the form of a vCard */ vcard?: string; } /** This object represents an animated emoji that displays a random value. */ export interface Dice { /** Emoji on which the dice throw animation is based */ emoji: string; /** Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji */ value: number; } /** This object contains information about one answer option in a poll. */ export interface PollOption { /** Option text, 1-100 characters */ text: string; /** Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts */ text_entities?: MessageEntity.CustomEmoji[]; /** Number of users that voted for this option */ voter_count: number; } /** This object contains information about one answer option in a poll to be sent. */ export interface InputPollOption { /** Option text, 1-100 characters */ text: string; /** Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed */ text_parse_mode?: ParseMode; /** A list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode */ text_entities?: MessageEntity.CustomEmoji[]; } /** This object represents an answer of a user in a non-anonymous poll. */ export interface PollAnswer { /** Unique poll identifier */ poll_id: string; /** The chat that changed the answer to the poll, if the voter is anonymous */ voter_chat?: Chat; /** The user, who changed the answer to the poll, if the voter isn't anonymous * * For backward compatibility, the field user will contain the user 136817688 (@Channel_Bot) if the voter was a chat */ user?: User; /** 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. */ option_ids: number[]; } /** This object contains information about a poll. */ export interface Poll { /** Unique poll identifier */ id: string; /** Poll question, 1-300 characters */ question: string; /** Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions */ question_entities?: MessageEntity.CustomEmoji[]; /** List of poll options */ options: PollOption[]; /** Total number of users that vo