Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
FTMGram
Logo
FTMGram

Introduction

  • Quick Start
  • Install Guide

Getting Started

  • Project Setup
  • Authorization
  • Invoking Methods
  • Handling Updates
  • Error Handling
  • Examples
    • hello_world
    • echo_bot
    • business_echo_bot
    • welcome_bot
    • get_history
    • get_chat_members
    • get_dialogs
    • callback_queries
    • inline_queries
    • use_inline_bots
    • bot_keyboards
    • send_voice
    • raw_updates

API Reference

  • FTMGram Client
  • Methods
    • send_message()
    • send_rich_message()
    • send_rich_message_draft()
    • send_message_draft()
    • send_photo()
    • send_audio()
    • send_video()
    • send_document()
    • send_animation()
    • send_sticker()
    • send_voice()
    • send_video_note()
    • send_location()
    • send_contact()
    • send_poll()
    • send_dice()
    • send_media_group()
    • send_checklist()
    • forward_messages()
    • copy_message()
    • copy_media_group()
    • edit_message_text()
    • edit_message_caption()
    • edit_message_media()
    • edit_message_reply_markup()
    • edit_ephemeral_message_text()
    • delete_ephemeral_message()
    • delete_messages()
    • get_messages()
    • get_chat_history()
    • search_messages()
    • download_media()
    • fast_download()
    • fast_upload()
    • send_chat_action()
    • translate_message_text()
    • get_chat()
    • get_bot_chat_history()
    • get_dialogs()
    • join_chat()
    • leave_chat()
    • create_group()
    • create_channel()
    • create_supergroup()
    • get_chat_members()
    • get_chat_member()
    • ban_chat_member()
    • unban_chat_member()
    • restrict_chat_member()
    • promote_chat_member()
    • set_chat_title()
    • set_chat_description()
    • set_chat_photo()
    • delete_chat_photo()
    • pin_chat_message()
    • unpin_chat_message()
    • get_chat_invite_link()
    • create_chat_invite_link()
    • archive_chats()
    • set_slow_mode()
    • set_chat_permissions()
    • get_forum_topics()
    • create_forum_topic()
    • get_me()
    • get_users()
    • get_user_profile_photos()
    • block_user()
    • unblock_user()
    • update_profile()
    • set_profile_photo()
    • get_common_chats()
    • answer_callback_query()
    • answer_inline_query()
    • answer_web_app_query()
    • set_bot_commands()
    • get_bot_commands()
    • delete_bot_commands()
    • set_chat_menu_button()
    • get_chat_menu_button()
    • answer_chat_join_request_query()
    • send_chat_join_request_web_app()
    • get_business_connection()
    • verify_user()
    • create_bot()
    • get_owned_star_count()
    • send_invoice()
    • create_invoice_link()
    • answer_shipping_query()
    • answer_pre_checkout_query()
    • refund_star_payment()
    • send_reaction()
    • get_custom_emoji_stickers()
    • get_sticker_set()
    • create_new_sticker_set()
    • add_sticker_to_set()
    • set_sticker_position_in_set()
    • delete_sticker_from_set()
    • start()
    • stop()
    • run()
    • idle()
    • add_handler()
    • remove_handler()
    • export_session_string()
    • invoke()
  • Types
    • Message
    • Chat
    • User
    • InputRichMessage
    • InputRichBlockButtons
    • RichMessageButton
    • InputRichBlockParagraph
    • InputRichBlockTable
    • InputRichBlockExpandableBlockQuotation
    • EphemeralMessageParameters
    • DisabledButton
    • Community
    • Checklist
    • ChecklistTask
    • Link
    • InlineKeyboardMarkup
    • InlineKeyboardButton
    • ReplyKeyboardMarkup
    • KeyboardButton
    • CallbackQuery
    • InlineQuery
    • ChosenInlineResult
    • ChatMemberUpdated
    • ChatJoinRequest
    • Poll
    • PollOption
    • Dice
    • Location
    • Contact
    • Photo
    • Audio
    • Video
    • Document
    • Animation
    • Voice
    • VideoNote
    • Sticker
    • WebPage
    • Game
    • Invoice
    • SuccessfulPayment
    • ShippingQuery
    • PreCheckoutQuery
    • BotCommand
    • MenuButton
    • Story
  • Bound Methods
    • Message.reply()
    • Message.reply_text()
    • Message.reply_photo()
    • Message.reply_video()
    • Message.reply_audio()
    • Message.reply_document()
    • Message.reply_animation()
    • Message.reply_sticker()
    • Message.edit_text()
    • Message.edit_caption()
    • Message.edit_media()
    • Message.edit_reply_markup()
    • Message.delete()
    • Message.forward()
    • Message.copy()
    • Message.click()
    • Message.download()
    • Message.react()
    • Message.pin()
    • Message.unpin()
    • CallbackQuery.answer()
    • CallbackQuery.edit_message_text()
    • CallbackQuery.edit_message_caption()
    • CallbackQuery.edit_message_media()
    • CallbackQuery.edit_message_reply_markup()
    • Chat.ban_member()
    • Chat.unban_member()
    • Chat.restrict_member()
    • Chat.promote_member()
    • Chat.get_member()
    • Chat.get_members()
    • Chat.set_title()
    • Chat.set_description()
    • Chat.set_photo()
    • Chat.pin_message()
    • Chat.unpin_message()
    • Chat.leave()
    • User.block()
    • User.unblock()
    • User.archive()
    • User.unarchive()
  • Enumerations
    • ChatType
    • ParseMode
    • ButtonStyle
    • MessageMediaType
    • ChatMemberStatus
    • ChatAction
    • MessageEntityType
    • SentCodeType
    • NextCodeType
    • MessagesFilter
    • ChatMembersFilter
    • StickerType
    • ChatJoinType
    • GiftType
    • PollType
    • UserStatus
    • BlockList
    • ChatEventAction
    • FolderColor
    • MediaAreaType
    • PrivacyKey
    • StoriesPrivacyRules
  • Update Handlers
  • Decorators
  • Update Filters
  • RPC Errors
    • 303 - SeeOther
    • 400 - BadRequest
    • 401 - Unauthorized
    • 403 - Forbidden
    • 406 - NotAcceptable
    • 420 - Flood
    • 500 - InternalServerError

