Index

MTKruto is a Telegram client library for JavaScript.

Its key features include:

• Cross-runtime
      Supports Node.js, Deno, browsers, and Bun.

• Type-safe
      Written in TypeScript with accurate typings.

• Prioritizes the Web
      Prefers Web APIs over runtime-specific APIs.

• Easy-to-use
      Provides its own high-level API on top of the Telegram API.

• Extensible
      Its middleware system lets you integrate external code.

Walkthrough

Main

1. Installation
   • Bun & Node.js
   • Deno & Web
2. Starting the Client
   • Acquiring API Credentials
   • Constructing the Client
   • Connecting the Client and Authorizing an Account
3. Calling Methods
   • High-level Methods
   • Telegram API Functions
4. Handling Updates
   • use
   • branch
   • filter
   • on
   • command
   • callbackQueryBOT-ONLY
   • inlineQueryBOT-ONLY
   • chosenInlineResultBOT-ONLY
   • chatType
5. Catching Errors
   • Telegram API Errors
   • Access Errors
6. Working with Messages
   • Message Updates
   • Sending Messages
   • Deleting Messages
   • Forwarding Messages
7. Commands
   • Custom Prefixes
   • Outgoing MessagesUSER-ONLY
8. Reactions
   • Reacting to Messages
   • Reaction Updates
9. Files
   • Uploading Files
   • Reusing Files
   • Downloading Files
   • Upload Progress
10. Rich Messages and Text Formatting
    • Rich Messages
    • Formatting Regular Messages
    • Entity and Block Builders
11. Polls
    • Sending a Poll
    • Sending a Quiz
    • Handling Poll Updates
    • Stopping a Poll
12. Checklists
    • Sending a Checklist
    • Letting Others Update a Checklist
    • Reading a Checklist
    • Updating a ChecklistUSER-ONLY
13. Topics
    • Enabling TopicsUSER-ONLY
    • Creating a Topic
    • Sending Messages to a Topic
    • Handling Topic Messages
    • Listing TopicsUSER-ONLY
    • Managing a Topic
14. Chat Members
    • Listing Members
    • Handling Membership Changes
    • Restricting a Member
    • Promoting a Member
    • Removing a Member
15. Invite Links and Join Requests
    • Creating an Invite Link
    • Requiring Approval
    • Handling Join Requests
    • Listing Join RequestsUSER-ONLY
16. Chat Settings
    • Changing the Title and Description
    • Changing the Photo
    • Enabling Slow ModeUSER-ONLY
    • Automatically Deleting MessagesUSER-ONLY
17. Chat Actions
    • Showing an Action
    • Reporting Upload Progress
    • Cancelling an Action
18. Sticker Sets
    • Suggesting a SlugUSER-ONLY
    • Creating a Sticker Set
    • Getting a Sticker Set
    • Managing Stickers
    • Changing Set Details
    • Managing Added Sticker SetsUSER-ONLY
    • Deleting a Sticker Set
19. Channel Direct Messages
    • Replying to a Direct Message
20. Paid Media
    • Sending Paid Media
21. Star Balance and Transactions
    • Getting the Balance
    • Listing Transactions

Users

1. Scheduled Messages
   • Scheduling a Message
   • Listing Scheduled Messages
   • Sending a Message Early
   • Deleting a Scheduled Message
2. Stories
   • Posting a Photo Story
   • Posting a Video Story
   • Setting Privacy
   • Handling Story Updates
   • Editing and Deleting a Story
   • Adding a Story to Highlights
   • Other Story-Related Methods
3. Secret Chats
   • Persisting Secret Chats
   • Requesting a Secret Chat
   • Handling Secret Chat States
   • Sending Messages
   • Sending Media and Other Content
   • Handling Secret Messages
   • Downloading Secret Media
   • Typing and Screenshots
   • Ending a Secret Chat
4. Contacts
   • Listing Contacts
   • Adding a Contact
   • Setting a Contact Note
   • Removing Contacts
5. Authorization Sessions
   • Listing Sessions
   • Removing a Session
   • Removing Other Sessions
