Interface WizardContext<D> interface WizardContext < D > { botInfo : UserFromGetMe ; scene : SceneContextScene < WizardContext < D > , D > ; session : WizardSession < D > ; state : Record < string | symbol , any > ; telegram : Telegram ; update : Update ; wizard : WizardContextWizard < WizardContext < D > > ; get callbackQuery (): PropOr < U , "callback_query" > ; get channelPost (): PropOr < U , "channel_post" > ; get chat (): PropOr < GetUpdateContent < U > , "chat" , undefined > ; 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 editedChannelPost (): PropOr < U , "edited_channel_post" > ; get editedMessage (): PropOr < U , "edited_message" > ; get from (): GetUserFromAnySource < U > ; get inlineMessageId (): undefined | string ; get inlineQuery (): PropOr < U , "inline_query" > ; get kickChatMember (): ( ( ... args ) => 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 (): undefined | PassportData ; get poll (): PropOr < U , "poll" > ; get pollAnswer (): PropOr < U , "poll_answer" > ; get preCheckoutQuery (): PropOr < U , "pre_checkout_query" > ; 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 (): undefined | { button_text : string ; data : { json < T > ( ) : T ; text ( ) : string ; } ; } ; webhookReply : boolean ; addStickerToSet ( ... args ) : Promise < true > ; answerCbQuery ( ... args ) : Promise < true > ; answerGameQuery ( ... args ) : Promise < true > ; answerInlineQuery ( ... args ) : Promise < true > ; answerPreCheckoutQuery ( ... args ) : Promise < true > ; answerShippingQuery ( ... args ) : Promise < true > ; approveChatJoinRequest ( userId ) : Promise < true > ; banChatMember ( ... args ) : Promise < true > ; banChatSenderChat ( senderChatId ) : Promise < true > ; closeForumTopic ( ) : Promise < true > ; closeGeneralForumTopic ( ) : Promise < true > ; copyMessage ( chatId ,
extra ? ) : Promise < MessageId > ; copyMessages ( chatId ,
messageIds ,
extra ? ) : Promise < MessageId [] > ; createChatInviteLink ( ... args ) : Promise < ChatInviteLink > ; createForumTopic ( ... args ) : Promise < ForumTopic > ; createNewStickerSet ( ... args ) : Promise < true > ; declineChatJoinRequest ( userId ) : Promise < true > ; deleteChatPhoto ( ... args ) : Promise < true > ; deleteChatStickerSet ( ) : Promise < true > ; deleteForumTopic ( ) : Promise < true > ; deleteMessage ( messageId ? ) : Promise < true > ; deleteMessages ( messageIds ) : Promise < true > ; deleteStickerFromSet ( sticker ) : Promise < true > ; deleteStickerSet ( ... args ) : Promise < true > ; editChatInviteLink ( ... args ) : Promise < ChatInviteLink > ; editForumTopic ( extra ) : Promise < true > ; editGeneralForumTopic ( name ) : Promise < true > ; editMessageCaption ( caption ,
extra ? ) : Promise < true | Edited & CaptionableMessage & BusinessSentMessage > ; editMessageLiveLocation ( latitude ,
longitude ,
extra ? ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > ; editMessageMedia ( media ,
extra ? ) : Promise < true | ( Edited & (Message & BusinessSentMessage)
) > ; editMessageReplyMarkup ( markup ) : Promise < true | ( Edited & (Message & BusinessSentMessage)
) > ; editMessageText ( text ,
extra ? ) : Promise < true | Edited & TextMessage & BusinessSentMessage > ; entities < EntityTypes > ( ... types ) : ( MessageEntity & { fragment : string ; type : SelectedTypes ; } ) [] ; exportChatInviteLink ( ... args ) : Promise < string > ; forwardMessage ( chatId ,
extra ? ) : Promise < Message & BusinessSentMessage > ; forwardMessages ( chatId ,
messageIds ,
extra ? ) : Promise < MessageId [] > ; getChat ( ... args ) : Promise < ChatFullInfo > ; getChatAdministrators ( ... args ) : Promise < ( ChatMemberOwner | ChatMemberAdministrator ) [] > ; getChatMember ( ... args ) : Promise < ChatMember > ; getChatMembersCount ( ... args ) : Promise < number > ; getChatMenuButton ( ) : Promise < MenuButton > ; getMyCommands ( ) : Promise < BotCommand [] > ; getMyDefaultAdministratorRights ( extra ? ) : Promise < ChatAdministratorRights > ; getStickerSet ( setName ) : Promise < StickerSet > ; getUserChatBoosts ( ) : Promise < UserChatBoosts > ; has < Filter > ( filters ) : this is FilteredContext < Context < Update > , Filter > ; hideGeneralForumTopic ( ) : Promise < true > ; leaveChat ( ... args ) : Promise < true > ; persistentChatAction ( action ,
callback ,
extra ? ) : Promise < void > ; pinChatMessage ( ... args ) : Promise < true > ; promoteChatMember ( ... args ) : Promise < true > ; react ( reaction ? ,
is_big ? ) : Promise < true > ; reopenForumTopic ( ) : Promise < true > ; reopenGeneralForumTopic ( ) : Promise < true > ; reply ( ... args ) : Promise < TextMessage & BusinessSentMessage > ; replyWithAnimation ( ... args ) : Promise < AnimationMessage & BusinessSentMessage > ; replyWithAudio ( ... args ) : Promise < AudioMessage & BusinessSentMessage > ; replyWithChatAction ( ... args ) : Promise < true > ; replyWithContact ( ... args ) : Promise < ContactMessage & BusinessSentMessage > ; replyWithDice ( ... args ) : Promise < DiceMessage & BusinessSentMessage > ; replyWithDocument ( ... args ) : Promise < DocumentMessage & BusinessSentMessage > ; replyWithGame ( ... args ) : Promise < GameMessage & BusinessSentMessage > ; replyWithHTML ( html ,
extra ? ) : Promise < TextMessage & BusinessSentMessage > ; replyWithInvoice ( ... args ) : Promise < InvoiceMessage & BusinessSentMessage > ; replyWithLocation ( ... args ) : Promise < LocationMessage & BusinessSentMessage > ; replyWithMarkdown ( markdown ,
extra ? ) : Promise < TextMessage & BusinessSentMessage > ; replyWithMarkdownV2 ( markdown ,
extra ? ) : Promise < TextMessage & BusinessSentMessage > ; replyWithMediaGroup ( ... args ) : Promise < ( ( DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage ) [] > ; replyWithPhoto ( ... args ) : Promise < PhotoMessage & BusinessSentMessage > ; replyWithPoll ( ... args ) : Promise < PollMessage & BusinessSentMessage > ; replyWithQuiz ( ... args ) : Promise < PollMessage & BusinessSentMessage > ; replyWithSticker ( ... args ) : Promise < StickerMessage & BusinessSentMessage > ; replyWithVenue ( ... args ) : Promise < VenueMessage & BusinessSentMessage > ; replyWithVideo ( ... args ) : Promise < VideoMessage & BusinessSentMessage > ; replyWithVideoNote ( ... args ) : Promise < VideoNoteMessage & BusinessSentMessage > ; replyWithVoice ( ... args ) : Promise < VoiceMessage & BusinessSentMessage > ; restrictChatMember ( ... args ) : Promise < true > ; revokeChatInviteLink ( ... args ) : Promise < ChatInviteLink > ; sendAnimation ( animation ,
extra ? ) : Promise < AnimationMessage & BusinessSentMessage > ; sendAudio ( audio ,
extra ? ) : Promise < AudioMessage & BusinessSentMessage > ; sendChatAction ( action ,
extra ? ) : Promise < true > ; sendContact ( phoneNumber ,
firstName ,
extra ? ) : Promise < ContactMessage & BusinessSentMessage > ; sendDice ( extra ? ) : Promise < DiceMessage & BusinessSentMessage > ; sendDocument ( document ,
extra ? ) : Promise < DocumentMessage & BusinessSentMessage > ; sendGame ( game ,
extra ? ) : Promise < GameMessage & BusinessSentMessage > ; sendInvoice ( invoice ,
extra ? ) : Promise < InvoiceMessage & BusinessSentMessage > ; sendLocation ( latitude ,
longitude ,
extra ? ) : Promise < LocationMessage & BusinessSentMessage > ; sendMediaGroup ( media ,
extra ? ) : Promise < ( ( DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage ) [] > ; sendMessage ( text ,
extra ? ) : Promise < TextMessage & BusinessSentMessage > ; sendPhoto ( photo ,
extra ? ) : Promise < PhotoMessage & BusinessSentMessage > ; sendPoll ( poll ,
options ,
extra ? ) : Promise < PollMessage & BusinessSentMessage > ; sendQuiz ( quiz ,
options ,
extra ? ) : Promise < PollMessage & BusinessSentMessage > ; sendSticker ( sticker ,
extra ? ) : Promise < StickerMessage & BusinessSentMessage > ; sendVenue ( latitude ,
longitude ,
title ,
address ,
extra ? ) : Promise < VenueMessage & BusinessSentMessage > ; sendVideo ( video ,
extra ? ) : Promise < VideoMessage & BusinessSentMessage > ; sendVideoNote ( videoNote ,
extra ? ) : Promise < VideoNoteMessage & BusinessSentMessage > ; sendVoice ( voice ,
extra ? ) : Promise < VoiceMessage & BusinessSentMessage > ; setChatAdministratorCustomTitle ( ... args ) : Promise < true > ; setChatDescription ( ... args ) : Promise < true > ; setChatMenuButton ( menuButton ? ) : Promise < true > ; setChatPermissions ( ... args ) : Promise < true > ; setChatPhoto ( ... args ) : Promise < true > ; setChatStickerSet ( setName ) : Promise < true > ; setChatTitle ( ... args ) : Promise < true > ; setCustomEmojiStickerSetThumbnail ( ... args ) : Promise < true > ; setMyCommands ( commands ) : Promise < true > ; setMyDefaultAdministratorRights ( extra ? ) : Promise < true > ; setPassportDataErrors ( errors ) : Promise < true > ; setStickerEmojiList ( ... args ) : Promise < true > ; setStickerKeywords ( ... args ) : Promise < true > ; setStickerMaskPosition ( ... args ) : Promise < true > ; setStickerPositionInSet ( sticker ,
position ) : Promise < true > ; setStickerSetThumb ( ... args ) : Promise < true > ; setStickerSetThumbnail ( ... args ) : Promise < true > ; setStickerSetTitle ( ... args ) : Promise < true > ; stopMessageLiveLocation ( markup ? ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > ; stopPoll ( ... args ) : Promise < Poll > ; unbanChatMember ( ... args ) : Promise < true > ; unbanChatSenderChat ( senderChatId ) : Promise < true > ; unhideGeneralForumTopic ( ) : Promise < true > ; unpinAllChatMessages ( ... args ) : Promise < true > ; unpinAllForumTopicMessages ( ) : Promise < true > ; unpinAllGeneralForumTopicMessages ( ) : Promise < true > ; unpinChatMessage ( ... args ) : Promise < true > ; uploadStickerFile ( ... args ) : Promise < File > ; } Properties Readonly bot bot : UserFromGetMe
Readonly state state : Record < string | symbol , any > = {}
Readonly update update : Update
Accessors callback get callbackQuery( ) : PropOr < U , "callback_query" > Returns PropOr < U , "callback_query" > channel get channelPost( ) : PropOr < U , "channel_post" > Returns PropOr < U , "channel_post" > chat get chat( ) : PropOr < GetUpdateContent < U > , "chat" , undefined > Returns PropOr < GetUpdateContent < U > , "chat" , undefined > chat get chatBoost( ) : PropOr < U , "chat_boost" > Returns PropOr < U , "chat_boost" > chat get chatJoinRequest( ) : PropOr < U , "chat_join_request" > Returns PropOr < U , "chat_join_request" > chat get chatMember( ) : PropOr < U , "chat_member" > Returns PropOr < U , "chat_member" > chosen get chosenInlineResult( ) : PropOr < U , "chosen_inline_result" > Returns PropOr < U , "chosen_inline_result" > edited get editedChannelPost( ) : PropOr < U , "edited_channel_post" > Returns PropOr < U , "edited_channel_post" > edited get editedMessage( ) : PropOr < U , "edited_message" > Returns PropOr < U , "edited_message" > from get from( ) : GetUserFromAnySource < U > Returns GetUserFromAnySource < U > inline get inlineMessageId( ) : undefined | string Returns undefined | string inline get inlineQuery( ) : PropOr < U , "inline_query" > Returns PropOr < U , "inline_query" > kick get kickChatMember( ) : ( ( ... args ) => Promise < true > ) Returns ( ( ... args ) => Promise < true > ) ( ... args ) : Promise < true > Parameters Rest ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > ] Returns Promise < true > me get me( ) : string Returns string message get message( ) : PropOr < U , "message" > Returns PropOr < U , "message" > message get messageReaction( ) : PropOr < U , "message_reaction" > Returns PropOr < U , "message_reaction" > message get messageReactionCount( ) : PropOr < U , "message_reaction_count" > Returns PropOr < U , "message_reaction_count" > msg get msg( ) : GetMsg < U > & Msg Returns GetMsg < U > & Msg msg get msgId( ) : GetMsgId < U > Returns GetMsgId < U > my get myChatMember( ) : PropOr < U , "my_chat_member" > Returns PropOr < U , "my_chat_member" > passport get passportData( ) : undefined | PassportData Returns undefined | PassportData poll get poll( ) : PropOr < U , "poll" > Returns PropOr < U , "poll" > poll get pollAnswer( ) : PropOr < U , "poll_answer" > Returns PropOr < U , "poll_answer" > pre get preCheckoutQuery( ) : PropOr < U , "pre_checkout_query" > Returns PropOr < U , "pre_checkout_query" > reactions get reactions( ) : MessageReactions Returns MessageReactions removed get removedChatBoost( ) : PropOr < U , "removed_chat_boost" > Returns PropOr < U , "removed_chat_boost" > sender get senderChat( ) : PropOr < GetUpdateContent < U > , "sender_chat" , undefined > Returns PropOr < GetUpdateContent < U > , "sender_chat" , undefined > shipping get shippingQuery( ) : PropOr < U , "shipping_query" > Returns PropOr < U , "shipping_query" > text get text( ) : GetText < U > Returns GetText < U > web get webAppData( ) : undefined | { button_text : string ; data : { json < T > ( ) : T ; text ( ) : string ; } ; } Returns undefined | { button_text : string ; data : { json < T > ( ) : T ; text ( ) : string ; } ; } webhook get webhookReply( ) : boolean Returns boolean set webhookReply( enable ) : void Returns void Methods add add ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string , stickerData: Omit < {} , "chat_id" | "name" | "user_id" > ] Returns Promise < true > answer answer ( ... args ) : Promise < true > Parameters Rest ... args : [ text?: string , extra?: Omit < {} , "text" | "chat_id" | "callback_query_id" > ] Returns Promise < true > answer answer ( ... args ) : Promise < true > Parameters Rest ... args : [ url: string ] Returns Promise < true > answer answer ( ... args ) : Promise < true > Parameters Rest ... args : [ results: readonly InlineQueryResult [] , extra?: Omit < {} , "chat_id" | "inline_query_id" | "results" > ] Returns Promise < true > answer answer ( ... args ) : Promise < true > Parameters Rest ... args : [ ok: boolean , errorMessage?: string ] Returns Promise < true > answer answer ( ... args ) : Promise < true > Parameters Rest ... args : [ ok: boolean , shippingOptions: readonly ShippingOption [] , errorMessage: string ] Returns Promise < true > approve approve ( userId ) : Promise < true > Returns Promise < true > ban ban ( ... args ) : Promise < true > Parameters Rest ... args : [ userId: number , untilDate?: number , extra?: Omit < {} , "chat_id" | "user_id" | "until_date" > ] Returns Promise < true > ban ban ( senderChatId ) : Promise < true > Returns Promise < true > close close ( ) : Promise < true > Returns Promise < true > close close ( ) : Promise < true > Returns Promise < true > copy copy ( chatId , extra ? ) : Promise < MessageId > Parameters chatId : string | number Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < MessageId > copy copy ( chatId , messageIds , extra ? ) : Promise < MessageId [] > Parameters chatId : string | number messageIds : number [] Optional extra : Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > Returns Promise < MessageId [] > create create ( ... args ) : Promise < ChatInviteLink > Parameters Rest ... args : [ extra?: Omit < {} , "chat_id" > ] Returns Promise < ChatInviteLink > create create ( ... args ) : Promise < ForumTopic > Parameters Rest ... args : [ name: string , extra?: Omit < {} , "chat_id" | "name" > ] Returns Promise < ForumTopic > create create ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string , title: string , stickerData: Omit < {} , "chat_id" | "name" | "user_id" | "title" > ] Returns Promise < true > decline decline ( userId ) : Promise < true > Returns Promise < true > delete delete ( ... args ) : Promise < true > Returns Promise < true > delete delete ( ) : Promise < true > Returns Promise < true > delete delete ( ) : Promise < true > Returns Promise < true > delete delete ( messageId ? ) : Promise < true > Parameters Optional messageId : number Returns Promise < true > delete delete ( messageIds ) : Promise < true > Returns Promise < true > delete delete ( sticker ) : Promise < true > Returns Promise < true > delete delete ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string ] Returns Promise < true > edit edit ( ... args ) : Promise < ChatInviteLink > Parameters Rest ... args : [ inviteLink: string , extra?: Omit < {} , "chat_id" | "invite_link" > ] Returns Promise < ChatInviteLink > edit edit ( extra ) : Promise < true > Parameters extra : Omit < {} , "chat_id" | "message_thread_id" > Returns Promise < true > edit edit ( name ) : Promise < true > Returns Promise < true > edit edit ( caption , extra ? ) : Promise < true | Edited & CaptionableMessage & BusinessSentMessage > Parameters caption : undefined | string | FmtString < string > Optional extra : Omit < {} , "caption" | "chat_id" | "message_id" | "inline_message_id" > Returns Promise < true | Edited & CaptionableMessage & BusinessSentMessage > edit edit ( latitude , longitude , extra ? ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > Parameters latitude : number longitude : number Optional extra : Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude" > Returns Promise < true | Edited & LocationMessage & BusinessSentMessage > edit edit ( media , extra ? ) : Promise < true | ( Edited & (Message & BusinessSentMessage)) > Parameters media : { caption ?: string | FmtString < string > ; } | { caption ?: string | FmtString < string > ; } | { caption ?: string | FmtString < string > ; } | { caption ?: string | FmtString < string > ; } | { caption ?: string | FmtString < string > ; } Optional extra : Omit < {} , "chat_id" | "message_id" | "inline_message_id" | "media" > Returns Promise < true | ( Edited & (Message & BusinessSentMessage)) > edit edit ( markup ) : Promise < true | ( Edited & (Message & BusinessSentMessage)) > Parameters markup : undefined | InlineKeyboardMarkup Returns Promise < true | ( Edited & (Message & BusinessSentMessage)) > edit edit ( text , extra ? ) : Promise < true | Edited & TextMessage & BusinessSentMessage > Parameters text : string | FmtString < string > Optional extra : Omit < {} , "text" | "chat_id" | "message_id" | "inline_message_id" > Returns Promise < true | Edited & TextMessage & BusinessSentMessage > entities entities < EntityTypes > ( ... types ) : ( 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 export ( ... args ) : Promise < string > Returns Promise < string > forward forward ( chatId , extra ? ) : Promise < Message & BusinessSentMessage > Parameters chatId : string | number Optional extra : Omit < {} , "chat_id" | "from_chat_id" | "message_id" > Returns Promise < Message & BusinessSentMessage > forward forward ( chatId , messageIds , extra ? ) : Promise < MessageId [] > Parameters chatId : string | number messageIds : number [] Optional extra : Omit < {} , "chat_id" | "from_chat_id" | "message_ids" > Returns Promise < MessageId [] > get get ( ... args ) : Promise < ChatFullInfo > Returns Promise < ChatFullInfo > get get ( ... args ) : Promise < ( ChatMemberOwner | ChatMemberAdministrator ) [] > Returns Promise < ( ChatMemberOwner | ChatMemberAdministrator ) [] > get get ( ... args ) : Promise < ChatMember > Parameters Rest ... args : [ userId: number ] Returns Promise < ChatMember > get get ( ... args ) : Promise < number > Returns Promise < number > get get ( ) : Promise < MenuButton > Returns Promise < MenuButton > get get ( ) : Promise < BotCommand [] > Returns Promise < BotCommand [] > get get ( extra ? ) : Promise < ChatAdministratorRights > Parameters Optional extra : { forChannels ?: boolean ; } Optional for ?: boolean Returns Promise < ChatAdministratorRights > get get ( setName ) : Promise < StickerSet > Returns Promise < StickerSet > get get ( ) : Promise < UserChatBoosts > Returns Promise < UserChatBoosts > hide hide ( ) : Promise < true > Returns Promise < true > leave leave ( ... args ) : Promise < true > Returns Promise < true > persistent persistent ( action , callback , extra ? ) : 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 > ) ( ) : Promise < void > Returns Promise < void > extra : Omit < {} , "action" | "chat_id" > & { intervalDuration ?: number ; } = {} Returns Promise < void > pin pin ( ... args ) : Promise < true > Parameters Rest ... args : [ messageId: number , extra?: { disable_notification ?: boolean ; } ] Returns Promise < true > promote promote ( ... args ) : Promise < true > Parameters Rest ... args : [ userId: number , extra: Omit < {} , "chat_id" | "user_id" > ] Returns Promise < true > react react ( reaction ? , is_big ? ) : Promise < true > Parameters Optional reaction : MaybeArray < ( ReactionType | TelegramEmoji | `0${string}` | `1${string}` | `2${string}` | `3${string}` | `4${string}` | `5${string}` | `6${string}` | `7${string}` | `8${string}` | `9${string}`) > Optional is_big : boolean Returns Promise < true > reopen reopen ( ) : Promise < true > Returns Promise < true > reopen reopen ( ) : Promise < true > Returns Promise < true > reply reply ( ... args ) : Promise < TextMessage & BusinessSentMessage > Parameters Rest ... args : [ text: string | FmtString < string > , extra?: Omit < {} , "text" | "chat_id" > ] Returns Promise < TextMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < AnimationMessage & BusinessSentMessage > Parameters Rest ... args : [ animation: string | InputFile , extra?: { caption ?: string | FmtString < string > ; } ] Returns Promise < AnimationMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < AudioMessage & BusinessSentMessage > Parameters Rest ... args : [ audio: string | InputFile , extra?: { caption ?: string | FmtString < string > ; } ] Returns Promise < AudioMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < true > Parameters Rest ... 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 > reply reply ( ... args ) : Promise < ContactMessage & BusinessSentMessage > Parameters Rest ... args : [ phoneNumber: string , firstName: string , extra?: Omit < {} , "phone_number" | "chat_id" | "first_name" > ] Returns Promise < ContactMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < DiceMessage & BusinessSentMessage > Parameters Rest ... args : [ extra?: Omit < {} , "chat_id" > ] Returns Promise < DiceMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < DocumentMessage & BusinessSentMessage > Parameters Rest ... args : [ document: string | InputFile , extra?: { caption ?: string | FmtString < string > ; } ] Returns Promise < DocumentMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < GameMessage & BusinessSentMessage > Parameters Rest ... args : [ gameName: string , extra?: Omit < {} , "chat_id" | "game_short_name" > ] Returns Promise < GameMessage & BusinessSentMessage > reply reply ( html , extra ? ) : Promise < TextMessage & BusinessSentMessage > Parameters html : string Optional extra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < InvoiceMessage & BusinessSentMessage > Parameters Rest ... 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 reply ( ... args ) : Promise < LocationMessage & BusinessSentMessage > Parameters Rest ... args : [ latitude: number , longitude: number , extra?: Omit < {} , "chat_id" | "latitude" | "longitude" > ] Returns Promise < LocationMessage & BusinessSentMessage > reply reply ( markdown , extra ? ) : Promise < TextMessage & BusinessSentMessage > Parameters markdown : string Optional extra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > reply reply ( markdown , extra ? ) : Promise < TextMessage & BusinessSentMessage > Parameters markdown : string Optional extra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < ( ( DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage ) [] > Parameters Rest ... args : [ media: MediaGroup , extra?: Omit < {} , "chat_id" | "media" > ] Returns Promise < ( ( DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage ) [] > reply reply ( ... args ) : Promise < PhotoMessage & BusinessSentMessage > Parameters Rest ... args : [ photo: string | InputFile , extra?: { caption ?: string | FmtString < string > ; } ] Returns Promise < PhotoMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < PollMessage & BusinessSentMessage > Parameters Rest ... args : [ question: string , options: readonly InputPollOption [] , extra?: Omit < {} , "type" | "chat_id" | "question" | "options" > ] Returns Promise < PollMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < PollMessage & BusinessSentMessage > Parameters Rest ... args : [ question: string , options: readonly InputPollOption [] , extra?: Omit < {} , "type" | "chat_id" | "question" | "options" > ] Returns Promise < PollMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < StickerMessage & BusinessSentMessage > Parameters Rest ... args : [ sticker: string | InputFile , extra?: Omit < {} , "chat_id" | "sticker" > ] Returns Promise < StickerMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < VenueMessage & BusinessSentMessage > Parameters Rest ... args : [ latitude: number , longitude: number , title: string , address: string , extra?: Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" > ] Returns Promise < VenueMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < VideoMessage & BusinessSentMessage > Parameters Rest ... args : [ video: string | InputFile , extra?: { caption ?: string | FmtString < string > ; } ] Returns Promise < VideoMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < VideoNoteMessage & BusinessSentMessage > Parameters Rest ... args : [ videoNote: string | InputFileVideoNote , extra?: Omit < {} , "chat_id" | "video_note" > ] Returns Promise < VideoNoteMessage & BusinessSentMessage > reply reply ( ... args ) : Promise < VoiceMessage & BusinessSentMessage > Parameters Rest ... args : [ voice: string | InputFile , extra?: { caption ?: string | FmtString < string > ; } ] Returns Promise < VoiceMessage & BusinessSentMessage > restrict restrict ( ... args ) : Promise < true > Parameters Rest ... args : [ userId: number , extra: Omit < {} , "chat_id" | "user_id" > ] Returns Promise < true > revoke revoke ( ... args ) : Promise < ChatInviteLink > Parameters Rest ... args : [ inviteLink: string ] Returns Promise < ChatInviteLink > send send ( animation , extra ? ) : Promise < AnimationMessage & BusinessSentMessage > Parameters animation : string | InputFile Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < AnimationMessage & BusinessSentMessage > send send ( audio , extra ? ) : Promise < AudioMessage & BusinessSentMessage > Parameters audio : string | InputFile Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < AudioMessage & BusinessSentMessage > send send ( action , extra ? ) : 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" Optional extra : Omit < {} , "action" | "chat_id" > Returns Promise < true > send send ( phoneNumber , firstName , extra ? ) : Promise < ContactMessage & BusinessSentMessage > Parameters phoneNumber : string firstName : string Optional extra : Omit < {} , "phone_number" | "chat_id" | "first_name" > Returns Promise < ContactMessage & BusinessSentMessage > send send ( extra ? ) : Promise < DiceMessage & BusinessSentMessage > Parameters Optional extra : Omit < {} , "chat_id" > Returns Promise < DiceMessage & BusinessSentMessage > send send ( document , extra ? ) : Promise < DocumentMessage & BusinessSentMessage > Parameters document : string | InputFile Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < DocumentMessage & BusinessSentMessage > send send ( game , extra ? ) : Promise < GameMessage & BusinessSentMessage > Parameters game : string Optional extra : Omit < {} , "chat_id" | "game_short_name" > Returns Promise < GameMessage & BusinessSentMessage > send send ( invoice , extra ? ) : Promise < InvoiceMessage & BusinessSentMessage > Parameters invoice : Omit < {} , "chat_id" | "message_thread_id" | "disable_notification" | "reply_parameters" | "reply_markup" > Optional 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 > send send ( latitude , longitude , extra ? ) : Promise < LocationMessage & BusinessSentMessage > Parameters latitude : number longitude : number Optional extra : Omit < {} , "chat_id" | "latitude" | "longitude" > Returns Promise < LocationMessage & BusinessSentMessage > send send ( media , extra ? ) : Promise < ( ( DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage ) [] > Parameters media : MediaGroup Optional extra : Omit < {} , "chat_id" | "media" > Returns Promise < ( ( DocumentMessage | AudioMessage | PhotoMessage | VideoMessage ) & BusinessSentMessage ) [] > send send ( text , extra ? ) : Promise < TextMessage & BusinessSentMessage > Parameters text : string | FmtString < string > Optional extra : Omit < {} , "text" | "chat_id" > Returns Promise < TextMessage & BusinessSentMessage > send send ( photo , extra ? ) : Promise < PhotoMessage & BusinessSentMessage > Parameters photo : string | InputFile Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < PhotoMessage & BusinessSentMessage > send send ( poll , options , extra ? ) : Promise < PollMessage & BusinessSentMessage > Parameters poll : string options : readonly InputPollOption [] Optional extra : Omit < {} , "type" | "chat_id" | "question" | "options" > Returns Promise < PollMessage & BusinessSentMessage > send send ( quiz , options , extra ? ) : Promise < PollMessage & BusinessSentMessage > Parameters quiz : string options : readonly InputPollOption [] Optional extra : Omit < {} , "type" | "chat_id" | "question" | "options" > Returns Promise < PollMessage & BusinessSentMessage > send send ( sticker , extra ? ) : Promise < StickerMessage & BusinessSentMessage > Parameters sticker : string | InputFile Optional extra : Omit < {} , "chat_id" | "sticker" > Returns Promise < StickerMessage & BusinessSentMessage > send send ( latitude , longitude , title , address , extra ? ) : Promise < VenueMessage & BusinessSentMessage > Parameters latitude : number longitude : number title : string address : string Optional extra : Omit < {} , "chat_id" | "title" | "latitude" | "longitude" | "address" > Returns Promise < VenueMessage & BusinessSentMessage > send send ( video , extra ? ) : Promise < VideoMessage & BusinessSentMessage > Parameters video : string | InputFile Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < VideoMessage & BusinessSentMessage > send send ( videoNote , extra ? ) : Promise < VideoNoteMessage & BusinessSentMessage > Parameters videoNote : string | InputFileVideoNote Optional extra : Omit < {} , "chat_id" | "video_note" > Returns Promise < VideoNoteMessage & BusinessSentMessage > send send ( voice , extra ? ) : Promise < VoiceMessage & BusinessSentMessage > Parameters voice : string | InputFile Optional extra : { caption ?: string | FmtString < string > ; } Optional caption ?: string | FmtString < string > Returns Promise < VoiceMessage & BusinessSentMessage > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ userId: number , title: string ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ description?: string ] Returns Promise < true > set set ( menuButton ? ) : Promise < true > Parameters Optional menuButton : MenuButton Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ permissions: ChatPermissions , extra?: Omit < {} , "chat_id" | "permissions" > ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ photo: InputFile ] Returns Promise < true > set set ( setName ) : Promise < true > Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ title: string ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string , custom_emoji_id: string ] Returns Promise < true > set set ( commands ) : Promise < true > Parameters commands : readonly BotCommand [] Returns Promise < true > set set ( extra ? ) : Promise < true > Parameters Optional extra : { forChannels ?: boolean ; rights ?: ChatAdministratorRights ; } Optional for ?: boolean Optional rights ?: ChatAdministratorRights Returns Promise < true > set set ( errors ) : Promise < true > Parameters errors : readonly PassportElementError [] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ sticker: string , emoji_list: string [] ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ sticker: string , keywords?: string [] ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ sticker: string , mask_position?: MaskPosition ] Returns Promise < true > set set ( sticker , position ) : Promise < true > Parameters sticker : string position : number Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string , userId: number , thumbnail?: string | InputFile , format: "video" | "static" | "animated" ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string , userId: number , thumbnail?: string | InputFile , format: "video" | "static" | "animated" ] Returns Promise < true > set set ( ... args ) : Promise < true > Parameters Rest ... args : [ name: string , title: string ] Returns Promise < true > stop stop ( markup ? ) : Promise < true | Edited & LocationMessage & BusinessSentMessage > Parameters Optional markup : InlineKeyboardMarkup Returns Promise < true | Edited & LocationMessage & BusinessSentMessage > stop stop ( ... args ) : Promise < Poll > Parameters Rest ... args : [ messageId: number , extra?: Omit < {} , "chat_id" | "message_id" > ] Returns Promise < Poll > unban unban ( ... args ) : Promise < true > Parameters Rest ... args : [ userId: number , extra?: { only_if_banned ?: boolean ; } ] Returns Promise < true > unban unban ( senderChatId ) : Promise < true > Returns Promise < true > unhide unhide ( ) : Promise < true > Returns Promise < true > unpin unpin ( ... args ) : Promise < true > Returns Promise < true > unpin unpin ( ) : Promise < true > Returns Promise < true > unpin unpin ( ) : Promise < true > Returns Promise < true > unpin unpin ( ... args ) : Promise < true > Parameters Rest ... args : [ messageId?: number ] Returns Promise < true > upload upload ( ... args ) : Promise < File > Parameters Rest ... args : [ sticker: InputFile , sticker_format: "video" | "static" | "animated" ] Returns Promise < File >
See
https://core.telegram.org/bots/api#banchatmember
Deprecated
since API 5.3. Use Context.banChatMember