Topic Guides

  • In-Message Buttons
  • AI Response Streaming & Drafts
  • Ephemeral Messages
  • Checklists & Task Lists
  • Text Formatting
  • Smart Plugins
  • Storage Engines
  • Creating Filters
  • Using Filters
  • More on Updates
  • Client Settings
  • Speedups
  • Proxy Settings
  • Scheduling Tasks
  • Advanced Usage
  • MTProto vs Bot API
  • Debugging
  • Test Servers
  • Voice Calls
  • Object Serialization
  • Synchronous Usage
  • Message identifiers
  • Comparison with Other FTMGram Forks

Releases & Changelog

  • Version 3.5.1
  • Release Notes
    • Version 3.5.1
    • Version 3.5.0
    • FTMGram v2.2.24
    • FTMGram v2.2.23
    • FTMGram v2.2.22
    • FTMGram v2.2.21
    • FTMGram v2.2.18
    • FTMGram v2.2.17
    • FTMGram v2.2.16
    • FTMGram v2.2.15
    • FTMGram v2.2.14
    • FTMGram v2.2.13
    • FTMGram v2.2.12
    • FTMGram v2.2.11
    • FTMGram v2.2.10
    • FTMGram v2.2.9
    • FTMGram v2.2.8
    • FTMGram v2.2.7
    • FTMGram v2.2.6
    • FTMGram v2.2.5
    • FTMGram v2.2.4
    • FTMGram v2.2.2
    • FTMGram v2.2.1
    • FTMGram v2.1.37
    • FTMGram v2.1.36
    • FTMGram v2.1.35
    • FTMGram v2.1.34
    • FTMGram v2.1.33.13
    • FTMGram v2.1.33.12
    • FTMGram v2.1.33.11
    • FTMGram v2.1.33.10
    • FTMGram v2.1.33.9
    • FTMGram v2.1.33.8
    • FTMGram v2.1.33.7
    • FTMGram v2.1.33.4
    • FTMGram v2.1.33.3
    • FTMGram v2.1.33.2
    • FTMGram v2.1.33.1
    • FTMGram v2.1.32.15
    • FTMGram v2.1.32.14
    • FTMGram v2.1.32.13
    • FTMGram v2.1.32.12
    • FTMGram v2.1.32.11
    • FTMGram v2.1.32.10
    • FTMGram v2.1.32.9
    • FTMGram v2.1.32.8
    • FTMGram v2.1.32.7
    • FTMGram v2.1.32.6
    • FTMGram v2.1.32.4
    • FTMGram v2.1.32.3
    • FTMGram v2.1.32.2
    • FTMGram v2.1.32.1
    • FTMGram v2.1.31
    • FTMGram v2.1.30
    • FTMGram v2.1.29
    • FTMGram v2.1.28
    • FTMGram v2.1.27
    • FTMGram v2.1.26
    • FTMGram v2.1.25
    • FTMGram v2.1.23
    • FTMGram v2.1.22
    • FTMGram v2.1.21
    • FTMGram v2.1.20
    • FTMGram v2.1.19
    • FTMGram v2.1.18

Meta

  • Frequently Asked Questions
    • Why is the API key needed for bots?
    • How to use webhooks?
    • Using the same file_id across different accounts
    • Using multiple clients at once on the same account
    • Client started, but nothing happens
    • What are the IP addresses of Telegram Data Centers?
    • Migrating the account to another data center
    • Why is the client reacting slowly in supergroups/channels?
    • PEER_ID_INVALID error
    • Code hangs when calling stop, restart, add/remove_handler
    • UnicodeEncodeError: ‘…’ codec can’t encode …
    • Uploading with URLs gives error WEBPAGE_CURL_FAILED
    • sqlite3.OperationalError: database is locked
    • sqlite3.InterfaceError: Error binding parameter
    • socket.send(), OSError(), TimeoutError(), Connection lost/reset
    • How to avoid Flood Waits?
    • The account has been limited/deactivated
  • Support FTMGram
Back to top

Enumerations¶

  • ChatType

  • ParseMode

  • ButtonStyle

  • MessageMediaType

  • ChatMemberStatus

  • ChatAction

  • MessageEntityType

  • SentCodeType

  • NextCodeType

  • MessagesFilter

  • ChatMembersFilter

  • StickerType

  • ChatJoinType

  • GiftType

  • PollType

  • UserStatus

  • BlockList

  • ChatEventAction

  • FolderColor

  • MediaAreaType

  • PrivacyKey

  • StoriesPrivacyRules

Next
ChatType
Previous
User.unarchive()
Made with Sphinx and @pradyunsg's Furo