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

  • Authorization
  • Invoking Methods
  • Handling Updates

API Reference

  • FTMGram Client
  • 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

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

get_chat_invite_link()¶

Client.get_chat_invite_link(chat_id: int | str, invite_link: str) → ChatInviteLink¶

Get detailed information about a chat invite link.

Usable by ✅ Users ❌ Bots
Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel/supergroup (in the format @username).

  • invite_link (str) – The invite link.

Returns:

ChatInviteLink – On success, the invite link is returned.

Made with Sphinx and @pradyunsg's Furo
On this page
  • get_chat_invite_link()
    • Client.get_chat_invite_link()