6. Blocked Users
   • Blocking a User
   • Listing Blocked Users
   • Unblocking a User
7. Privacy Settings
   • Getting Privacy Rules
   • Setting Privacy Rules
   • Adding User Exceptions
8. Notification Settings
   • Getting Notification Settings
   • Muting a Chat
   • Changing Other Settings
   • Resetting Notification Settings
9. Communities
   • Creating a Community
   • Listing Communities
   • Getting a Community
   • Managing Chats
   • Changing the Display
   • Deleting a Community
10. Profile Music
    • Adding Music
    • Listing Profile Music
    • Removing Music
11. Archived Chats
    • Archiving a Chat
    • Listing Archived Chats
    • Unarchiving a Chat
12. Message Translation
    • Translating a Message
    • Translating Text
13. Usernames
    • Checking a Username
    • Setting a Username
    • Showing a Username
    • Hiding a Username
    • Reordering Usernames
    • Removing a Username
14. Account Auto-Deletion
    • Getting the Auto-Deletion Period
    • Setting the Auto-Deletion Period
15. Chat Recommendations
    • Getting Recommended Channels
    • Getting Similar Channels
    • Getting Similar Bots
16. Saved Messages
    • Listing Saved Chats
    • Getting Saved Messages
17. Message Drafts
    • Saving a Draft
    • Clearing Drafts

Bots

1. Keyboards and Callback Queries
   • Sending an Inline Keyboard
   • Handling Callback Queries
   • Matching Dynamic Callback Data
   • Other Keyboard Types
2. Inline Queries
   • Answering Inline Queries
   • Filtering Queries
3. Bot Profile
   • Updating Profile Information
   • Getting Profile Information
   • Localizing Profile Information
4. Payments
   • Sending an Invoice
   • Confirming Checkout
   • Handling Successful Payments
5. Streaming Responses
   • Streaming a Draft
   • Streaming a Rich Text Draft
6. Business Connections
   • Handling Connections
   • Replying to Business Messages
7. Guest Queries
   • Answering Guest Queries
8. Ephemeral Messages
   • Enabling Ephemeral Commands
   • Replying to Ephemeral Commands
   • Editing and Deleting Ephemeral Messages
9. Paid Broadcasts
   • Sending a Paid Broadcast
10. User Emoji Statuses
    • Setting an Emoji Status
    • Removing an Emoji Status
11. Managed Bots
    • Handling Updates
    • Managing Access
    • Managing Tokens
12. Bot Commands
    • Setting Commands
    • Scoping and Localizing Commands
    • Reading and Deleting Commands
13. Premium Subscription Gifts
    • Gifting a Subscription
14. Requesting Users
    • Requesting a User
    • Handling the Selection
15. Login Buttons
    • Sending a Login Button
16. Bot Write Access
    • Handling Write Access
17. Star Payment Refunds
    • Refunding a Payment

Guides

• Auth Strings
  • CLI Tool
  • One Thing to Note
• Flood Waits
  • Opting Out of the Default Behavior
  • Handling Bigger Flood Waits
• Graceful Shutdown
  • How to Know If You Need This
• Interacting with Telegram API
  • Representation of Telegram API Objects
  • Type Declarations
  • Utilities
  • Calling Functions
  • Handling Updates
• Log Verbosity
  • Levels
  • Examples
  • Filtering Logs
• Splitting Code
• Storage Adapters
  • Memory
  • sessionStorage
  • localStorage
  • Deno KV
  • IndexedDB
• Web Workers
  • Vite
• Proxies
  • MTProxy
  • SOCKS5

API Reference

• Methods
• Types

Misc

• FAQ
  • What Are the Differences Between the Telegram API and the Bot API?
  • When to Use the Telegram API?
  • What are the differences between MTKruto and TDLib?
  • Can I use Deno Deploy?
• Terminology
  • MTProto
  • Telegram API
  • Telegram Client Library
  • Telegram Client
  • Bot API
• MTKruto Server
• Acknowledgements
• Contributing
  • ...to the core
  • ...to the website
  • ...to anything else
• Source Map