Interface SceneContext<D> interface SceneContext < D extends SceneSessionData = SceneSessionData > { botInfo : UserFromGetMe ; scene : SceneContextScene < SceneContext < D > , D > ; session : SceneSession < D > ; state : Record < string | symbol , any > ; telegram : Telegram ; update : Update ; get businessMessage () : PropOr < U , "business_message" > ; get "businessСonnection" () : PropOr < U , "business_connection" > ; get callbackQuery () : PropOr < U , "callback_query" > ; get channelPost () : PropOr < U , "channel_post" > ; get chat () : PropOr < GetUpdateContent < U > , "chat" > ; get chatBoost () : PropOr < U , "chat_boost" > ; get chatJoinRequest () : PropOr < U , "chat_join_request" > ; get chatMember () : PropOr < U , "chat_member" > ; get chosenInlineResult () : PropOr < U , "chosen_inline_result" > ; get deletedBusinessMessages () : PropOr < U , "deleted_business_messages" > ; get editedBusinessMessage () : PropOr < U , "edited_business_message" > ; get editedChannelPost () : PropOr < U , "edited_channel_post" > ; get editedMessage () : PropOr < U , "edited_message" > ; get from () : GetUserFromAnySource < U > ; get inlineMessageId () : string | undefined ; get inlineQuery () : PropOr < U , "inline_query" > ; get kickChatMember () : ( ... args : [ userId
: number , untilDate
?: number , extra
?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] , ) => Promise < true > ; get me () : string ; get message () : PropOr < U , "message" > ; get messageReaction () : PropOr < U , "message_reaction" > ; get messageReactionCount () : PropOr < U , "message_reaction_count" > ; get msg () : GetMsg < U > & Msg ; get msgId () : GetMsgId < U > ; get myChatMember () : PropOr < U , "my_chat_member" > ; get passportData () : PassportData | undefined ; get poll () : PropOr < U , "poll" > ; get pollAnswer () : PropOr < U , "poll_answer" > ; get preCheckoutQuery () : PropOr < U , "pre_checkout_query" > ; get purchasedPaidMedia () : PropOr < U , "purchased_paid_media" > ; get reactions () : MessageReactions ; get removedChatBoost () : PropOr < U , "removed_chat_boost" > ; get senderChat () : PropOr < GetUpdateContent < U > , "sender_chat" , undefined > ; get shippingQuery () : PropOr < U , "shipping_query" > ; get text () : GetText < U > ; get tg () : Telegram ; get updateType () : Extract < UnionKeys < U > , UpdateType > ; get webAppData () : | { button_text : string ; data : { json < T > () : T ; text () : string } ; } | undefined ; get webhookReply () : boolean ; set webhookReply ( enable : boolean ) : void ; addStickerToSet ( ... args : [ name
: string , stickerData
: Omit < {} , "chat_id" | "name" | "user_id" > , ] , ) : Promise < true > ; answerCbQuery ( ... args : [ text
?: string , extra
?: Omit < {} , "text" | "chat_id" | "callback_query_id" > , ] , ) : Promise < true > ; answerGameQuery ( ... args : [ url
: string ] ) : Promise < true > ; answerInlineQuery ( ... args : [ results
: readonly InlineQueryResult [] , extra
?: Omit < {} , "chat_id" | "inline_query_id" | "results" > , ] , ) : Promise < true > ; answerPreCheckoutQuery ( ... args : [ ok
: boolean , errorMessage
?: string ] , ) : Promise < true > ; answerShippingQuery ( ... args : [ ok
: boolean , shippingOptions
: readonly ShippingOption [] , errorMessage
: string , ] , ) : Promise < true > ; approveChatJoinRequest ( userId : number ) : Promise < true > ; approveSuggestedPost ( messageId : number , extra ?: Omit < {} , "chat_id" > , ) : Promise < true > ; banChatMember ( ... args : [ userId
: number , untilDate
?: number , extra
?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] , ) : Promise < true > ; banChatSenderChat ( senderChatId : number ) : Promise < true > ; closeForumTopic () : Promise < true > ; closeGeneralForumTopic () : Promise < true > ; copyMessage ( chatId : string | number , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < MessageId > ; copyMessages ( chatId : string | number , messageIds : number [] , extra ?: Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > , ) : Promise < MessageId [] > ; createChatInviteLink ( ... args : [ extra
?: Omit < {} , "chat_id" > ] , ) : Promise < ChatInviteLink > ; createChatSubscriptionInviteLink ( ... args : [ subscriptionPrice
: number , extra
?: Omit < {} , "chat_id" | "subscription_period" | "subscription_price" , > , ] , ) : Promise < ChatInviteLink > ; createForumTopic ( ... args : [ name
: string , extra
?: Omit < {} , "chat_id" | "name" > ] , ) : Promise < ForumTopic > ; createNewStickerSet ( ... args : [ name
: string , title
: string , stickerData
: Omit < {} , "chat_id" | "name" | "user_id" | "title" > , ] , ) : Promise < true > ; declineChatJoinRequest ( userId : number ) : Promise < true > ; declineSuggestedPost ( messageId : number , extra ?: Omit < {} , "chat_id" > , ) : Promise < true > ; deleteChatPhoto ( ... args : [ ] ) : Promise < true > ; deleteChatStickerSet () : Promise < true > ; deleteForumTopic () : Promise < true > ; deleteMessage ( messageId ?: number ) : Promise < true > ; deleteMessages ( messageIds : number [] ) : Promise < true > ; deleteStickerFromSet ( sticker : string ) : Promise < true > ; deleteStickerSet ( ... args : [ name
: string ] ) : Promise < true > ; editChatInviteLink ( ... args : [ inviteLink
: string , extra
?: Omit < {} , "chat_id" | "invite_link" > , ] , ) : Promise < ChatInviteLink > ; editChatSubscriptionInviteLink ( ... args : [ inviteLink
: string , extra
?: Omit < {} , "chat_id" | "invite_link" > , ] , ) : Promise < ChatInviteLink > ; editForumTopic ( extra : ExtraEditForumTopic ) : Promise < true > ; editGeneralForumTopic ( name : string ) : Promise < true > ; editMessageCaption ( caption : string | FmtString < string > | undefined , extra ?: Omit < {} , "caption" | "chat_id" | "message_id" | "inline_message_id" , > , ) : Promise < true | Edited & CaptionableMessage & BusinessSentMessage > ; editMessageChecklist ( businessConnectionId : string , messageId : number , checklist : InputChecklist , extra ?: Omit < {} , "chat_id" | "business_connection_id" | "message_id" | "checklist" , > , ) : Promise < ChecklistMessage & BusinessSentMessage > ; editMessageLiveLocation ( latitude : number , longitude : number , extra ?: Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude" , > , ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > ; editMessageMedia ( media : | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } , extra ?: Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "media" > , ) : Promise < true | (Edited & (Message & BusinessSentMessage))
> ; editMessageReplyMarkup ( markup : InlineKeyboardMarkup | undefined , ) : Promise < true | (Edited & (Message & BusinessSentMessage))
> ; editMessageText ( text : string | FmtString < string > , extra ?: Omit < {} , "text" | "chat_id" | "message_id" | "inline_message_id" > , ) : Promise < true | Edited & TextMessage & BusinessSentMessage > ; editUserStarSubscription ( ... args : [ paymentChargeId
: string , isCanceled
: boolean ] , ) : Promise < true > ; entities < EntityTypes extends (
| "url" | "mention" | "hashtag" | "cashtag" | "bot_command" | "email" | "phone_number" | "bold" | "blockquote" | "expandable_blockquote" | "italic" | "underline" | "strikethrough" | "spoiler" | "code" | "pre" | "text_link" | "text_mention" | "custom_emoji" )
[] , > ( ... types : EntityTypes , ) : (
MessageEntity & { fragment : string ; type : SelectedTypes } )
[] ; exportChatInviteLink ( ... args : [ ] ) : Promise < string > ; forwardMessage ( chatId : string | number , extra ?: Omit < {} , "chat_id" | "from_chat_id" | "message_id" > , ) : Promise < Message & BusinessSentMessage > ; forwardMessages ( chatId : string | number , messageIds : number [] , extra ?: Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > , ) : Promise < MessageId [] > ; getAvailableGifts () : Promise < Gifts > ; getChat ( ... args : [ ] ) : Promise < ChatFullInfo > ; getChatAdministrators ( ... args : [ ] , ) : Promise < (
ChatMemberOwner | ChatMemberAdministrator )
[] > ; getChatMember ( ... args : [ userId
: number ] ) : Promise < ChatMember > ; getChatMembersCount ( ... args : [ ] ) : Promise < number > ; getChatMenuButton () : Promise < MenuButton > ; getMyCommands () : Promise < BotCommand [] > ; getMyDefaultAdministratorRights ( extra ?: { forChannels ?: boolean } , ) : Promise < ChatAdministratorRights > ; getMyStarBalance () : Promise < StarAmount > ; getStarTransactions ( offset ?: number , limit ?: number , ) : Promise < StarTransactions > ; getStickerSet ( setName : string ) : Promise < StickerSet > ; getUserChatBoosts () : Promise < UserChatBoosts > ; getUserProfileAudios ( extra ?: Omit < {} , "chat_id" | "user_id" > , ) : Promise < UserProfileAudios > ; getUserProfilePhotos ( offset ?: number , limit ?: number , ) : Promise < UserProfilePhotos > ; giftPremiumSubscription ( starCount : 1000 | 1500 | 2500 , monthCount : 3 | 6 | 12 , extra ?: Omit < {} , "chat_id" | "user_id" | "star_count" | "month_count" > , ) : Promise < true > ; has < Filter extends UpdateType | Guard < Update > > ( filters : MaybeArray < Filter > , ) : this is FilteredContext < Context < Update > , Filter > ; hideGeneralForumTopic () : Promise < true > ; leaveChat ( ... args : [ ] ) : Promise < true > ; persistentChatAction ( action : | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , callback : () => Promise < void > , extra ?: Omit < {} , "action" | "chat_id" > & { intervalDuration ?: number } , ) : Promise < void > ; pinChatMessage ( ... args : [ messageId
: number , extra
?: { disable_notification ?: boolean } , ] , ) : Promise < true > ; promoteChatMember ( ... args : [ userId
: number , extra
: Omit < {} , "chat_id" | "user_id" > ] , ) : Promise < true > ; react ( reaction ?: MaybeArray < (
ReactionType | TelegramEmoji | `0${string}` | `1${string}` | `2${string}` | `3${string}` | `4${string}` | `5${string}` | `6${string}` | `7${string}` | `8${string}` | `9${string}`
)
, > , is_big ?: boolean , ) : Promise < true > ; refundStarPayment ( ... args : [ paymentChargeId
: string ] ) : Promise < true > ; removeChatVerification () : Promise < true > ; removeUserVerification () : Promise < true > ; reopenForumTopic () : Promise < true > ; reopenGeneralForumTopic () : Promise < true > ; reply ( ... args : [ text
: string | FmtString < string > , extra
?: Omit < {} , "text" | "chat_id" > , ] , ) : Promise < TextMessage & BusinessSentMessage > ; replyWithAnimation ( ... args : [ animation
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < AnimationMessage & BusinessSentMessage > ; replyWithAudio ( ... args : [ audio
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < AudioMessage & BusinessSentMessage > ; replyWithChatAction ( ... args : [ action
: | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , extra
?: Omit < {} , "action" | "chat_id" > , ] , ) : Promise < true > ; replyWithContact ( ... args : [ phoneNumber
: string , firstName
: string , extra
?: Omit < {} , "phone_number" | "chat_id" | "first_name" > , ] , ) : Promise < ContactMessage & BusinessSentMessage > ; replyWithDice ( ... args : [ extra
?: Omit < {} , "chat_id" > ] , ) : Promise < DiceMessage & BusinessSentMessage > ; replyWithDocument ( ... args : [ document
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < DocumentMessage & BusinessSentMessage > ; replyWithGame ( ... args : [ gameName
: string , extra
?: Omit < {} , "chat_id" | "game_short_name" > , ] , ) : Promise < GameMessage & BusinessSentMessage > ; replyWithHTML ( html : string , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > ; replyWithInvoice ( ... args : [ invoice
: Omit < {} , | "chat_id" | "message_thread_id" | "disable_notification" | "reply_parameters" | "reply_markup" , > , extra
?: Omit < {} , | "chat_id" | "direct_messages_topic_id" | "protect_content" | "allow_paid_broadcast" | "message_effect_id" | "suggested_post_parameters" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter" , > , ] , ) : Promise < InvoiceMessage & BusinessSentMessage > ; replyWithLocation ( ... args : [ latitude
: number , longitude
: number , extra
?: Omit < {} , "chat_id" | "latitude" | "longitude" > , ] , ) : Promise < LocationMessage & BusinessSentMessage > ; replyWithMarkdown ( markdown : string , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > ; replyWithMarkdownV2 ( markdown : string , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > ; replyWithMediaGroup ( ... args : [ media
: MediaGroup , extra
?: Omit < {} , "chat_id" | "media" > ] , ) : Promise < (
(
DocumentMessage | AudioMessage | PhotoMessage | VideoMessage )
& BusinessSentMessage )
[] , > ; replyWithPhoto ( ... args : [ photo
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < PhotoMessage & BusinessSentMessage > ; replyWithPoll ( ... args : [ question
: string , options
: readonly InputPollOption [] , extra
?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ] , ) : Promise < PollMessage & BusinessSentMessage > ; replyWithQuiz ( ... args : [ question
: string , options
: readonly InputPollOption [] , extra
?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ] , ) : Promise < PollMessage & BusinessSentMessage > ; replyWithSticker ( ... args : [ sticker
: string | InputFile , extra
?: Omit < {} , "chat_id" | "sticker" > , ] , ) : Promise < StickerMessage & BusinessSentMessage > ; replyWithVenue ( ... args : [ latitude
: number , longitude
: number , title
: string , address
: string , extra
?: Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" , > , ] , ) : Promise < VenueMessage & BusinessSentMessage > ; replyWithVideo ( ... args : [ video
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < VideoMessage & BusinessSentMessage > ; replyWithVideoNote ( ... args : [ videoNote
: string | InputFileVideoNote , extra
?: Omit < {} , "chat_id" | "video_note" > , ] , ) : Promise < VideoNoteMessage & BusinessSentMessage > ; replyWithVoice ( ... args : [ voice
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < VoiceMessage & BusinessSentMessage > ; restrictChatMember ( ... args : [ userId
: number , extra
: Omit < {} , "chat_id" | "user_id" > ] , ) : Promise < true > ; revokeChatInviteLink ( ... args : [ inviteLink
: string ] , ) : Promise < ChatInviteLink > ; sendAnimation ( animation : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < AnimationMessage & BusinessSentMessage > ; sendAudio ( audio : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < AudioMessage & BusinessSentMessage > ; sendChatAction ( action : | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , extra ?: Omit < {} , "action" | "chat_id" > , ) : Promise < true > ; sendChecklist ( businessConnectionId : string , checklist : InputChecklist , extra ?: Omit < {} , "chat_id" | "checklist" > , ) : Promise < ChecklistMessage & BusinessSentMessage > ; sendContact ( phoneNumber : string , firstName : string , extra ?: Omit < {} , "phone_number" | "chat_id" | "first_name" > , ) : Promise < ContactMessage & BusinessSentMessage > ; sendDice ( extra ?: Omit < {} , "chat_id" > , ) : Promise < DiceMessage & BusinessSentMessage > ; sendDocument ( document : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < DocumentMessage & BusinessSentMessage > ; sendGame ( game : string , extra ?: Omit < {} , "chat_id" | "game_short_name" > , ) : Promise < GameMessage & BusinessSentMessage > ; sendGift ( giftId : string , extra ?: Omit < {} , "chat_id" | "gift_id" > , ) : Promise < true > ; sendInvoice ( invoice : NewInvoiceParameters , extra ?: Omit < {} , | "chat_id" | "direct_messages_topic_id" | "protect_content" | "allow_paid_broadcast" | "message_effect_id" | "suggested_post_parameters" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter" , > , ) : Promise < InvoiceMessage & BusinessSentMessage > ; sendLocation ( latitude : number , longitude : number , extra ?: Omit < {} , "chat_id" | "latitude" | "longitude" > , ) : Promise < LocationMessage & BusinessSentMessage > ; sendMediaGroup ( media : MediaGroup , extra ?: Omit < {} , "chat_id" | "media" > , ) : Promise < (
(
DocumentMessage | AudioMessage | PhotoMessage | VideoMessage )
& BusinessSentMessage )
[] , > ; sendMessage ( text : string | FmtString < string > , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > ; sendMessageDraft ( draftId : number , text : string , extra ?: Omit < {} , "text" | "chat_id" | "draft_id" > , ) : Promise < true > ; sendPaidMedia ( starCount : number , media : PaidMediaGroup , extra ?: Omit < {} , "caption" | "chat_id" | "media" | "star_count" > , ) : Promise < PaidMediaMessage & BusinessSentMessage > ; sendPhoto ( photo : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < PhotoMessage & BusinessSentMessage > ; sendPoll ( poll : string , options : readonly InputPollOption [] , extra ?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ) : Promise < PollMessage & BusinessSentMessage > ; sendQuiz ( quiz : string , options : readonly InputPollOption [] , extra ?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ) : Promise < PollMessage & BusinessSentMessage > ; sendSticker ( sticker : string | InputFile , extra ?: Omit < {} , "chat_id" | "sticker" > , ) : Promise < StickerMessage & BusinessSentMessage > ; sendVenue ( latitude : number , longitude : number , title : string , address : string , extra ?: Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" , > , ) : Promise < VenueMessage & BusinessSentMessage > ; sendVideo ( video : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < VideoMessage & BusinessSentMessage > ; sendVideoNote ( videoNote : string | InputFileVideoNote , extra ?: Omit < {} , "chat_id" | "video_note" > , ) : Promise < VideoNoteMessage & BusinessSentMessage > ; sendVoice ( voice : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < VoiceMessage & BusinessSentMessage > ; setChatAdministratorCustomTitle ( ... args : [ userId
: number , title
: string ] , ) : Promise < true > ; setChatDescription ( ... args : [ description
?: string ] ) : Promise < true > ; setChatMenuButton ( menuButton ?: MenuButton ) : Promise < true > ; setChatPermissions ( ... args : [ permissions
: ChatPermissions , extra
?: Omit < {} , "chat_id" | "permissions" > , ] , ) : Promise < true > ; setChatPhoto ( ... args : [ photo
: InputFile ] ) : Promise < true > ; setChatStickerSet ( setName : string ) : Promise < true > ; setChatTitle ( ... args : [ title
: string ] ) : Promise < true > ; setCustomEmojiStickerSetThumbnail ( ... args : [ name
: string , custom_emoji_id
: string ] , ) : Promise < true > ; setMyCommands ( commands : readonly BotCommand [] ) : Promise < true > ; setMyDefaultAdministratorRights ( extra ?: { forChannels ?: boolean ; rights ?: ChatAdministratorRights } , ) : Promise < true > ; setPassportDataErrors ( errors : readonly PassportElementError [] , ) : Promise < true > ; setStickerEmojiList ( ... args : [ sticker
: string , emoji_list
: string [] ] , ) : Promise < true > ; setStickerKeywords ( ... args : [ sticker
: string , keywords
?: string [] ] , ) : Promise < true > ; setStickerMaskPosition ( ... args : [ sticker
: string , mask_position
?: MaskPosition ] , ) : Promise < true > ; setStickerPositionInSet ( sticker : string , position : number ) : Promise < true > ; setStickerSetThumb ( ... args : [ name
: string , userId
: number , thumbnail
?: string | InputFile , format
: "video" | "static" | "animated" , ] , ) : Promise < true > ; setStickerSetThumbnail ( ... args : [ name
: string , userId
: number , thumbnail
?: string | InputFile , format
: "video" | "static" | "animated" , ] , ) : Promise < true > ; setStickerSetTitle ( ... args : [ name
: string , title
: string ] ) : Promise < true > ; setUserEmojiStatus ( extra ?: Omit < {} , "chat_id" | "user_id" > ) : Promise < true > ; stopMessageLiveLocation ( markup ?: InlineKeyboardMarkup , ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > ; stopPoll ( ... args : [ messageId
: number , extra
?: Omit < {} , "chat_id" | "message_id" > , ] , ) : Promise < Poll > ; unbanChatMember ( ... args : [ userId
: number , extra
?: { only_if_banned ?: boolean } ] , ) : Promise < true > ; unbanChatSenderChat ( senderChatId : number ) : Promise < true > ; unhideGeneralForumTopic () : Promise < true > ; unpinAllChatMessages ( ... args : [ ] ) : Promise < true > ; unpinAllForumTopicMessages () : Promise < true > ; unpinAllGeneralForumTopicMessages () : Promise < true > ; unpinChatMessage ( ... args : [ messageId
?: number ] ) : Promise < true > ; uploadStickerFile ( ... args : [ sticker
: InputFile , sticker_format
: "video" | "static" | "animated" , ] , ) : Promise < File > ; verifyChat ( ... args : [ extra
?: Omit < {} , "chat_id" > ] ) : Promise < true > ; verifyUser ( ... args : [ extra
?: Omit < {} , "chat_id" | "user_id" > ] , ) : Promise < true > ; } Properties Readonlybot Info botInfo : UserFromGetMe
Readonlystate state : Record < string | symbol , any > = {}
Readonlyupdate update : Update
Accessors business Message get businessMessage () : PropOr < U , "business_message" > Returns PropOr < U , "business_message" > businessСonnection get "businessСonnection" () : PropOr < U , "business_connection" > Returns PropOr < U , "business_connection" > callback Query get callbackQuery () : PropOr < U , "callback_query" > Returns PropOr < U , "callback_query" > channel Post get channelPost () : PropOr < U , "channel_post" > Returns PropOr < U , "channel_post" > chat get chat () : PropOr < GetUpdateContent < U > , "chat" > Returns PropOr < GetUpdateContent < U > , "chat" > chat Boost get chatBoost () : PropOr < U , "chat_boost" > Returns PropOr < U , "chat_boost" > chat Join Request get chatJoinRequest () : PropOr < U , "chat_join_request" > Returns PropOr < U , "chat_join_request" > chat Member get chatMember () : PropOr < U , "chat_member" > Returns PropOr < U , "chat_member" > chosen Inline Result get chosenInlineResult () : PropOr < U , "chosen_inline_result" > Returns PropOr < U , "chosen_inline_result" > deleted Business Messages get deletedBusinessMessages () : PropOr < U , "deleted_business_messages" > Returns PropOr < U , "deleted_business_messages" > edited Business Message get editedBusinessMessage () : PropOr < U , "edited_business_message" > Returns PropOr < U , "edited_business_message" > edited Channel Post get editedChannelPost () : PropOr < U , "edited_channel_post" > Returns PropOr < U , "edited_channel_post" > edited Message get editedMessage () : PropOr < U , "edited_message" > Returns PropOr < U , "edited_message" > from get from () : GetUserFromAnySource < U > Returns GetUserFromAnySource < U > inline Query get inlineQuery () : PropOr < U , "inline_query" > Returns PropOr < U , "inline_query" > kick Chat Member get kickChatMember () : ( ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] , ) => Promise < true >
Returns ( ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] , ) => Promise < true > ( ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] , ) : Promise < true > Parameters ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] Returns Promise < true > message get message () : PropOr < U , "message" > Returns PropOr < U , "message" > message Reaction get messageReaction () : PropOr < U , "message_reaction" > Returns PropOr < U , "message_reaction" > message Reaction Count get messageReactionCount () : PropOr < U , "message_reaction_count" > Returns PropOr < U , "message_reaction_count" > msg get msg () : GetMsg < U > & Msg my Chat Member get myChatMember () : PropOr < U , "my_chat_member" > Returns PropOr < U , "my_chat_member" > poll get poll () : PropOr < U , "poll" > Returns PropOr < U , "poll" > poll Answer get pollAnswer () : PropOr < U , "poll_answer" > Returns PropOr < U , "poll_answer" > pre Checkout Query get preCheckoutQuery () : PropOr < U , "pre_checkout_query" > Returns PropOr < U , "pre_checkout_query" > Returns PropOr < U , "purchased_paid_media" > removed Chat Boost get removedChatBoost () : PropOr < U , "removed_chat_boost" > Returns PropOr < U , "removed_chat_boost" > sender Chat get senderChat () : PropOr < GetUpdateContent < U > , "sender_chat" , undefined > Returns PropOr < GetUpdateContent < U > , "sender_chat" , undefined > shipping Query get shippingQuery () : PropOr < U , "shipping_query" > Returns PropOr < U , "shipping_query" > Methods add Sticker To Set addStickerToSet ( ... args : [ name
: string , stickerData
: Omit < {} , "chat_id" | "name" | "user_id" > , ] , ) : Promise < true > Parameters ... args : [ name: string , stickerData: Omit < {} , "chat_id" | "name" | "user_id" > ] Returns Promise < true > answer Cb Query answerCbQuery ( ... args : [ text
?: string , extra
?: Omit < {} , "text" | "chat_id" | "callback_query_id" > , ] , ) : Promise < true > Parameters ... args : [ text?: string , extra?: Omit < {} , "text" | "chat_id" | "callback_query_id" > ] Returns Promise < true > answer Game Query answerGameQuery ( ... args : [ url
: string ] ) : Promise < true > answer Inline Query answerInlineQuery ( ... args : [ results
: readonly InlineQueryResult [] , extra
?: Omit < {} , "chat_id" | "inline_query_id" | "results" > , ] , ) : Promise < true > Parameters ... args : [ results: readonly InlineQueryResult [] , extra?: Omit < {} , "chat_id" | "inline_query_id" | "results" > , ] Returns Promise < true > answer Pre Checkout Query answerPreCheckoutQuery ( ... args : [ ok
: boolean , errorMessage
?: string ] , ) : Promise < true > Parameters ... args : [ ok: boolean , errorMessage?: string ] Returns Promise < true > answer Shipping Query answerShippingQuery ( ... args : [ ok
: boolean , shippingOptions
: readonly ShippingOption [] , errorMessage
: string , ] , ) : Promise < true > Parameters ... args : [ ok: boolean , shippingOptions: readonly ShippingOption [] , errorMessage: string ] Returns Promise < true > approve Chat Join Request approveChatJoinRequest ( userId : number ) : Promise < true > approve Suggested Post approveSuggestedPost ( messageId : number , extra ?: Omit < {} , "chat_id" > , ) : Promise < true > Parameters messageId : number Optionalextra : Omit < {} , "chat_id" > Returns Promise < true > ban Chat Member banChatMember ( ... args : [ userId
: number , untilDate
?: number , extra
?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] , ) : Promise < true > Parameters ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > , ] Returns Promise < true > ban Chat Sender Chat banChatSenderChat ( senderChatId : number ) : Promise < true > close Forum Topic closeForumTopic () : Promise < true > close General Forum Topic closeGeneralForumTopic () : Promise < true > copy Message copyMessage ( chatId : string | number , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < MessageId > Parameters chatId : string | number Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < MessageId > copy Messages copyMessages ( chatId : string | number , messageIds : number [] , extra ?: Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > , ) : Promise < MessageId [] > Parameters chatId : string | number messageIds : number [] Optionalextra : Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > Returns Promise < MessageId [] > create Chat Invite Link createChatInviteLink ( ... args : [ extra
?: Omit < {} , "chat_id" > ] , ) : Promise < ChatInviteLink > Parameters ... args : [ extra?: Omit < {} , "chat_id" > ] Returns Promise < ChatInviteLink > create Chat Subscription Invite Link createChatSubscriptionInviteLink ( ... args : [ subscriptionPrice
: number , extra
?: Omit < {} , "chat_id" | "subscription_period" | "subscription_price" > , ] , ) : Promise < ChatInviteLink > Parameters ... args : [ subscriptionPrice: number , extra?: Omit < {} , "chat_id" | "subscription_period" | "subscription_price" > , ] Returns Promise < ChatInviteLink > create Forum Topic createForumTopic ( ... args : [ name
: string , extra
?: Omit < {} , "chat_id" | "name" > ] , ) : Promise < ForumTopic > Parameters ... args : [ name: string , extra?: Omit < {} , "chat_id" | "name" > ] Returns Promise < ForumTopic > create New Sticker Set createNewStickerSet ( ... args : [ name
: string , title
: string , stickerData
: Omit < {} , "chat_id" | "name" | "user_id" | "title" > , ] , ) : Promise < true > Parameters ... args : [ name: string , title: string , stickerData: Omit < {} , "chat_id" | "name" | "user_id" | "title" > , ] Returns Promise < true > decline Chat Join Request declineChatJoinRequest ( userId : number ) : Promise < true > decline Suggested Post declineSuggestedPost ( messageId : number , extra ?: Omit < {} , "chat_id" > , ) : Promise < true > Parameters messageId : number Optionalextra : Omit < {} , "chat_id" > Returns Promise < true > delete Chat Photo deleteChatPhoto ( ... args : [ ] ) : Promise < true > delete Chat Sticker Set deleteChatStickerSet () : Promise < true > delete Forum Topic deleteForumTopic () : Promise < true > delete Message deleteMessage ( messageId ?: number ) : Promise < true > Parameters OptionalmessageId : number Returns Promise < true > delete Messages deleteMessages ( messageIds : number [] ) : Promise < true > delete Sticker From Set deleteStickerFromSet ( sticker : string ) : Promise < true > delete Sticker Set deleteStickerSet ( ... args : [ name
: string ] ) : Promise < true > edit Chat Invite Link editChatInviteLink ( ... args : [ inviteLink
: string , extra
?: Omit < {} , "chat_id" | "invite_link" > , ] , ) : Promise < ChatInviteLink > Parameters ... args : [ inviteLink: string , extra?: Omit < {} , "chat_id" | "invite_link" > ] Returns Promise < ChatInviteLink > edit Chat Subscription Invite Link editChatSubscriptionInviteLink ( ... args : [ inviteLink
: string , extra
?: Omit < {} , "chat_id" | "invite_link" > , ] , ) : Promise < ChatInviteLink > Parameters ... args : [ inviteLink: string , extra?: Omit < {} , "chat_id" | "invite_link" > ] Returns Promise < ChatInviteLink > edit General Forum Topic editGeneralForumTopic ( name : string ) : Promise < true > edit Message Caption editMessageCaption ( caption : string | FmtString < string > | undefined , extra ?: Omit < {} , "caption" | "chat_id" | "message_id" | "inline_message_id" , > , ) : Promise < true | Edited & CaptionableMessage & BusinessSentMessage > Parameters caption : string | FmtString < string > | undefined Optionalextra : Omit < {} , "caption" | "chat_id" | "message_id" | "inline_message_id" > Returns Promise < true | Edited & CaptionableMessage & BusinessSentMessage > edit Message Checklist editMessageChecklist ( businessConnectionId : string , messageId : number , checklist : InputChecklist , extra ?: Omit < {} , "chat_id" | "business_connection_id" | "message_id" | "checklist" , > , ) : Promise < ChecklistMessage & BusinessSentMessage > Parameters businessConnectionId : string messageId : number checklist : InputChecklist Optionalextra : Omit < {} , "chat_id" | "business_connection_id" | "message_id" | "checklist" > Returns Promise < ChecklistMessage & BusinessSentMessage > edit Message Live Location editMessageLiveLocation ( latitude : number , longitude : number , extra ?: Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude" , > , ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > Parameters latitude : number longitude : number Optionalextra : Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude" , > Returns Promise < true | Edited & LocationMessage & BusinessSentMessage > Parameters media : | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } | { caption ?: string | FmtString < string > } Optionalextra : Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "media" > Returns Promise < true | (Edited & (Message & BusinessSentMessage))> edit Message Reply Markup editMessageReplyMarkup ( markup : InlineKeyboardMarkup | undefined , ) : Promise < true | (Edited & (Message & BusinessSentMessage))
> Parameters markup : InlineKeyboardMarkup | undefined Returns Promise < true | (Edited & (Message & BusinessSentMessage))> edit Message Text editMessageText ( text : string | FmtString < string > , extra ?: Omit < {} , "text" | "chat_id" | "message_id" | "inline_message_id" > , ) : Promise < true | Edited & TextMessage & BusinessSentMessage > Parameters text : string | FmtString < string > Optionalextra : Omit < {} , "text" | "chat_id" | "message_id" | "inline_message_id" > Returns Promise < true | Edited & TextMessage & BusinessSentMessage > edit User Star Subscription editUserStarSubscription ( ... args : [ paymentChargeId
: string , isCanceled
: boolean ] , ) : Promise < true > Parameters ... args : [ paymentChargeId: string , isCanceled: boolean ] Returns Promise < true > entities entities < EntityTypes extends (
| "url" | "mention" | "hashtag" | "cashtag" | "bot_command" | "email" | "phone_number" | "bold" | "blockquote" | "expandable_blockquote" | "italic" | "underline" | "strikethrough" | "spoiler" | "code" | "pre" | "text_link" | "text_mention" | "custom_emoji" )
[] , > ( ... types : EntityTypes , ) : (
MessageEntity & { fragment : string ; type : SelectedTypes } )
[] Type Parameters EntityTypes extends ( | "url" | "mention" | "hashtag" | "cashtag" | "bot_command" | "email" | "phone_number" | "bold" | "blockquote" | "expandable_blockquote" | "italic" | "underline" | "strikethrough" | "spoiler" | "code" | "pre" | "text_link" | "text_mention" | "custom_emoji" )[] Returns (MessageEntity & { fragment : string ; type : SelectedTypes } )[] export Chat Invite Link exportChatInviteLink ( ... args : [ ] ) : Promise < string > forward Message forwardMessage ( chatId : string | number , extra ?: Omit < {} , "chat_id" | "from_chat_id" | "message_id" > , ) : Promise < Message & BusinessSentMessage > Parameters chatId : string | number Optionalextra : Omit < {} , "chat_id" | "from_chat_id" | "message_id" > Returns Promise < Message & BusinessSentMessage > forward Messages forwardMessages ( chatId : string | number , messageIds : number [] , extra ?: Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > , ) : Promise < MessageId [] > Parameters chatId : string | number messageIds : number [] Optionalextra : Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > Returns Promise < MessageId [] > get Available Gifts getAvailableGifts () : Promise < Gifts > get Chat getChat ( ... args : [ ] ) : Promise < ChatFullInfo > Returns Promise < ChatFullInfo > get Chat Administrators getChatAdministrators ( ... args : [ ] , ) : Promise < (
ChatMemberOwner | ChatMemberAdministrator )
[] > Returns Promise < (ChatMemberOwner | ChatMemberAdministrator )[] > get Chat Member getChatMember ( ... args : [ userId
: number ] ) : Promise < ChatMember > Parameters ... args : [ userId: number ] Returns Promise < ChatMember > get Chat Members Count getChatMembersCount ( ... args : [ ] ) : Promise < number > Returns Promise < MenuButton > get My Commands getMyCommands () : Promise < BotCommand [] > Returns Promise < BotCommand [] > get My Default Administrator Rights getMyDefaultAdministratorRights ( extra ?: { forChannels ?: boolean } , ) : Promise < ChatAdministratorRights > Parameters Optionalextra : { forChannels ?: boolean } Returns Promise < ChatAdministratorRights > get My Star Balance getMyStarBalance () : Promise < StarAmount > Returns Promise < StarAmount > get Star Transactions getStarTransactions ( offset ?: number , limit ?: number ) : Promise < StarTransactions > Parameters Optionaloffset : number Optionallimit : number Returns Promise < StarTransactions > get Sticker Set getStickerSet ( setName : string ) : Promise < StickerSet > Returns Promise < StickerSet > get User Chat Boosts getUserChatBoosts () : Promise < UserChatBoosts > Returns Promise < UserChatBoosts > get User Profile Audios getUserProfileAudios ( extra ?: Omit < {} , "chat_id" | "user_id" > , ) : Promise < UserProfileAudios > Parameters Optionalextra : Omit < {} , "chat_id" | "user_id" > Returns Promise < UserProfileAudios > get User Profile Photos getUserProfilePhotos ( offset ?: number , limit ?: number , ) : Promise < UserProfilePhotos > Parameters Optionaloffset : number Optionallimit : number Returns Promise < UserProfilePhotos > gift Premium Subscription giftPremiumSubscription ( starCount : 1000 | 1500 | 2500 , monthCount : 3 | 6 | 12 , extra ?: Omit < {} , "chat_id" | "user_id" | "star_count" | "month_count" > , ) : Promise < true > Parameters starCount : 1000 | 1500 | 2500 monthCount : 3 | 6 | 12 Optionalextra : Omit < {} , "chat_id" | "user_id" | "star_count" | "month_count" > text text_parse_mode text_entities Returns Promise < true > hide General Forum Topic hideGeneralForumTopic () : Promise < true > leave Chat leaveChat ( ... args : [ ] ) : Promise < true > persistent Chat Action persistentChatAction ( action : | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , callback : () => Promise < void > , extra ?: Omit < {} , "action" | "chat_id" > & { intervalDuration ?: number } , ) : Promise < void > Parameters action : | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" callback : () => Promise < void > extra : Omit < {} , "action" | "chat_id" > & { intervalDuration ?: number } = {} OptionalintervalDuration ?: number Returns Promise < void > pin Chat Message pinChatMessage ( ... args : [ messageId
: number , extra
?: { disable_notification ?: boolean } ] , ) : Promise < true > Parameters ... args : [ messageId: number , extra?: { disable_notification ?: boolean } ] Returns Promise < true > Parameters ... args : [ userId: number , extra: Omit < {} , "chat_id" | "user_id" > ] Returns Promise < true > react react ( reaction ?: MaybeArray < (
ReactionType | TelegramEmoji | `0${string}` | `1${string}` | `2${string}` | `3${string}` | `4${string}` | `5${string}` | `6${string}` | `7${string}` | `8${string}` | `9${string}`
)
, > , is_big ?: boolean , ) : Promise < true > Parameters Optionalreaction : MaybeArray < ( ReactionType | TelegramEmoji | `0${string}` | `1${string}` | `2${string}` | `3${string}` | `4${string}` | `5${string}` | `6${string}` | `7${string}` | `8${string}` | `9${string}` ), > Optionalis_big : boolean Returns Promise < true > refund Star Payment refundStarPayment ( ... args : [ paymentChargeId
: string ] ) : Promise < true > Parameters ... args : [ paymentChargeId: string ] Returns Promise < true > remove Chat Verification removeChatVerification () : Promise < true > remove User Verification removeUserVerification () : Promise < true > reopen Forum Topic reopenForumTopic () : Promise < true > reopen General Forum Topic reopenGeneralForumTopic () : Promise < true > reply reply ( ... args : [ text
: string | FmtString < string > , extra
?: Omit < {} , "text" | "chat_id" > , ] , ) : Promise < TextMessage & BusinessSentMessage > Parameters ... args : [ text: string | FmtString < string > , extra?: Omit < {} , "text" | "chat_id" > ] Returns Promise < TextMessage & BusinessSentMessage > reply With Animation replyWithAnimation ( ... args : [ animation
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < AnimationMessage & BusinessSentMessage > Parameters ... args : [ animation: string | InputFile , extra?: { caption ?: string | FmtString < string > } , ] Returns Promise < AnimationMessage & BusinessSentMessage > reply With Audio replyWithAudio ( ... args : [ audio
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < AudioMessage & BusinessSentMessage > Parameters ... args : [ audio: string | InputFile , extra?: { caption ?: string | FmtString < string > } ] Returns Promise < AudioMessage & BusinessSentMessage > reply With Chat Action replyWithChatAction ( ... args : [ action
: | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , extra
?: Omit < {} , "action" | "chat_id" > , ] , ) : Promise < true > Parameters ... args : [ action: | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , extra?: Omit < {} , "action" | "chat_id" > , ] Returns Promise < true > Parameters ... args : [ phoneNumber: string , firstName: string , extra?: Omit < {} , "phone_number" | "chat_id" | "first_name" > , ] Returns Promise < ContactMessage & BusinessSentMessage > reply With Dice replyWithDice ( ... args : [ extra
?: Omit < {} , "chat_id" > ] , ) : Promise < DiceMessage & BusinessSentMessage > Parameters ... args : [ extra?: Omit < {} , "chat_id" > ] Returns Promise < DiceMessage & BusinessSentMessage > reply With Document replyWithDocument ( ... args : [ document
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < DocumentMessage & BusinessSentMessage > Parameters ... args : [ document: string | InputFile , extra?: { caption ?: string | FmtString < string > } ] Returns Promise < DocumentMessage & BusinessSentMessage > reply With Game replyWithGame ( ... args : [ gameName
: string , extra
?: Omit < {} , "chat_id" | "game_short_name" > , ] , ) : Promise < GameMessage & BusinessSentMessage > Parameters ... args : [ gameName: string , extra?: Omit < {} , "chat_id" | "game_short_name" > ] Returns Promise < GameMessage & BusinessSentMessage > reply With HTML replyWithHTML ( html : string , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > Parameters html : string Optionalextra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > reply With Invoice replyWithInvoice ( ... args : [ invoice
: Omit < {} , | "chat_id" | "message_thread_id" | "disable_notification" | "reply_parameters" | "reply_markup" , > , extra
?: Omit < {} , | "chat_id" | "direct_messages_topic_id" | "protect_content" | "allow_paid_broadcast" | "message_effect_id" | "suggested_post_parameters" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter" , > , ] , ) : Promise < InvoiceMessage & BusinessSentMessage > Parameters ... args : [ invoice: Omit < {} , | "chat_id" | "message_thread_id" | "disable_notification" | "reply_parameters" | "reply_markup" , > , extra?: Omit < {} , | "chat_id" | "direct_messages_topic_id" | "protect_content" | "allow_paid_broadcast" | "message_effect_id" | "suggested_post_parameters" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter" , > , ] Returns Promise < InvoiceMessage & BusinessSentMessage > reply With Location replyWithLocation ( ... args : [ latitude
: number , longitude
: number , extra
?: Omit < {} , "chat_id" | "latitude" | "longitude" > , ] , ) : Promise < LocationMessage & BusinessSentMessage > Parameters ... args : [ latitude: number , longitude: number , extra?: Omit < {} , "chat_id" | "latitude" | "longitude" > , ] Returns Promise < LocationMessage & BusinessSentMessage > reply With Markdown replyWithMarkdown ( markdown : string , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > Parameters markdown : string Optionalextra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > reply With Markdown V2 replyWithMarkdownV2 ( markdown : string , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > Parameters markdown : string Optionalextra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > Parameters ... args : [ media: MediaGroup , extra?: Omit < {} , "chat_id" | "media" > ] Returns Promise < ( (DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage )[] , > reply With Photo replyWithPhoto ( ... args : [ photo
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < PhotoMessage & BusinessSentMessage > Parameters ... args : [ photo: string | InputFile , extra?: { caption ?: string | FmtString < string > } ] Returns Promise < PhotoMessage & BusinessSentMessage > reply With Poll replyWithPoll ( ... args : [ question
: string , options
: readonly InputPollOption [] , extra
?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ] , ) : Promise < PollMessage & BusinessSentMessage > Parameters ... args : [ question: string , options: readonly InputPollOption [] , extra?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ] Returns Promise < PollMessage & BusinessSentMessage > reply With Quiz replyWithQuiz ( ... args : [ question
: string , options
: readonly InputPollOption [] , extra
?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ] , ) : Promise < PollMessage & BusinessSentMessage > Parameters ... args : [ question: string , options: readonly InputPollOption [] , extra?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ] Returns Promise < PollMessage & BusinessSentMessage > reply With Sticker replyWithSticker ( ... args : [ sticker
: string | InputFile , extra
?: Omit < {} , "chat_id" | "sticker" > , ] , ) : Promise < StickerMessage & BusinessSentMessage > Parameters ... args : [ sticker: string | InputFile , extra?: Omit < {} , "chat_id" | "sticker" > ] Returns Promise < StickerMessage & BusinessSentMessage > reply With Venue replyWithVenue ( ... args : [ latitude
: number , longitude
: number , title
: string , address
: string , extra
?: Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" , > , ] , ) : Promise < VenueMessage & BusinessSentMessage > Parameters ... args : [ latitude: number , longitude: number , title: string , address: string , extra?: Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" , > , ] Returns Promise < VenueMessage & BusinessSentMessage > reply With Video replyWithVideo ( ... args : [ video
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < VideoMessage & BusinessSentMessage > Parameters ... args : [ video: string | InputFile , extra?: { caption ?: string | FmtString < string > } ] Returns Promise < VideoMessage & BusinessSentMessage > reply With Video Note replyWithVideoNote ( ... args : [ videoNote
: string | InputFileVideoNote , extra
?: Omit < {} , "chat_id" | "video_note" > , ] , ) : Promise < VideoNoteMessage & BusinessSentMessage > Parameters ... args : [ videoNote: string | InputFileVideoNote , extra?: Omit < {} , "chat_id" | "video_note" > , ] Returns Promise < VideoNoteMessage & BusinessSentMessage > reply With Voice replyWithVoice ( ... args : [ voice
: string | InputFile , extra
?: { caption ?: string | FmtString < string > } , ] , ) : Promise < VoiceMessage & BusinessSentMessage > Parameters ... args : [ voice: string | InputFile , extra?: { caption ?: string | FmtString < string > } ] Returns Promise < VoiceMessage & BusinessSentMessage > restrict Chat Member restrictChatMember ( ... args : [ userId
: number , extra
: Omit < {} , "chat_id" | "user_id" > ] , ) : Promise < true > Parameters ... args : [ userId: number , extra: Omit < {} , "chat_id" | "user_id" > ] Returns Promise < true > revoke Chat Invite Link revokeChatInviteLink ( ... args : [ inviteLink
: string ] ) : Promise < ChatInviteLink > Parameters ... args : [ inviteLink: string ] Returns Promise < ChatInviteLink > send Animation sendAnimation ( animation : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < AnimationMessage & BusinessSentMessage > Parameters animation : string | InputFile Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < AnimationMessage & BusinessSentMessage > send Audio sendAudio ( audio : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < AudioMessage & BusinessSentMessage > Parameters audio : string | InputFile Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < AudioMessage & BusinessSentMessage > send Chat Action sendChatAction ( action : | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" , extra ?: Omit < {} , "action" | "chat_id" > , ) : Promise < true > Parameters action : | "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note" Optionalextra : Omit < {} , "action" | "chat_id" > Returns Promise < true > send Checklist sendChecklist ( businessConnectionId : string , checklist : InputChecklist , extra ?: Omit < {} , "chat_id" | "checklist" > , ) : Promise < ChecklistMessage & BusinessSentMessage > Parameters businessConnectionId : string checklist : InputChecklist Optionalextra : Omit < {} , "chat_id" | "checklist" > disable_notification protect_content message_effect_id reply_parameters reply_markup Returns Promise < ChecklistMessage & BusinessSentMessage > Parameters phoneNumber : string firstName : string Optionalextra : Omit < {} , "phone_number" | "chat_id" | "first_name" > Returns Promise < ContactMessage & BusinessSentMessage > send Dice sendDice ( extra ?: Omit < {} , "chat_id" > , ) : Promise < DiceMessage & BusinessSentMessage > Parameters Optionalextra : Omit < {} , "chat_id" > Returns Promise < DiceMessage & BusinessSentMessage > send Document sendDocument ( document : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < DocumentMessage & BusinessSentMessage > Parameters document : string | InputFile Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < DocumentMessage & BusinessSentMessage > send Game sendGame ( game : string , extra ?: Omit < {} , "chat_id" | "game_short_name" > , ) : Promise < GameMessage & BusinessSentMessage > Parameters game : string Optionalextra : Omit < {} , "chat_id" | "game_short_name" > Returns Promise < GameMessage & BusinessSentMessage > send Gift sendGift ( giftId : string , extra ?: Omit < {} , "chat_id" | "gift_id" > ) : Promise < true > Parameters giftId : string Optionalextra : Omit < {} , "chat_id" | "gift_id" > user_id chat_id pay_for_upgrade text text_parse_mode text_entities Returns Promise < true > send Invoice sendInvoice ( invoice : NewInvoiceParameters , extra ?: Omit < {} , | "chat_id" | "direct_messages_topic_id" | "protect_content" | "allow_paid_broadcast" | "message_effect_id" | "suggested_post_parameters" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter" , > , ) : Promise < InvoiceMessage & BusinessSentMessage > Parameters invoice : NewInvoiceParameters Optionalextra : Omit < {} , | "chat_id" | "direct_messages_topic_id" | "protect_content" | "allow_paid_broadcast" | "message_effect_id" | "suggested_post_parameters" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter" , > Returns Promise < InvoiceMessage & BusinessSentMessage > send Location sendLocation ( latitude : number , longitude : number , extra ?: Omit < {} , "chat_id" | "latitude" | "longitude" > , ) : Promise < LocationMessage & BusinessSentMessage > Parameters latitude : number longitude : number Optionalextra : Omit < {} , "chat_id" | "latitude" | "longitude" > Returns Promise < LocationMessage & BusinessSentMessage > Parameters media : MediaGroup Optionalextra : Omit < {} , "chat_id" | "media" > Returns Promise < ( (DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage )[] , > send Message sendMessage ( text : string | FmtString < string > , extra ?: Omit < {} , "text" | "chat_id" > , ) : Promise < TextMessage & BusinessSentMessage > Parameters text : string | FmtString < string > Optionalextra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > send Message Draft sendMessageDraft ( draftId : number , text : string , extra ?: Omit < {} , "text" | "chat_id" | "draft_id" > , ) : Promise < true > Parameters draftId : number text : string Optionalextra : Omit < {} , "text" | "chat_id" | "draft_id" > message_thread_id parse_mode entities Returns Promise < true > Parameters starCount : number media : PaidMediaGroup Optionalextra : Omit < {} , "caption" | "chat_id" | "media" | "star_count" > Returns Promise < PaidMediaMessage & BusinessSentMessage > send Photo sendPhoto ( photo : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < PhotoMessage & BusinessSentMessage > Parameters photo : string | InputFile Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < PhotoMessage & BusinessSentMessage > send Poll sendPoll ( poll : string , options : readonly InputPollOption [] , extra ?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ) : Promise < PollMessage & BusinessSentMessage > Parameters poll : string options : readonly InputPollOption [] Optionalextra : Omit < {} , "type" | "chat_id" | "question" | "options" > Returns Promise < PollMessage & BusinessSentMessage > send Quiz sendQuiz ( quiz : string , options : readonly InputPollOption [] , extra ?: Omit < {} , "type" | "chat_id" | "question" | "options" > , ) : Promise < PollMessage & BusinessSentMessage > Parameters quiz : string options : readonly InputPollOption [] Optionalextra : Omit < {} , "type" | "chat_id" | "question" | "options" > Returns Promise < PollMessage & BusinessSentMessage > send Sticker sendSticker ( sticker : string | InputFile , extra ?: Omit < {} , "chat_id" | "sticker" > , ) : Promise < StickerMessage & BusinessSentMessage > Parameters sticker : string | InputFile Optionalextra : Omit < {} , "chat_id" | "sticker" > Returns Promise < StickerMessage & BusinessSentMessage > send Venue sendVenue ( latitude : number , longitude : number , title : string , address : string , extra ?: Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" , > , ) : Promise < VenueMessage & BusinessSentMessage > Parameters latitude : number longitude : number title : string address : string Optionalextra : Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" > Returns Promise < VenueMessage & BusinessSentMessage > send Video sendVideo ( video : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < VideoMessage & BusinessSentMessage > Parameters video : string | InputFile Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < VideoMessage & BusinessSentMessage > send Video Note sendVideoNote ( videoNote : string | InputFileVideoNote , extra ?: Omit < {} , "chat_id" | "video_note" > , ) : Promise < VideoNoteMessage & BusinessSentMessage > Parameters videoNote : string | InputFileVideoNote Optionalextra : Omit < {} , "chat_id" | "video_note" > Returns Promise < VideoNoteMessage & BusinessSentMessage > send Voice sendVoice ( voice : string | InputFile , extra ?: { caption ?: string | FmtString < string > } , ) : Promise < VoiceMessage & BusinessSentMessage > Parameters voice : string | InputFile Optionalextra : { caption ?: string | FmtString < string > } Returns Promise < VoiceMessage & BusinessSentMessage > set Chat Administrator Custom Title setChatAdministratorCustomTitle ( ... args : [ userId
: number , title
: string ] , ) : Promise < true > Parameters ... args : [ userId: number , title: string ] Returns Promise < true > set Chat Description setChatDescription ( ... args : [ description
?: string ] ) : Promise < true > Parameters ... args : [ description?: string ] Returns Promise < true > Parameters OptionalmenuButton : MenuButton Returns Promise < true > set Chat Permissions setChatPermissions ( ... args : [ permissions
: ChatPermissions , extra
?: Omit < {} , "chat_id" | "permissions" > , ] , ) : Promise < true > Parameters ... args : [ permissions: ChatPermissions , extra?: Omit < {} , "chat_id" | "permissions" > ] Returns Promise < true > set Chat Photo setChatPhoto ( ... args : [ photo
: InputFile ] ) : Promise < true > Parameters ... args : [ photo: InputFile ] Returns Promise < true > set Chat Sticker Set setChatStickerSet ( setName : string ) : Promise < true > set Chat Title setChatTitle ( ... args : [ title
: string ] ) : Promise < true > set Custom Emoji Sticker Set Thumbnail setCustomEmojiStickerSetThumbnail ( ... args : [ name
: string , custom_emoji_id
: string ] , ) : Promise < true > Parameters ... args : [ name: string , custom_emoji_id: string ] Returns Promise < true > set My Commands setMyCommands ( commands : readonly BotCommand [] ) : Promise < true > Parameters commands : readonly BotCommand [] Returns Promise < true > set My Default Administrator Rights setMyDefaultAdministratorRights ( extra ?: { forChannels ?: boolean ; rights ?: ChatAdministratorRights } , ) : Promise < true > Parameters Optionalextra : { forChannels ?: boolean ; rights ?: ChatAdministratorRights } Returns Promise < true > set Passport Data Errors setPassportDataErrors ( errors : readonly PassportElementError [] ) : Promise < true > Parameters errors : readonly PassportElementError [] Returns Promise < true > set Sticker Emoji List setStickerEmojiList ( ... args : [ sticker
: string , emoji_list
: string [] ] , ) : Promise < true > Parameters ... args : [ sticker: string , emoji_list: string [] ] Returns Promise < true > set Sticker Keywords setStickerKeywords ( ... args : [ sticker
: string , keywords
?: string [] ] , ) : Promise < true > Parameters ... args : [ sticker: string , keywords?: string [] ] Returns Promise < true > set Sticker Mask Position setStickerMaskPosition ( ... args : [ sticker
: string , mask_position
?: MaskPosition ] , ) : Promise < true > Parameters ... args : [ sticker: string , mask_position?: MaskPosition ] Returns Promise < true > set Sticker Position In Set setStickerPositionInSet ( sticker : string , position : number ) : Promise < true > Parameters sticker : string position : number Returns Promise < true > set Sticker Set Thumb setStickerSetThumb ( ... args : [ name
: string , userId
: number , thumbnail
?: string | InputFile , format
: "video" | "static" | "animated" , ] , ) : Promise < true > Parameters ... args : [ name: string , userId: number , thumbnail?: string | InputFile , format: "video" | "static" | "animated" , ] Returns Promise < true > set Sticker Set Thumbnail setStickerSetThumbnail ( ... args : [ name
: string , userId
: number , thumbnail
?: string | InputFile , format
: "video" | "static" | "animated" , ] , ) : Promise < true > Parameters ... args : [ name: string , userId: number , thumbnail?: string | InputFile , format: "video" | "static" | "animated" , ] Returns Promise < true > set Sticker Set Title setStickerSetTitle ( ... args : [ name
: string , title
: string ] ) : Promise < true > Parameters ... args : [ name: string , title: string ] Returns Promise < true > set User Emoji Status setUserEmojiStatus ( extra ?: Omit < {} , "chat_id" | "user_id" > ) : Promise < true > Parameters Optionalextra : Omit < {} , "chat_id" | "user_id" > Returns Promise < true > stop Message Live Location stopMessageLiveLocation ( markup ?: InlineKeyboardMarkup , ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > Parameters Optionalmarkup : InlineKeyboardMarkup Returns Promise < true | Edited & LocationMessage & BusinessSentMessage > stop Poll stopPoll ( ... args : [ messageId
: number , extra
?: Omit < {} , "chat_id" | "message_id" > ] , ) : Promise < Poll > Parameters ... args : [ messageId: number , extra?: Omit < {} , "chat_id" | "message_id" > ] Returns Promise < Poll > unban Chat Member unbanChatMember ( ... args : [ userId
: number , extra
?: { only_if_banned ?: boolean } ] , ) : Promise < true > Parameters ... args : [ userId: number , extra?: { only_if_banned ?: boolean } ] Returns Promise < true > unban Chat Sender Chat unbanChatSenderChat ( senderChatId : number ) : Promise < true > unhide General Forum Topic unhideGeneralForumTopic () : Promise < true > unpin All Chat Messages unpinAllChatMessages ( ... args : [ ] ) : Promise < true > unpin All Forum Topic Messages unpinAllForumTopicMessages () : Promise < true > unpin All General Forum Topic Messages unpinAllGeneralForumTopicMessages () : Promise < true > unpin Chat Message unpinChatMessage ( ... args : [ messageId
?: number ] ) : Promise < true > Parameters ... args : [ messageId?: number ] Returns Promise < true > upload Sticker File uploadStickerFile ( ... args : [ sticker
: InputFile , sticker_format
: "video" | "static" | "animated" , ] , ) : Promise < File > Parameters ... args : [ sticker: InputFile , sticker_format: "video" | "static" | "animated" ] Returns Promise < File > verify Chat verifyChat ( ... args : [ extra
?: Omit < {} , "chat_id" > ] ) : Promise < true > Parameters ... args : [ extra?: Omit < {} , "chat_id" > ] Returns Promise < true > verify User verifyUser ( ... args : [ extra
?: Omit < {} , "chat_id" | "user_id" > ] ) : Promise < true > Parameters ... args : [ extra?: Omit < {} , "chat_id" | "user_id" > ] Returns Promise < true >
See
https://core.telegram.org/bots/api#banchatmember