gramio/dist

Namespaces

Namespace	Description
Hooks	Namespace with GramIO hooks types
This module contains [Objects](https://core.telegram.org/bots/api#available-types) with the `Telegram` prefix	-
This module contains params for [methods](https://core.telegram.org/bots/api#available-methods) with the `Params` postfix	-

Classes

Class	Description
Bot	Bot instance
FormattableString	Class-helper for work with formattable entities
Plugin	`Plugin` is an object from which you can extends in Bot instance and adopt types
TelegramError	Represent TelegramAPIResponseError and thrown in API calls
Updates	-

Interfaces

Interface	Description
AddStickerToSetParams	Params object for addStickerToSet method
AnswerCallbackQueryParams	Params object for answerCallbackQuery method
AnswerInlineQueryParams	Params object for answerInlineQuery method
AnswerPreCheckoutQueryParams	Params object for answerPreCheckoutQuery method
AnswerShippingQueryParams	Params object for answerShippingQuery method
AnswerWebAppQueryParams	Params object for answerWebAppQuery method
APIMethods	This object is a map of API methods types (functions map with input/output)
ApproveChatJoinRequestParams	Params object for approveChatJoinRequest method
ApproveSuggestedPostParams	Params object for approveSuggestedPost method
BanChatMemberParams	Params object for banChatMember method
BanChatSenderChatParams	Params object for banChatSenderChat method
BotOptions	Bot options that you can provide to Bot constructor
BotStartOptions	-
CloseForumTopicParams	Params object for closeForumTopic method
CloseGeneralForumTopicParams	Params object for closeGeneralForumTopic method
ConvertGiftToStarsParams	Params object for convertGiftToStars method
CopyMessageParams	Params object for copyMessage method
CopyMessagesParams	Params object for copyMessages method
CreateChatInviteLinkParams	Params object for createChatInviteLink method
CreateChatSubscriptionInviteLinkParams	Params object for createChatSubscriptionInviteLink method
CreateForumTopicParams	Params object for createForumTopic method
CreateInvoiceLinkParams	Params object for createInvoiceLink method
CreateNewStickerSetParams	Params object for createNewStickerSet method
DeclineChatJoinRequestParams	Params object for declineChatJoinRequest method
DeclineSuggestedPostParams	Params object for declineSuggestedPost method
DeleteBusinessMessagesParams	Params object for deleteBusinessMessages method
DeleteChatPhotoParams	Params object for deleteChatPhoto method
DeleteChatStickerSetParams	Params object for deleteChatStickerSet method
DeleteForumTopicParams	Params object for deleteForumTopic method
DeleteMessageParams	Params object for deleteMessage method
DeleteMessagesParams	Params object for deleteMessages method
DeleteMyCommandsParams	Params object for deleteMyCommands method
DeleteStickerFromSetParams	Params object for deleteStickerFromSet method
DeleteStickerSetParams	Params object for deleteStickerSet method
DeleteStoryParams	Params object for deleteStory method
DeleteWebhookParams	Params object for deleteWebhook method
EditChatInviteLinkParams	Params object for editChatInviteLink method
EditChatSubscriptionInviteLinkParams	Params object for editChatSubscriptionInviteLink method
EditForumTopicParams	Params object for editForumTopic method
EditGeneralForumTopicParams	Params object for editGeneralForumTopic method
EditMessageCaptionParams	Params object for editMessageCaption method
EditMessageChecklistParams	Params object for editMessageChecklist method
EditMessageLiveLocationParams	Params object for editMessageLiveLocation method
EditMessageMediaParams	Params object for editMessageMedia method
EditMessageReplyMarkupParams	Params object for editMessageReplyMarkup method
EditMessageTextParams	Params object for editMessageText method
EditStoryParams	Params object for editStory method
EditUserStarSubscriptionParams	Params object for editUserStarSubscription method
ExportChatInviteLinkParams	Params object for exportChatInviteLink method
ForwardMessageParams	Params object for forwardMessage method
ForwardMessagesParams	Params object for forwardMessages method
GetBusinessAccountGiftsParams	Params object for getBusinessAccountGifts method
GetBusinessAccountStarBalanceParams	Params object for getBusinessAccountStarBalance method
GetBusinessConnectionParams	Params object for getBusinessConnection method
GetChatAdministratorsParams	Params object for getChatAdministrators method
GetChatGiftsParams	Params object for getChatGifts method
GetChatMemberCountParams	Params object for getChatMemberCount method
GetChatMemberParams	Params object for getChatMember method
GetChatMenuButtonParams	Params object for getChatMenuButton method
GetChatParams	Params object for getChat method
GetCustomEmojiStickersParams	Params object for getCustomEmojiStickers method
GetFileParams	Params object for getFile method
GetGameHighScoresParams	Params object for getGameHighScores method
GetMyCommandsParams	Params object for getMyCommands method
GetMyDefaultAdministratorRightsParams	Params object for getMyDefaultAdministratorRights method
GetMyDescriptionParams	Params object for getMyDescription method
GetMyNameParams	Params object for getMyName method
GetMyShortDescriptionParams	Params object for getMyShortDescription method
GetStarTransactionsParams	Params object for getStarTransactions method
GetStickerSetParams	Params object for getStickerSet method
GetUpdatesParams	Params object for getUpdates method
GetUserChatBoostsParams	Params object for getUserChatBoosts method
GetUserGiftsParams	Params object for getUserGifts method
GetUserProfileAudiosParams	Params object for getUserProfileAudios method
GetUserProfilePhotosParams	Params object for getUserProfilePhotos method
GiftPremiumSubscriptionParams	Params object for giftPremiumSubscription method
HideGeneralForumTopicParams	Params object for hideGeneralForumTopic method
LeaveChatParams	Params object for leaveChat method
PinChatMessageParams	Params object for pinChatMessage method
PollingStartOptions	-
PostStoryParams	Params object for postStory method
PromoteChatMemberParams	Params object for promoteChatMember method
ReadBusinessMessageParams	Params object for readBusinessMessage method
RefundStarPaymentParams	Params object for refundStarPayment method
RemoveBusinessAccountProfilePhotoParams	Params object for removeBusinessAccountProfilePhoto method
RemoveChatVerificationParams	Params object for removeChatVerification method
RemoveUserVerificationParams	Params object for removeUserVerification method
ReopenForumTopicParams	Params object for reopenForumTopic method
ReopenGeneralForumTopicParams	Params object for reopenGeneralForumTopic method
ReplaceStickerInSetParams	Params object for replaceStickerInSet method
RepostStoryParams	Params object for repostStory method
RestrictChatMemberParams	Params object for restrictChatMember method
RevokeChatInviteLinkParams	Params object for revokeChatInviteLink method
SavePreparedInlineMessageParams	Params object for savePreparedInlineMessage method
SendAnimationParams	Params object for sendAnimation method
SendAudioParams	Params object for sendAudio method
SendChatActionParams	Params object for sendChatAction method
SendChecklistParams	Params object for sendChecklist method
SendContactParams	Params object for sendContact method
SendDiceParams	Params object for sendDice method
SendDocumentParams	Params object for sendDocument method
SendGameParams	Params object for sendGame method
SendGiftParams	Params object for sendGift method
SendInvoiceParams	Params object for sendInvoice method
SendLocationParams	Params object for sendLocation method
SendMediaGroupParams	Params object for sendMediaGroup method
SendMessageDraftParams	Params object for sendMessageDraft method
SendMessageParams	Params object for sendMessage method
SendPaidMediaParams	Params object for sendPaidMedia method
SendPhotoParams	Params object for sendPhoto method
SendPollParams	Params object for sendPoll method
SendStickerParams	Params object for sendSticker method
SendVenueParams	Params object for sendVenue method
SendVideoNoteParams	Params object for sendVideoNote method
SendVideoParams	Params object for sendVideo method
SendVoiceParams	Params object for sendVoice method
SetBusinessAccountBioParams	Params object for setBusinessAccountBio method
SetBusinessAccountGiftSettingsParams	Params object for setBusinessAccountGiftSettings method
SetBusinessAccountNameParams	Params object for setBusinessAccountName method
SetBusinessAccountProfilePhotoParams	Params object for setBusinessAccountProfilePhoto method
SetBusinessAccountUsernameParams	Params object for setBusinessAccountUsername method
SetChatAdministratorCustomTitleParams	Params object for setChatAdministratorCustomTitle method
SetChatDescriptionParams	Params object for setChatDescription method
SetChatMemberTagParams	Params object for setChatMemberTag method
SetChatMenuButtonParams	Params object for setChatMenuButton method
SetChatPermissionsParams	Params object for setChatPermissions method
SetChatPhotoParams	Params object for setChatPhoto method
SetChatStickerSetParams	Params object for setChatStickerSet method
SetChatTitleParams	Params object for setChatTitle method
SetCustomEmojiStickerSetThumbnailParams	Params object for setCustomEmojiStickerSetThumbnail method
SetGameScoreParams	Params object for setGameScore method
SetMessageReactionParams	Params object for setMessageReaction method
SetMyCommandsParams	Params object for setMyCommands method
SetMyDefaultAdministratorRightsParams	Params object for setMyDefaultAdministratorRights method
SetMyDescriptionParams	Params object for setMyDescription method
SetMyNameParams	Params object for setMyName method
SetMyProfilePhotoParams	Params object for setMyProfilePhoto method
SetMyShortDescriptionParams	Params object for setMyShortDescription method
SetPassportDataErrorsParams	Params object for setPassportDataErrors method
SetStickerEmojiListParams	Params object for setStickerEmojiList method
SetStickerKeywordsParams	Params object for setStickerKeywords method
SetStickerMaskPositionParams	Params object for setStickerMaskPosition method
SetStickerPositionInSetParams	Params object for setStickerPositionInSet method
SetStickerSetThumbnailParams	Params object for setStickerSetThumbnail method
SetStickerSetTitleParams	Params object for setStickerSetTitle method
SetUserEmojiStatusParams	Params object for setUserEmojiStatus method
SetWebhookParams	Params object for setWebhook method
StopMessageLiveLocationParams	Params object for stopMessageLiveLocation method
StopPollParams	Params object for stopPoll method
Suppress	Interface for add `suppress` param to params
TelegramAcceptedGiftTypes	This object describes the types of gifts that can be gifted to a user or a chat.
TelegramAffiliateInfo	Contains information about the affiliate that received a commission via this transaction.
TelegramAnimation	This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
TelegramAPIResponseError	In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'.
TelegramAPIResponseOk	If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field.
TelegramAudio	This object represents an audio file to be treated as music by the Telegram clients.
TelegramBackgroundFillFreeformGradient	The background is a freeform gradient that rotates after every message in the chat.
TelegramBackgroundFillGradient	The background is a gradient fill.
TelegramBackgroundFillSolid	The background is filled using the selected color.
TelegramBackgroundTypeChatTheme	The background is taken directly from a built-in chat theme.
TelegramBackgroundTypeFill	The background is automatically filled based on the selected colors.
TelegramBackgroundTypePattern	The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
TelegramBackgroundTypeWallpaper	The background is a wallpaper in the JPEG format.
TelegramBirthdate	Describes the birthdate of a user.
TelegramBotCommand	This object represents a bot command.
TelegramBotCommandScopeAllChatAdministrators	Represents the scope of bot commands, covering all group and supergroup chat administrators.
TelegramBotCommandScopeAllGroupChats	Represents the scope of bot commands, covering all group and supergroup chats.
TelegramBotCommandScopeAllPrivateChats	Represents the scope of bot commands, covering all private chats.
TelegramBotCommandScopeChat	Represents the scope of bot commands, covering a specific chat.
TelegramBotCommandScopeChatAdministrators	Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
TelegramBotCommandScopeChatMember	Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
TelegramBotCommandScopeDefault	Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
TelegramBotDescription	This object represents the bot's description.
TelegramBotName	This object represents the bot's name.
TelegramBotShortDescription	This object represents the bot's short description.
TelegramBusinessBotRights	Represents the rights of a business bot.
TelegramBusinessConnection	Describes the connection of the bot with a business account.
TelegramBusinessIntro	Contains information about the start page settings of a Telegram Business account.
TelegramBusinessLocation	Contains information about the location of a Telegram Business account.
TelegramBusinessMessagesDeleted	This object is received when messages are deleted from a connected business account.
TelegramBusinessOpeningHours	Describes the opening hours of a business.
TelegramBusinessOpeningHoursInterval	Describes an interval of time during which a business is open.
TelegramCallbackGame	A placeholder, currently holds no information. Use BotFather to set up your game.
TelegramCallbackQuery	This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
TelegramChat	This object represents a chat.
TelegramChatAdministratorRights	Represents the rights of an administrator in a chat.
TelegramChatBackground	This object represents a chat background.
TelegramChatBoost	This object contains information about a chat boost.
TelegramChatBoostAdded	This object represents a service message about a user boosting a chat.
TelegramChatBoostRemoved	This object represents a boost removed from a chat.
TelegramChatBoostSourceGiftCode	The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
TelegramChatBoostSourceGiveaway	The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
TelegramChatBoostSourcePremium	The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.
TelegramChatBoostUpdated	This object represents a boost added to a chat or changed.
TelegramChatFullInfo	This object contains full information about a chat.
TelegramChatInviteLink	Represents an invite link for a chat.
TelegramChatJoinRequest	Represents a join request sent to a chat.
TelegramChatLocation	Represents a location to which a chat is connected.
TelegramChatMemberAdministrator	Represents a chat member that has some additional privileges.
TelegramChatMemberBanned	Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
TelegramChatMemberLeft	Represents a chat member that isn't currently a member of the chat, but may join it themselves.
TelegramChatMemberMember	Represents a chat member that has no additional privileges or restrictions.
TelegramChatMemberOwner	Represents a chat member that owns the chat and has all administrator privileges.
TelegramChatMemberRestricted	Represents a chat member that is under certain restrictions in the chat. Supergroups only.
TelegramChatMemberUpdated	This object represents changes in the status of a chat member.
TelegramChatOwnerChanged	Describes a service message about an ownership change in the chat.
TelegramChatOwnerLeft	Describes a service message about the chat owner leaving the chat.
TelegramChatPermissions	Describes actions that a non-administrator user is allowed to take in a chat.
TelegramChatPhoto	This object represents a chat photo.
TelegramChatShared	This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
TelegramChecklist	Describes a checklist.
TelegramChecklistTask	Describes a task in a checklist.
TelegramChecklistTasksAdded	Describes a service message about tasks added to a checklist.
TelegramChecklistTasksDone	Describes a service message about checklist tasks marked as done or not done.
TelegramChosenInlineResult	Represents a result of an inline query that was chosen by the user and sent to their chat partner.
TelegramContact	This object represents a phone contact.
TelegramCopyTextButton	This object represents an inline keyboard button that copies specified text to the clipboard.
TelegramDice	This object represents an animated emoji that displays a random value.
TelegramDirectMessagePriceChanged	Describes a service message about a change in the price of direct messages sent to a channel chat.
TelegramDirectMessagesTopic	Describes a topic of a direct messages chat.
TelegramDocument	This object represents a general file (as opposed to photos, voice messages and audio files).
TelegramEncryptedCredentials	Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
TelegramEncryptedPassportElement	Describes documents or other Telegram Passport elements shared with the bot by the user.
TelegramExternalReplyInfo	This object contains information about a message that is being replied to, which may come from another chat or forum topic.
TelegramFile	This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.
TelegramForceReply	Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.
TelegramForumTopic	This object represents a forum topic.
TelegramForumTopicClosed	This object represents a service message about a forum topic closed in the chat. Currently holds no information.
TelegramForumTopicCreated	This object represents a service message about a new forum topic created in the chat.
TelegramForumTopicEdited	This object represents a service message about an edited forum topic.
TelegramForumTopicReopened	This object represents a service message about a forum topic reopened in the chat. Currently holds no information.
TelegramGame	This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
TelegramGameHighScore	This object represents one row of the high scores table for a game.
TelegramGeneralForumTopicHidden	This object represents a service message about General forum topic hidden in the chat. Currently holds no information.
TelegramGeneralForumTopicUnhidden	This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.
TelegramGift	This object represents a gift that can be sent by the bot.
TelegramGiftBackground	This object describes the background of a gift.
TelegramGiftInfo	Describes a service message about a regular gift that was sent or received.
TelegramGifts	This object represent a list of gifts.
TelegramGiveaway	This object represents a message about a scheduled giveaway.
TelegramGiveawayCompleted	This object represents a service message about the completion of a giveaway without public winners.
TelegramGiveawayCreated	This object represents a service message about the creation of a scheduled giveaway.
TelegramGiveawayWinners	This object represents a message about the completion of a giveaway with public winners.
TelegramInaccessibleMessage	This object describes a message that was deleted or is otherwise inaccessible to the bot.
TelegramInlineKeyboardButton	This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.
TelegramInlineKeyboardMarkup	This object represents an inline keyboard that appears right next to the message it belongs to.
TelegramInlineQuery	This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
TelegramInlineQueryResultArticle	Represents a link to an article or web page.
TelegramInlineQueryResultAudio	Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
TelegramInlineQueryResultCachedAudio	Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
TelegramInlineQueryResultCachedDocument	Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
TelegramInlineQueryResultCachedGif	Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
TelegramInlineQueryResultCachedMpeg4Gif	Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
TelegramInlineQueryResultCachedPhoto	Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
TelegramInlineQueryResultCachedSticker	Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
TelegramInlineQueryResultCachedVideo	Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
TelegramInlineQueryResultCachedVoice	Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
TelegramInlineQueryResultContact	Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
TelegramInlineQueryResultDocument	Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
TelegramInlineQueryResultGame	Represents a Game.
TelegramInlineQueryResultGif	Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
TelegramInlineQueryResultLocation	Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
TelegramInlineQueryResultMpeg4Gif	Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
TelegramInlineQueryResultPhoto	Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
TelegramInlineQueryResultsButton	This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
TelegramInlineQueryResultVenue	Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
TelegramInlineQueryResultVideo	Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
TelegramInlineQueryResultVoice	Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
TelegramInputChecklist	Describes a checklist to create.
TelegramInputChecklistTask	Describes a task to add to a checklist.
TelegramInputContactMessageContent	Represents the content of a contact message to be sent as the result of an inline query.
TelegramInputInvoiceMessageContent	Represents the content of an invoice message to be sent as the result of an inline query.
TelegramInputLocationMessageContent	Represents the content of a location message to be sent as the result of an inline query.
TelegramInputMediaAnimation	Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
TelegramInputMediaAudio	Represents an audio file to be treated as music to be sent.
TelegramInputMediaDocument	Represents a general file to be sent.
TelegramInputMediaPhoto	Represents a photo to be sent.
TelegramInputMediaVideo	Represents a video to be sent.
TelegramInputPaidMediaPhoto	The paid media to send is a photo.
TelegramInputPaidMediaVideo	The paid media to send is a video.
TelegramInputPollOption	This object contains information about one answer option in a poll to be sent.
TelegramInputProfilePhotoAnimated	An animated profile photo in the MPEG4 format.
TelegramInputProfilePhotoStatic	A static profile photo in the .JPG format.
TelegramInputSticker	This object describes a sticker to be added to a sticker set.
TelegramInputStoryContentPhoto	Describes a photo to post as a story.
TelegramInputStoryContentVideo	Describes a video to post as a story.
TelegramInputTextMessageContent	Represents the content of a text message to be sent as the result of an inline query.
TelegramInputVenueMessageContent	Represents the content of a venue message to be sent as the result of an inline query.
TelegramInvoice	This object contains basic information about an invoice.
TelegramKeyboardButton	This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.
TelegramKeyboardButtonPollType	This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
TelegramKeyboardButtonRequestChat	This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».
TelegramKeyboardButtonRequestUsers	This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »
TelegramLabeledPrice	This object represents a portion of the price for goods or services.
TelegramLinkPreviewOptions	Describes the options used for link preview generation.
TelegramLocation	This object represents a point on the map.
TelegramLocationAddress	Describes the physical address of a location.
TelegramLoginUrl	This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:
TelegramMaskPosition	This object describes the position on faces where a mask should be placed by default.
TelegramMenuButtonCommands	Represents a menu button, which opens the bot's list of commands.
TelegramMenuButtonDefault	Describes that no specific value for the menu button was set.
TelegramMenuButtonWebApp	Represents a menu button, which launches a Web App.
TelegramMessage	This object represents a message.
TelegramMessageAutoDeleteTimerChanged	This object represents a service message about a change in auto-delete timer settings.
TelegramMessageEntity	This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
TelegramMessageId	This object represents a unique message identifier.
TelegramMessageOriginChannel	The message was originally sent to a channel chat.
TelegramMessageOriginChat	The message was originally sent on behalf of a chat to a group chat.
TelegramMessageOriginHiddenUser	The message was originally sent by an unknown user.
TelegramMessageOriginUser	The message was originally sent by a known user.
TelegramMessageReactionCountUpdated	This object represents reaction changes on a message with anonymous reactions.
TelegramMessageReactionUpdated	This object represents a change of a reaction on a message performed by a user.
TelegramOrderInfo	This object represents information about an order.
TelegramOwnedGiftRegular	Describes a regular gift owned by a user or a chat.
TelegramOwnedGifts	Contains the list of gifts received and owned by a user or a chat.
TelegramOwnedGiftUnique	Describes a unique gift received and owned by a user or a chat.
TelegramPaidMediaInfo	Describes the paid media added to a message.
TelegramPaidMediaPhoto	The paid media is a photo.
TelegramPaidMediaPreview	The paid media isn't available before the payment.
TelegramPaidMediaPurchased	This object contains information about a paid media purchase.
TelegramPaidMediaVideo	The paid media is a video.
TelegramPaidMessagePriceChanged	Describes a service message about a change in the price of paid messages within a chat.
TelegramPassportData	Describes Telegram Passport data shared with the bot by the user.
TelegramPassportElementErrorDataField	Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
TelegramPassportElementErrorFile	Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
TelegramPassportElementErrorFiles	Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
TelegramPassportElementErrorFrontSide	Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
TelegramPassportElementErrorReverseSide	Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
TelegramPassportElementErrorSelfie	Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
TelegramPassportElementErrorTranslationFile	Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
TelegramPassportElementErrorTranslationFiles	Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
TelegramPassportElementErrorUnspecified	Represents an issue in an unspecified place. The error is considered resolved when new data is added.
TelegramPassportFile	This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
TelegramPhotoSize	This object represents one size of a photo or a file / sticker thumbnail.
TelegramPoll	This object contains information about a poll.
TelegramPollAnswer	This object represents an answer of a user in a non-anonymous poll.
TelegramPollOption	This object contains information about one answer option in a poll.
TelegramPreCheckoutQuery	This object contains information about an incoming pre-checkout query.
TelegramPreparedInlineMessage	Describes an inline message to be sent by a user of a Mini App.
TelegramProximityAlertTriggered	This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
TelegramReactionCount	Represents a reaction added to a message along with the number of times it was added.
TelegramReactionTypeCustomEmoji	The reaction is based on a custom emoji.
TelegramReactionTypeEmoji	The reaction is based on an emoji.
TelegramReactionTypePaid	The reaction is paid.
TelegramRefundedPayment	This object contains basic information about a refunded payment.
TelegramReplyKeyboardMarkup	This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.
TelegramReplyKeyboardRemove	Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.
TelegramReplyParameters	Describes reply parameters for the message that is being sent.
TelegramResponseParameters	Describes why a request was unsuccessful.
TelegramRevenueWithdrawalStateFailed	The withdrawal failed and the transaction was refunded.
TelegramRevenueWithdrawalStatePending	The withdrawal is in progress.
TelegramRevenueWithdrawalStateSucceeded	The withdrawal succeeded.
TelegramSentWebAppMessage	Describes an inline message sent by a Web App on behalf of a user.
TelegramSharedUser	This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.
TelegramShippingAddress	This object represents a shipping address.
TelegramShippingOption	This object represents one shipping option.
TelegramShippingQuery	This object contains information about an incoming shipping query.
TelegramStarAmount	Describes an amount of Telegram Stars.
TelegramStarTransaction	Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.
TelegramStarTransactions	Contains a list of Telegram Star transactions.
TelegramSticker	This object represents a sticker.
TelegramStickerSet	This object represents a sticker set.
TelegramStory	This object represents a story.
TelegramStoryArea	Describes a clickable area on a story media.
TelegramStoryAreaPosition	Describes the position of a clickable area within a story.
TelegramStoryAreaTypeLink	Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.
TelegramStoryAreaTypeLocation	Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.
TelegramStoryAreaTypeSuggestedReaction	Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.
TelegramStoryAreaTypeUniqueGift	Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.
TelegramStoryAreaTypeWeather	Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.
TelegramSuccessfulPayment	This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.
TelegramSuggestedPostApprovalFailed	Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.
TelegramSuggestedPostApproved	Describes a service message about the approval of a suggested post.
TelegramSuggestedPostDeclined	Describes a service message about the rejection of a suggested post.
TelegramSuggestedPostInfo	Contains information about a suggested post.
TelegramSuggestedPostPaid	Describes a service message about a successful payment for a suggested post.
TelegramSuggestedPostParameters	Contains parameters of a post that is being suggested by the bot.
TelegramSuggestedPostPrice	Describes the price of a suggested post.
TelegramSuggestedPostRefunded	Describes a service message about a payment refund for a suggested post.
TelegramSwitchInlineQueryChosenChat	This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
TelegramTextQuote	This object contains information about the quoted part of a message that is replied to by the given message.
TelegramTransactionPartnerAffiliateProgram	Describes the affiliate program that issued the affiliate commission received via this transaction.
TelegramTransactionPartnerChat	Describes a transaction with a chat.
TelegramTransactionPartnerFragment	Describes a withdrawal transaction with Fragment.
TelegramTransactionPartnerOther	Describes a transaction with an unknown source or recipient.
TelegramTransactionPartnerTelegramAds	Describes a withdrawal transaction to the Telegram Ads platform.
TelegramTransactionPartnerTelegramApi	Describes a transaction with payment for paid broadcasting.
TelegramTransactionPartnerUser	Describes a transaction with a user.
TelegramUniqueGift	This object describes a unique gift that was upgraded from a regular gift.
TelegramUniqueGiftBackdrop	This object describes the backdrop of a unique gift.
TelegramUniqueGiftBackdropColors	This object describes the colors of the backdrop of a unique gift.
TelegramUniqueGiftColors	This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.
TelegramUniqueGiftInfo	Describes a service message about a unique gift that was sent or received.
TelegramUniqueGiftModel	This object describes the model of a unique gift.
TelegramUniqueGiftSymbol	This object describes the symbol shown on the pattern of a unique gift.
TelegramUpdate	This object represents an incoming update. At most one of the optional parameters can be present in any given update.
TelegramUser	This object represents a Telegram user or bot.
TelegramUserChatBoosts	This object represents a list of boosts added to a chat by a user.
TelegramUserProfileAudios	This object represents the audios displayed on a user's profile.
TelegramUserProfilePhotos	This object represent a user's profile pictures.
TelegramUserRating	This object describes the rating of a user based on their Telegram Star spendings.
TelegramUsersShared	This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.
TelegramVenue	This object represents a venue.
TelegramVideo	This object represents a video file.
TelegramVideoChatEnded	This object represents a service message about a video chat ended in the chat.
TelegramVideoChatParticipantsInvited	This object represents a service message about new members invited to a video chat.
TelegramVideoChatScheduled	This object represents a service message about a video chat scheduled in the chat.
TelegramVideoChatStarted	This object represents a service message about a video chat started in the chat. Currently holds no information.
TelegramVideoNote	This object represents a video message (available in Telegram apps as of v.4.0).
TelegramVideoQuality	This object represents a video file of a specific quality.
TelegramVoice	This object represents a voice note.
TelegramWebAppData	Describes data sent from a Web App to the bot.
TelegramWebAppInfo	Describes a Web App.
TelegramWebhookInfo	Describes the current status of a webhook.
TelegramWriteAccessAllowed	This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.
TransferBusinessAccountStarsParams	Params object for transferBusinessAccountStars method
TransferGiftParams	Params object for transferGift method
UnbanChatMemberParams	Params object for unbanChatMember method
UnbanChatSenderChatParams	Params object for unbanChatSenderChat method
UnhideGeneralForumTopicParams	Params object for unhideGeneralForumTopic method
UnpinAllChatMessagesParams	Params object for unpinAllChatMessages method
UnpinAllForumTopicMessagesParams	Params object for unpinAllForumTopicMessages method
UnpinAllGeneralForumTopicMessagesParams	Params object for unpinAllGeneralForumTopicMessages method
UnpinChatMessageParams	Params object for unpinChatMessage method
UpgradeGiftParams	Params object for upgradeGift method
UploadStickerFileParams	Params object for uploadStickerFile method
VerifyChatParams	Params object for verifyChat method
VerifyUserParams	Params object for verifyUser method
WebhookHandlerOptions	-
WebhookHandlerOptionsShouldWait	-

Type Aliases

Type Alias	Description
AllowedUpdates	-
AnyBot	Type of Bot that accepts any generics
AnyPlugin	Type of Bot that accepts any generics
APIMethodParams	-
APIMethodReturn	-
BotStartOptionsLongPolling	-
BotStartOptionsWebhook	-
CallbackQueryShorthandContext	-
CreateForumTopicIconColor	-
CreateNewStickerSetStickerType	-
DeriveDefinitions	Map of derives
ErrorDefinitions	Error map should be map of string: error
Filter	A type guard predicate that narrows `In` to `Out`. Built-in filters use `any` as `In` so they work with any bot's context type. The actual narrowing happens via intersection in the `.on()` handler type.
GiftPremiumSubscriptionMonthCount	-
Handler	Handler is a function with context and next function arguments
MaybePromise	Type for maybe Promise or may not
MaybeSuppressedParams	Type that assign API params with Suppress
MaybeSuppressedReturn	Type that return MaybeSuppressed API method ReturnType
PostStoryActivePeriod	-
RepostStoryActivePeriod	-
SendChatActionAction	-
SendDiceEmoji	-
SendPollType	-
SetStickerSetThumbnailFormat	-
Stringable	Type which contains a string or has the ability to result in a string object
SuppressedAPIMethodParams	Return method params but with Suppress
SuppressedAPIMethodReturn	Type that return Suppressed API method ReturnType
SuppressedAPIMethods	Map of APIMethods but with Suppress
TelegramAPIResponse	The response contains a JSON object, which always has a Boolean field 'ok'.
TelegramBackgroundFill	This object describes the way a background is filled based on the selected colors. Currently, it can be one of
TelegramBackgroundType	This object describes the type of a background. Currently, it can be one of
TelegramBotCommandScope	This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
TelegramChatBoostSource	This object describes the source of a chat boost. It can be one of
TelegramChatFullInfoType	-
TelegramChatMember	This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
TelegramChatType	-
TelegramCurrencies	Telegram payments supported currencies. Source: currencies.json. See also supported currencies.
TelegramEncryptedPassportElementType	-
TelegramInlineKeyboardButtonStyle	-
TelegramInlineQueryChatType	-
TelegramInlineQueryResult	This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
TelegramInlineQueryResultDocumentMimeType	-
TelegramInlineQueryResultGifThumbnailMimeType	-
TelegramInlineQueryResultMpeg4GifThumbnailMimeType	-
TelegramInlineQueryResultVideoMimeType	-
TelegramInputFile	This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
TelegramInputMedia	This object represents the content of a media message to be sent. It should be one of
TelegramInputMessageContent	This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:
TelegramInputPaidMedia	This object describes the paid media to be sent. Currently, it can be one of
TelegramInputProfilePhoto	This object describes a profile photo to set. Currently, it can be one of
TelegramInputStickerFormat	-
TelegramInputStoryContent	This object describes the content of a story to post. Currently, it can be one of
TelegramKeyboardButtonStyle	-
TelegramMaskPositionPoint	-
TelegramMaybeInaccessibleMessage	This object describes a message that can be inaccessible to the bot. It can be one of
TelegramMenuButton	This object describes the bot's menu button in a private chat. It should be one of
TelegramMessageEntityType	-
TelegramMessageOrigin	This object describes the origin of a message. It can be one of
TelegramOwnedGift	This object describes a gift received and owned by a user or a chat. Currently, it can be one of
TelegramPaidMedia	This object describes paid media. Currently, it can be one of
TelegramPassportElementError	This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
TelegramPassportElementErrorDataFieldType	-
TelegramPassportElementErrorFilesType	-
TelegramPassportElementErrorFileType	-
TelegramPassportElementErrorFrontSideType	-
TelegramPassportElementErrorReverseSideType	-
TelegramPassportElementErrorSelfieType	-
TelegramPassportElementErrorTranslationFilesType	-
TelegramPassportElementErrorTranslationFileType	-
TelegramPollType	-
TelegramReactionType	This object describes the type of a reaction. Currently, it can be one of
TelegramReactionTypeEmojiEmoji	-
TelegramRevenueWithdrawalState	This object describes the state of a revenue withdrawal operation. Currently, it can be one of
TelegramStickerSetStickerType	-
TelegramStickerType	-
TelegramStoryAreaType	Describes the type of a clickable area on a story. Currently, it can be one of
TelegramSuggestedPostInfoState	-
TelegramSuggestedPostPaidCurrency	-
TelegramSuggestedPostPriceCurrency	-
TelegramSuggestedPostRefundedReason	-
TelegramTransactionPartner	This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
TelegramTransactionPartnerUserTransactionType	-
TelegramUniqueGiftInfoLastResaleCurrency	-
TelegramUniqueGiftInfoOrigin	-
TelegramUniqueGiftModelRarity	-
TelegramVideoQualityCodec	-
UploadStickerFileStickerFormat	-
WebhookHandlers	Union type of webhook handlers name

Variables

Composer

const Composer: EventComposerConstructor<Context<AnyBot>, TelegramEventMap, { callbackQuery: TThis; chosenInlineResult: TThis; command: TThis; hears: TThis; inlineQuery: TThis; reaction: TThis; startParameter: TThis; }>

Defined in: gramio/index.d.ts:57

ErrorKind

const ErrorKind: symbol

Defined in: gramio/index.d.ts:18

Symbol to determine which error kind is it

filters

const filters: object

Defined in: gramio/index.d.ts:1382

Type Declaration

Name	Type	Description	Defined in
`animation`	`Filter`<`any`, { `attachment`: `AnimationAttachment`; }>	-	gramio/index.d.ts:1404
`audio`	`Filter`<`any`, { `attachment`: `AudioAttachment`; }>	-	gramio/index.d.ts:1392
`authorSignature`	`Filter`<`any`, { `authorSignature`: `string`; }>	Matches messages with an author signature	gramio/index.d.ts:1467
`caption`	`Filter`<`any`, { `caption`: `string`; }>	Matches messages that have a caption	gramio/index.d.ts:1425
`captionEntities`	`Filter`<`any`, { `captionEntities`: `MessageEntity`[]; }>	Matches messages that have caption entities	gramio/index.d.ts:1443
`channel`	`Filter`<`any`, { `chat`: { `type`: `"channel"`; }; `chatType`: `"channel"`; }>	Matches channel chats. Narrows both `chatType` and `chat.type`.	gramio/index.d.ts:1580
`contact`	`Filter`<`any`, { `attachment`: `ContactAttachment`; }>	-	gramio/index.d.ts:1407
`dice`	`Filter`<`any`, { `dice`: `Dice`; }>	Matches messages that contain a dice	gramio/index.d.ts:1429
`document`	`Filter`<`any`, { `attachment`: `DocumentAttachment`; }>	-	gramio/index.d.ts:1389
`effectId`	`Filter`<`any`, { `effectId`: `string`; }>	Matches messages with an effect ID	gramio/index.d.ts:1498
`entities`	`Filter`<`any`, { `entities`: `MessageEntity`[]; }>	Matches messages that have text entities	gramio/index.d.ts:1439
`forwardOrigin`	`ForwardOriginFilter`	Matches forwarded messages. Call without args for any origin, or pass a type to narrow precisely.	gramio/index.d.ts:1433
`fromOffline()`	(`ctx`) => `boolean`	Matches messages sent while user was offline. No type narrowing.	gramio/index.d.ts:1526
`game`	`Filter`<`any`, { `game`: `Game`; }>	Matches messages with a game	gramio/index.d.ts:1490
`giveaway`	`Filter`<`any`, { `giveaway`: `Giveaway`; }>	Matches giveaway messages	gramio/index.d.ts:1482
`group`	`Filter`<`any`, { `chat`: { `type`: `"group"`; }; `chatType`: `"group"`; }>	Matches group chats. Narrows both `chatType` and `chat.type`.	gramio/index.d.ts:1566
`hasData`	`Filter`<`any`, { `data`: `string`; }>	Matches callback queries that have data	gramio/index.d.ts:1532
`hasFrom`	`Filter`<`any`, { `from`: `User`; `senderId`: `number`; }>	Matches contexts that have a sender (from user)	gramio/index.d.ts:1475
`hasGameShortName`	`Filter`<`any`, { `gameShortName`: `string`; }>	Matches callback queries with a game short name	gramio/index.d.ts:1540
`hasInlineMessageId`	`Filter`<`any`, { `inlineMessageId`: `string`; }>	Matches callback queries with an inline message ID	gramio/index.d.ts:1536
`hasMessage`	`Filter`<`any`, { `message`: `MessageContext`<`any`>; }>	Matches callback queries that have an associated message	gramio/index.d.ts:1528
`isBot()`	(`ctx`) => `boolean`	Matches messages from bot accounts	gramio/index.d.ts:1510
`isForum()`	(`ctx`) => `boolean`	Matches messages in forum (topic) chats	gramio/index.d.ts:1514
`isPremium()`	(`ctx`) => `boolean`	Matches messages from premium users	gramio/index.d.ts:1512
`linkPreview`	`Filter`<`any`, { `linkPreviewOptions`: `LinkPreviewOptions`; }>	Matches messages that have link preview options	gramio/index.d.ts:1455
`location`	`Filter`<`any`, { `attachment`: `LocationAttachment`; }>	-	gramio/index.d.ts:1410
`media`	`Filter`<`any`, { `attachment`: `AnyAttachment`; }>	Matches any message that has an attachment	gramio/index.d.ts:1417
`mediaGroup`	`Filter`<`any`, { `mediaGroupId`: `string`; }>	Matches messages that belong to a media group	gramio/index.d.ts:1502
`mediaSpoiler`	`Filter`<`any`, { `attachment`: `AnyAttachment`; }>	Matches media with spoiler. Narrows `attachment` to confirm media is present.	gramio/index.d.ts:1520
`paidMedia`	`Filter`<`any`, { `paidMedia`: `PaidMediaInfo`; }>	Matches messages with paid media	gramio/index.d.ts:1486
`photo`	`Filter`<`any`, { `attachment`: `PhotoAttachment`; }>	-	gramio/index.d.ts:1383
`pm`	`Filter`<`any`, { `chat`: { `type`: `"private"`; }; `chatType`: `"private"`; }>	Matches private (DM) chats. Narrows both `chatType` and `chat.type`.	gramio/index.d.ts:1559
`poll`	`Filter`<`any`, { `attachment`: `PollAttachment`; }>	-	gramio/index.d.ts:1413
`protectedContent()`	(`ctx`) => `boolean`	Matches messages with protected content. No type narrowing.	gramio/index.d.ts:1524
`quote`	`Filter`<`any`, { `quote`: `TextQuote`; }>	Matches messages that have a quote	gramio/index.d.ts:1447
`rawStartPayload`	`Filter`<`any`, { `rawStartPayload`: `string`; }>	Matches messages with a raw /start payload string	gramio/index.d.ts:1463
`reply`	`Filter`<`any`, { `replyMessage`: `Message`; }>	Matches messages that are replies	gramio/index.d.ts:1435
`replyInfo`	`Filter`<`any`, { `externalReply`: `ExternalReplyInfo`; }>	Matches messages with external reply info	gramio/index.d.ts:1471
`senderChat`	`SenderChatFilter`	Matches messages sent on behalf of a chat. Pass a type to also narrow `senderChat.type`.	gramio/index.d.ts:1480
`service()`	(`ctx`) => `any`	Matches service messages	gramio/index.d.ts:1516
`startPayload`	`Filter`<`any`, { `startPayload`: `string`; }>	Matches messages with a /start payload	gramio/index.d.ts:1459
`sticker`	`Filter`<`any`, { `attachment`: `StickerAttachment`; }>	-	gramio/index.d.ts:1395
`story`	`Filter`<`any`, { `story`: `StoryAttachment`; }>	Matches messages with a story	gramio/index.d.ts:1494
`supergroup`	`Filter`<`any`, { `chat`: { `type`: `"supergroup"`; }; `chatType`: `"supergroup"`; }>	Matches supergroup chats. Narrows both `chatType` and `chat.type`.	gramio/index.d.ts:1573
`text`	`Filter`<`any`, { `text`: `string`; }>	Matches messages that have text	gramio/index.d.ts:1421
`topicMessage()`	(`ctx`) => `any`	Matches messages in topics	gramio/index.d.ts:1518
`venue`	`Filter`<`any`, { `venue`: `Venue`; }>	Matches messages with a venue	gramio/index.d.ts:1506
`viaBot`	`Filter`<`any`, { `viaBot`: `User`; }>	Matches messages sent via a bot	gramio/index.d.ts:1451
`video`	`Filter`<`any`, { `attachment`: `VideoAttachment`; }>	-	gramio/index.d.ts:1386
`videoNote`	`Filter`<`any`, { `attachment`: `VideoNoteAttachment`; }>	-	gramio/index.d.ts:1401
`voice`	`Filter`<`any`, { `attachment`: `VoiceAttachment`; }>	-	gramio/index.d.ts:1398
`and()`	(`f1`, `f2`) => `Filter`<`any`, `N1` & `N2`>	Intersection: both filters must match	gramio/index.d.ts:1595
`captionEntity()`	(`type`) => `Filter`<`any`, { `captionEntities`: `MessageEntity`[]; }>	Matches messages with a specific caption entity type	gramio/index.d.ts:1548
`chat()`	(`type`) => `Filter`<`any`, { `chat`: { `type`: `T`; }; `chatType`: `T`; }>	Matches messages from a specific chat type. Narrows both `chatType` and `chat.type`.	gramio/index.d.ts:1552
`chatId()`	(`chatId`) => (`ctx`) => `boolean`	Matches messages in specific chat(s). No type narrowing.	gramio/index.d.ts:1589
`entity()`	(`type`) => `Filter`<`any`, { `entities`: `MessageEntity`[]; }>	Matches messages with a specific text entity type	gramio/index.d.ts:1544
`every()`	(...`filters`) => `Filter`<`any`, `UnionToIntersection`<`ExtractNarrow`<`Filters`[`number`]>>>	Variadic intersection: all filters must match	gramio/index.d.ts:1601
`from()`	(`userId`) => (`ctx`) => `boolean`	Matches messages from specific user(s). No type narrowing.	gramio/index.d.ts:1587
`not()`	(`f`) => (`ctx`) => `boolean`	Negation: inverts the filter (no type narrowing)	gramio/index.d.ts:1599
`or()`	(`f1`, `f2`) => `Filter`<`any`, `N1` \| `N2`>	Union: either filter must match	gramio/index.d.ts:1597
`regex()`	(`pattern`) => `Filter`<`any`, { `match`: `RegExpMatchArray`; }>	Matches messages whose text/caption matches the regex, sets `ctx.match`	gramio/index.d.ts:1591
`some()`	(...`filters`) => `Filter`<`any`, `ExtractNarrow`<`Filters`[`number`]>>	Variadic union: any filter must match	gramio/index.d.ts:1603

Functions

getFormattable()

getFormattable(str): FormattableString

Defined in: format/formattable-string-BKevNsLk.d.ts:21

Parameters

Parameter	Type
`str`	`Stringable`

Returns

FormattableString

webhookHandler()

webhookHandler<Framework>(bot, framework, secretTokenOrOptions?): ReturnType<object[Framework]> extends object ? (...args) => ReturnType<ReturnType["response"]> : (...args) => void

Defined in: gramio/index.d.ts:1709

Setup handler with yours web-framework to receive updates via webhook

Type Parameters

Type Parameter
`Framework` extends `"elysia"` \| `"fastify"` \| `"hono"` \| `"express"` \| `"koa"` \| `"http"` \| `"std/http"` \| `"Bun.serve"` \| `"cloudflare"` \| `"Request"`

Parameters

Parameter	Type
`bot`	`Bot`
`framework`	`Framework`
`secretTokenOrOptions?`	`string` \| `WebhookHandlerOptions`

Returns

ReturnType<object[Framework]> extends object ? (...args) => ReturnType<ReturnType["response"]> : (...args) => void

Example

import { Bot } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.TOKEN as string).on(
	"message",
	(context) => {
		return context.send("Fastify!");
	},
);

const fastify = Fastify();

fastify.post("/telegram-webhook", webhookHandler(bot, "fastify"));

fastify.listen({ port: 3445, host: "::" });

bot.start({
    webhook: {
        url: "https://example.com:3445/telegram-webhook",
    },
});