Bot API Types Reference
ref / types
This is the API reference for the Bot API types exported from grammY. Below, you can see an auto-generated list of all the Bot API types that grammY exportsfrom grammy.
Classes
Variables
Interfaces
- Animation
- Api
Error - Api
Success - Audio
- Background
Fill Freeform Gradient - Background
Fill Gradient - Background
Fill Solid - Background
Type Chat Theme - Background
Type Fill - Background
Type Pattern - Background
Type Wallpaper - Birthdate
- Bot
Command - Bot
Command Scope All Chat Administrators - Bot
Command Scope All Group Chats - Bot
Command Scope All Private Chats - Bot
Command Scope Chat - Bot
Command Scope Chat Administrators - Bot
Command Scope Chat Member - Bot
Command Scope Default - Bot
Description - Bot
Name - Bot
Short Description - Business
Connection - Business
Intro - Business
Location - Business
Messages Deleted - Business
Opening Hours - Business
Opening Hours Interval - Callback
Game - Callback
Query - Chat
Administrator Rights - Chat
Background - Chat
Boost - Chat
Boost Added - Chat
Boost Removed - Chat
Boost Source Gift Code - Chat
Boost Source Giveaway - Chat
Boost Source Premium - Chat
Boost Updated - Chat
Invite Link - Chat
Join Request - Chat
Location - Chat
Member Administrator - Chat
Member Banned - Chat
Member Left - Chat
Member Member - Chat
Member Owner - Chat
Member Restricted - Chat
Member Updated - Chat
Permissions - Chat
Photo - Chat
Shared - Chosen
Inline Result - Contact
- Copy
Text Button - Dice
- Document
- Encrypted
Credentials - Encrypted
Passport Element - External
Reply Info - File
- Force
Reply - Forum
Topic - Forum
Topic Closed - Forum
Topic Created - Forum
Topic Edited - Forum
Topic Reopened - Game
- Game
High Score - General
Forum Topic Hidden - General
Forum Topic Unhidden - Gift
- Gifts
- Giveaway
- Giveaway
Completed - Giveaway
Created - Giveaway
Winners - Inaccessible
Message - Inline
Keyboard Markup - Inline
Query - Inline
Query Result Article - Inline
Query Result Audio - Inline
Query Result Cached Audio - Inline
Query Result Cached Document - Inline
Query Result Cached Gif - Inline
Query Result Cached Mpeg4Gif - Inline
Query Result Cached Photo - Inline
Query Result Cached Sticker - Inline
Query Result Cached Video - Inline
Query Result Cached Voice - Inline
Query Result Contact - Inline
Query Result Document - Inline
Query Result Game - Inline
Query Result Gif - Inline
Query Result Location - Inline
Query Result Mpeg4Gif - Inline
Query Result Photo - Inline
Query Results Button - Inline
Query Result Venue - Inline
Query Result Video - Inline
Query Result Voice - Input
Contact Message Content - Input
Invoice Message Content - Input
Location Message Content - Input
Poll Option - Input
Text Message Content - Input
Venue Message Content - Invoice
- Keyboard
Button Poll Type - Keyboard
Button Request Chat - Keyboard
Button Request Users - Labeled
Price - Link
Preview Options - Location
- Login
Url - Mask
Position - Menu
Button Commands - Menu
Button Default - Menu
Button Web App - Message
- Message
Auto Delete Timer Changed - Message
Id - Message
Origin Channel - Message
Origin Chat - Message
Origin Hidden User - Message
Origin User - Message
Reaction Count Updated - Message
Reaction Updated - Order
Info - Paid
Media Info - Paid
Media Photo - Paid
Media Preview - Paid
Media Purchased - Paid
Media Video - Passport
Data - Passport
Element Error Data Field - Passport
Element Error File - Passport
Element Error Files - Passport
Element Error Front Side - Passport
Element Error Reverse Side - Passport
Element Error Selfie - Passport
Element Error Translation File - Passport
Element Error Translation Files - Passport
Element Error Unspecified - Passport
File - Photo
Size - Poll
- Poll
Answer - Poll
Option - Pre
Checkout Query - Prepared
Inline Message - Proximity
Alert Triggered - Reaction
Count - Reaction
Type Custom Emoji - Reaction
Type Emoji - Reaction
Type Paid - Refunded
Payment - Reply
Keyboard Markup - Reply
Keyboard Remove - Reply
Parameters - Response
Parameters - Revenue
Withdrawal State Failed - Revenue
Withdrawal State Pending - Revenue
Withdrawal State Succeeded - Sent
Web App Message - Shared
User - Shipping
Address - Shipping
Option - Shipping
Query - Star
Transaction - Star
Transactions - Sticker
- Sticker
Set - Story
- Successful
Payment - Switch
Inline Query Chosen Chat - Text
Quote - Transaction
Partner Fragment - Transaction
Partner Other - Transaction
Partner Telegram Ads - Transaction
Partner Telegram Api - Transaction
Partner User - Update
- User
- User
Chat Boosts - User
From Get Me - User
Profile Photos - Users
Shared - Venue
- Video
- Video
Chat Ended - Video
Chat Participants Invited - Video
Chat Scheduled - Video
Chat Started - Video
Note - Voice
- Web
App Data - Web
App Info - Webhook
Info - Write
Access Allowed
Type Aliases
- Api
Methods - Api
Response - Background
Fill - Background
Type - Bot
Command Scope - Chat
- Chat
Boost Source - Chat
From Get Chat - Chat
Full Info - Chat
Member - Inline
Keyboard Button - Inline
Query Result - Input
Media - Input
Media Animation - Input
Media Audio - Input
Media Document - Input
Media Photo - Input
Media Video - Input
Message Content - Input
Paid Media - Input
Paid Media Photo - Input
Paid Media Video - Input
Sticker - Keyboard
Button - Language
Code - Maybe
Inaccessible Message - Menu
Button - Message
Entity - Message
Origin - Opts
- Paid
Media - Parse
Mode - Passport
Element Error - Reaction
Type - Revenue
Withdrawal State - Transaction
Partner