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

Introduction

  • Quick Start
  • Install Guide

Getting Started

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

API Reference

  • Irenogram Client
  • Available Methods
    • invoke
    • resolve_peer
    • save_file
    • check_password
    • connect
    • disconnect
    • get_active_sessions
    • get_password_hint
    • initialize
    • log_out
    • recover_password
    • resend_code
    • send_code
    • send_recovery_code
    • sign_in
    • sign_in_bot
    • sign_in_qrcode
    • terminate
    • answer_callback_query
    • answer_inline_query
    • answer_web_app_query
    • create_managed_bot
    • delete_bot_commands
    • get_bot_commands
    • get_bot_default_privileges
    • get_bot_info
    • get_chat_menu_button
    • get_collectible_item_info
    • get_game_high_scores
    • get_inline_bot_results
    • get_managed_bot_token
    • get_owned_bots
    • get_similar_bots
    • list_managed_bots
    • remove_chat_verification
    • remove_user_verification
    • request_callback_answer
    • save_prepared_inline_message
    • send_game
    • send_inline_bot_result
    • set_bot_commands
    • set_bot_default_privileges
    • set_bot_info
    • set_chat_menu_button
    • set_game_score
    • set_user_emoji_status
    • verify_chat
    • verify_user
    • answer_pre_checkout_query
    • answer_shipping_query
    • delete_business_messages
    • get_business_account_gifts
    • get_business_account_star_balance
    • get_business_connection
    • read_business_message
    • remove_business_account_profile_photo
    • set_business_account_bio
    • set_business_account_gift_settings
    • set_business_account_name
    • set_business_account_profile_photo
    • set_business_account_username
    • transfer_business_account_stars
    • add_chat_members
    • archive_chats
    • ban_chat_member
    • ban_chat_sender_chat
    • close_forum_topic
    • close_general_topic
    • create_channel
    • create_forum_topic
    • create_group
    • create_supergroup
    • delete_channel
    • delete_chat_photo
    • delete_folder
    • delete_forum_topic
    • delete_supergroup
    • delete_user_history
    • edit_forum_topic
    • edit_general_topic
    • export_folder_link
    • get_chat
    • get_chat_event_log
    • get_chat_member
    • get_chat_members
    • get_chat_members_count
    • get_chat_online_count
    • get_chat_settings
    • get_dialogs
    • get_dialogs_count
    • get_folders
    • get_forum_topics
    • get_forum_topics_by_id
    • get_forum_topics_count
    • get_send_as_chats
    • hide_general_topic
    • join_chat
    • leave_chat
    • mark_chat_unread
    • pin_chat_message
    • promote_chat_member
    • reopen_forum_topic
    • reopen_general_topic
    • restrict_chat_member
    • set_administrator_title
    • set_chat_description
    • set_chat_member_tag
    • set_chat_permissions
    • set_chat_photo
    • set_chat_protected_content
    • set_chat_title
    • set_chat_username
    • set_send_as_chat
    • set_slow_mode
    • transfer_chat_ownership
    • unarchive_chats
    • unban_chat_member
    • unban_chat_sender_chat
    • unhide_general_topic
    • unpin_all_chat_messages
    • unpin_chat_message
    • update_color
    • update_folder
    • add_contact
    • delete_contacts
    • get_contacts
    • get_contacts_count
    • import_contacts
    • on_bot_business_connect
    • on_bot_business_message
    • on_callback_query
    • on_chat_join_request
    • on_chat_member_updated
    • on_chosen_inline_result
    • on_deleted_bot_business_messages
    • on_deleted_messages
    • on_disconnect
    • on_edited_bot_business_message
    • on_edited_message
    • on_error
    • on_inline_query
    • on_managed_bot
    • on_message
    • on_message_reaction_count_updated
    • on_message_reaction_updated
    • on_poll
    • on_pre_checkout_query
    • on_purchased_paid_media
    • on_raw_update
    • on_shipping_query
    • on_story
    • on_user_status
    • approve_all_chat_join_requests
    • approve_chat_join_request
    • create_chat_invite_link
    • decline_all_chat_join_requests
    • decline_chat_join_request
    • delete_chat_admin_invite_links
    • delete_chat_invite_link
    • edit_chat_invite_link
    • export_chat_invite_link
    • get_chat_admin_invite_links
    • get_chat_admin_invite_links_count
    • get_chat_admins_with_invite_links
    • get_chat_invite_link
    • get_chat_invite_link_joiners
    • get_chat_invite_link_joiners_count
    • get_chat_join_requests
    • revoke_chat_invite_link
    • add_poll_answer
    • add_task_to_todo
    • append_todo_list
    • approve_suggested_post
    • compose_text_with_ai
    • copy_media_group
    • copy_message
    • decline_suggested_post
    • delete_chat_history
    • delete_messages
    • delete_poll_answer
    • delete_scheduled_messages
    • download_media
    • edit_inline_caption
    • edit_inline_media
    • edit_inline_reply_markup
    • edit_inline_text
    • edit_message_caption
    • edit_message_checklist
    • edit_message_media
    • edit_message_reply_markup
    • edit_message_text
    • forward_media_group
    • forward_messages
    • get_available_effects
    • get_chat_history
    • get_chat_history_count
    • get_custom_emoji_stickers
    • get_discussion_message
    • get_discussion_replies
    • get_discussion_replies_count
    • get_media_group
    • get_message_read_participants
    • get_messages
    • get_scheduled_messages
    • inline_session
    • read_chat_history
    • retract_vote
    • search_channel_posts
    • search_global
    • search_global_count
    • search_global_hashtag_messages
    • search_global_hashtag_messages_count
    • search_messages
    • search_messages_count
    • send_animation
    • send_audio
    • send_cached_media
    • send_chat_action
    • send_checklist
    • send_contact
    • send_dice
    • send_document
    • send_location
    • send_media_group
    • send_message
    • send_message_draft
    • send_photo
    • send_poll
    • send_reaction
    • send_sticker
    • send_todo
    • send_venue
    • send_video
    • send_video_note
    • send_voice
    • send_web_page
    • set_todo_tasks_completion
    • start_bot
    • stop_poll
    • stream_media
    • transcribe_audio
    • translate_text
    • vote_poll
    • change_cloud_password
    • enable_cloud_password
    • remove_cloud_password
    • apply_gift_code
    • check_giftcode
    • convert_gift
    • convert_gift_to_stars
    • create_invoice_link
    • create_star_gift_collection
    • delete_passkey
    • delete_star_gift_collection
    • edit_user_star_subscription
    • get_available_gifts
    • get_chat_gifts
    • get_chat_gifts_count
    • get_passkeys
    • get_payment_form
    • get_star_gift_auction_state
    • get_star_gift_collections
    • get_stars_balance
    • get_stars_transactions
    • get_stars_transactions_by_id
    • get_upgraded_gift
    • get_user_gifts
    • gift_premium_subscription
    • hide_gift
    • refund_stars_payment
    • reorder_star_gift_collections
    • search_gifts_for_resale
    • send_gift
    • send_invoice
    • send_paid_media
    • send_paid_reaction
    • send_payment_form
    • send_resold_gift
    • set_gift_resale_price
    • set_pinned_gifts
    • show_gift
    • transfer_gift
    • update_star_gift_collection
    • upgrade_gift
    • get_call_members
    • ask
    • get_listener_matching_with_data
    • get_listener_matching_with_identifier_pattern
    • get_many_listeners_matching_with_data
    • get_many_listeners_matching_with_identifier_pattern
    • listen
    • register_next_step_handler
    • remove_listerner
    • stop_listener
    • stop_listening
    • wait_for_callback_query
    • wait_for_message
    • add_sticker_to_set
    • create_sticker_set
    • get_sticker_set
    • block_user
    • create_story_album
    • delete_profile_photos
    • delete_stories
    • delete_story_album
    • edit_story
    • export_story_link
    • forward_story
    • get_all_stories
    • get_chat_photos
    • get_chat_photos_count
    • get_common_chats
    • get_default_emoji_statuses
    • get_me
    • get_peer_stories
    • get_stories
    • get_stories_history
    • get_story_albums
    • get_user_profile_audios
    • get_users
    • remove_my_profile_photo
    • repost_story
    • send_story
    • set_emoji_status
    • set_my_profile_photo
    • set_profile_photo
    • set_username
    • suggest_birthday
    • unblock_user
    • update_birthday
    • update_personal_chat
    • update_profile
    • update_story_album
    • add_handler
    • compose
    • export_session_string
    • idle
    • ping
    • remove_error_handler
    • remove_handler
    • restart
    • run
    • run_sync
    • start
    • stop
    • stop_transmission
  • Available Types
    • ActiveSession
    • ActiveSessions
    • LoginToken
    • Passkey
    • SentCode
    • TermsOfService
    • BotAllowed
    • BotApp
    • BotBusinessConnection
    • BotCommand
    • BotCommandScope
    • BotCommandScopeAllChatAdministrators
    • BotCommandScopeAllGroupChats
    • BotCommandScopeAllPrivateChats
    • BotCommandScopeChat
    • BotCommandScopeChatAdministrators
    • BotCommandScopeChatMember
    • BotCommandScopeDefault
    • BotInfo
    • CallbackGame
    • CallbackQuery
    • CollectibleItemInfo
    • ForceReply
    • GameHighScore
    • InlineKeyboardButton
    • InlineKeyboardButtonBuy
    • InlineKeyboardMarkup
    • KeyboardButton
    • LinkPreviewOptions
    • LoginUrl
    • ManagedBot
    • MenuButton
    • MenuButtonCommands
    • MenuButtonDefault
    • MenuButtonWebApp
    • PreparedInlineMessage
    • ReplyKeyboardMarkup
    • ReplyKeyboardRemove
    • RequestPeerTypeChannel
    • RequestPeerTypeChat
    • RequestPeerTypeManagedBot
    • RequestPeerTypeUser
    • RequestedChat
    • RequestedChats
    • RequestedUser
    • SentWebAppMessage
    • SwitchInlineQueryChosenChat
    • WebAppInfo
    • PreCheckoutQuery
    • ShippingAddress
    • ShippingOption
    • ShippingQuery
    • ChosenInlineResult
    • InlineQuery
    • InlineQueryResult
    • InlineQueryResultAnimation
    • InlineQueryResultArticle
    • InlineQueryResultAudio
    • InlineQueryResultCachedAnimation
    • InlineQueryResultCachedAudio
    • InlineQueryResultCachedDocument
    • InlineQueryResultCachedPhoto
    • InlineQueryResultCachedSticker
    • InlineQueryResultCachedVideo
    • InlineQueryResultCachedVoice
    • InlineQueryResultContact
    • InlineQueryResultDocument
    • InlineQueryResultLocation
    • InlineQueryResultPhoto
    • InlineQueryResultVenue
    • InlineQueryResultVideo
    • InlineQueryResultVoice
    • InputMedia
    • InputMediaAnimation
    • InputMediaArea
    • InputMediaAreaChannelPost
    • InputMediaAudio
    • InputMediaDocument
    • InputMediaPhoto
    • InputMediaVideo
    • InputPhoneContact
    • InputContactMessageContent
    • InputInvoiceMessageContent
    • InputLocationMessageContent
    • InputMessageContent
    • InputReplyToMessage
    • InputReplyToMonoforum
    • InputReplyToStory
    • InputTextMessageContent
    • InputTodoTask
    • InputVenueMessageContent
    • AlternativeVideo
    • Animation
    • Audio
    • AvailableEffect
    • ChatTheme
    • ChatWallpaper
    • Contact
    • ContactRegistered
    • Dice
    • Document
    • ExportedStoryLink
    • ExternalReplyInfo
    • FormattedText
    • Game
    • Giveaway
    • GiveawayLaunched
    • GiveawayResult
    • GroupCallMessage
    • Location
    • MediaArea
    • MediaAreaChannelPost
    • MediaAreaCoordinates
    • Message
    • MessageEntity
    • MessageOrigin
    • MessageOriginChannel
    • MessageOriginChat
    • MessageOriginHiddenUser
    • MessageOriginImport
    • MessageOriginUser
    • MessageReactionCountUpdated
    • MessageReactionUpdated
    • MessageReactions
    • MessageReactor
    • MessageStory
    • Photo
    • Poll
    • PollOption
    • Reaction
    • ReadParticipant
    • ScreenshotTaken
    • Sticker
    • StickerSet
    • StoriesPrivacyRules
    • Story
    • StoryAlbum
    • StoryDeleted
    • StoryForwardHeader
    • StorySkipped
    • StoryViews
    • Str
    • StrippedThumbnail
    • TextQuote
    • Thumbnail
    • TodoList
    • TodoTask
    • TodoTasksAdded
    • TodoTasksCompleted
    • TodoTasksIncompleted
    • TranscribedAudio
    • TranslatedText
    • Venue
    • Video
    • VideoNote
    • Voice
    • Wallpaper
    • WallpaperSettings
    • WebAppData
    • WebPage
    • WebPageEmpty
    • WebPagePreview
    • AuctionBidLevel
    • CheckedGiftCode
    • ExtendedMediaPreview
    • Gift
    • GiftAttribute
    • GiftCode
    • GiftedPremium
    • InputStarsTransaction
    • Invoice
    • LabeledPrice
    • PaidMedia
    • PaidMessagePriceChanged
    • PaymentForm
    • PaymentInfo
    • PaymentRefunded
    • PurchasedPaidMedia
    • StarGiftAuctionRound
    • StarGiftAuctionState
    • StarGiftAuctionUserState
    • StarGiftCollection
    • StarsRating
    • StarsStatus
    • StarsTransaction
    • SuccessfulPayment
    • Identifier
    • Listener
    • Birthday
    • BotVerification
    • BusinessInfo
    • BusinessMessage
    • BusinessRecipients
    • BusinessWeeklyOpen
    • BusinessWorkingHours
    • Chat
    • ChatAdminWithInviteLinks
    • ChatColor
    • ChatEvent
    • ChatEventFilter
    • ChatInviteLink
    • ChatJoinRequest
    • ChatJoinedByRequest
    • ChatJoiner
    • ChatMember
    • ChatMemberUpdated
    • ChatPermissions
    • ChatPhoto
    • ChatPreview
    • ChatPrivileges
    • ChatReactions
    • ChatSettings
    • Dialog
    • EmojiStatus
    • Folder
    • ForumTopic
    • ForumTopicClosed
    • ForumTopicCreated
    • ForumTopicDeleted
    • ForumTopicEdited
    • ForumTopicReopened
    • GeneralTopicHidden
    • GeneralTopicUnhidden
    • GroupCallMember
    • InviteLinkImporter
    • Link
    • PeerChannel
    • PeerUser
    • Restriction
    • User
    • Username
    • VideoChatEnded
    • VideoChatMembersInvited
    • VideoChatScheduled
    • VideoChatStarted
  • Bound Methods
    • click
    • delete
    • download
    • forward
    • copy
    • pin
    • unpin
    • edit
    • edit_text
    • edit_caption
    • edit_media
    • edit_reply_markup
    • reply
    • reply_text
    • reply_animation
    • reply_audio
    • reply_cached_media
    • reply_chat_action
    • reply_contact
    • reply_document
    • reply_game
    • reply_inline_bot_result
    • reply_location
    • reply_media_group
    • reply_photo
    • reply_poll
    • reply_sticker
    • reply_venue
    • reply_video
    • reply_video_note
    • reply_voice
    • react
    • read
    • archive
    • unarchive
    • set_title
    • set_description
    • set_photo
    • ban_member
    • unban_member
    • restrict_member
    • promote_member
    • get_member
    • get_members
    • add_members
    • join
    • leave
    • mark_unread
    • set_protected_content
    • unpin_all_messages
    • archive
    • unarchive
    • block
    • unblock
    • answer
    • edit_message_text
    • edit_message_caption
    • edit_message_media
    • edit_message_reply_markup
    • edit_message_text
    • edit_message_caption
    • edit_message_media
    • edit_message_reply_markup
    • answer
    • answer
    • answer
    • approve
    • decline
    • react
    • download
    • terminate
  • Enumerations
    • BusinessSchedule
    • ButtonStyle
    • ChatAction
    • ChatEventAction
    • ChatJoinType
    • ChatMemberStatus
    • ChatMembersFilter
    • ChatType
    • ClientPlatform
    • FolderColor
    • GiftAttributeType
    • GiftForResaleOrder
    • ListenerTypes
    • MessageEntityType
    • MessageMediaType
    • MessageOriginType
    • MessageServiceType
    • MessagesFilter
    • NextCodeType
    • ParseMode
    • PollType
    • ProfileColor
    • ReactionType
    • ReplyColor
    • SentCodeType
    • StoriesPrivacyRules
    • StoryPrivacy
    • UserStatus
  • Decorators
  • Update Handlers
  • Update Filters
  • RPC Errors

Topic Guides

  • Using Filters
  • Creating Custom Filters
  • More on Updates
  • Client Settings
  • Speedups
  • Text Formatting
  • Synchronous Usage
  • Smart Plugins
  • Storage Engines
  • Object Serialization
  • Using Proxies
  • Scheduling Tasks
  • MTProto vs. Bot API
  • Debugging
  • Test Servers
  • Advanced Usage

Meta

  • Irenogram FAQ
    • 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
  • Release Notes

Telegram Raw API

  • Raw Functions
  • Raw Types
  • Raw Base
Irenogram — version 2.3.74
Back to top
  • Home »
  • Auth
View on GitHub
Star —
Used by —

Auth¶

  • Authorization
    • Authorization
  • CodeType
    • CodeType
  • ExportedAuthorization
    • ExportedAuthorization
  • LoggedOut
    • LoggedOut
  • LoginToken
    • LoginToken
  • PasskeyLoginOptions
    • PasskeyLoginOptions
  • PasswordRecovery
    • PasswordRecovery
  • SentCode
    • SentCode
  • SentCodeType
    • SentCodeType
Previous
account.WebAuthorizations
Next
auth.Authorization
Irenogram Copyright 2025 – , Abir Arafat Chawdhury
Released under the GNU LGPL v3.0 license
Support Irenogram