Release Notes

This page lists all the documented changes of this fork, in reverse chronological order. You should read this when upgrading to this fork to know where your code can break, and where it can take advantage of new goodies!

For a more detailed description, please check the commits.

If you found any issue or have any suggestions, feel free to make an issue on github.

Breaking Changes in this Fork

• In download_media(), if the message is a PaidMediaInfo with more than one paid_media and idx was not specified, then a list of paths or binary file-like objects is returned.

• Make get_messages() accept only keyword-only arguments. 48d4230

• PR #115 This change breaks some usages with offset-naive and offset-aware datetimes.

• PR from upstream: #1411 without attribution.

Changes in this Fork

Scheme layer used: 198

• Added the cover and start_timestamp parameters in send_video() and InputPaidMediaVideo.

• Added the new_video_start_timestamp and renamed the send_copy and remove_caption parameters in forward_messages() and forward().

• Added the gift_count to the Chat.

• Added the get_similar_bots().

• Changed types in UpgradedGift, UserGift.

• PR from upstream: 701

• View new and changed raw API methods.

Scheme layer used: 196

• Added the get_owned_star_count() and a possibly temporary StarAmount.

• Added the UpgradedGift and changed return type get_available_gifts() and get_user_gifts().

• Added the pay_for_upgrade in the send_gift().

• Added the parameters upgrade_star_count and is_for_birthday in Gift.

• Added the on_bot_purchased_paid_media() and on_bot_business_connection().

• Added the parameters can_be_upgraded, was_refunded, prepaid_upgrade_star_count, can_be_transferred, transfer_star_count, export_date in UserGift.

• Renamed the parameter only_in_channels to chat_type_filter in the search_global_count() and search_global().

• Removed sender_user_id parameter from sell_gift() and toggle_gift_is_saved().

• View new and changed raw API methods.

Scheme layer used: 195

• Added the get_owned_bots() to return the list of owned by the current user bots.

• View new and changed raw API methods.

Scheme layer used: 194

• Added the field schedule_date and changed the return type of the send_inline_bot_result().

• Added the field subscription_expiration_date in the SuccessfulPayment.

• Added the parameter subscription_period in the create_invoice_link().

• View new and changed raw API methods.

Scheme layer used: 192

• Added SHOW_MESSAGE_SENDER_ENABLED, AGGRESSIVE_ANTI_SPAM_TOGGLED, PROTECTED_CONTENT_TOGGLED, CHAT_IS_FORUM_TOGGLED, USERNAMES_CHANGED, MEMBER_SUBSCRIPTION_EXTENDED, MEMBER_JOINED_BY_LINK, MEMBER_JOINED_BY_REQUEST, and updated ChatEventFilter with the corresponding attributes.

• Added the parameter show_caption_above_media to the edit_inline_caption().

• Added the parameter allow_paid_broadcast to the methods copy_media_group(), send_game(), send_invoice(), forward_messages(), send_animation(), send_audio(), send_cached_media(), send_contact(), send_dice(), send_document(), send_location(), send_media_group(), send_message(), send_paid_media(), send_photo(), send_poll(), send_sticker(), send_venue(), send_video_note(), send_video(), send_voice() and the bound methods reply_game(), reply_text(), reply_animation(), reply_audio(), reply_contact(), reply_document(), reply_location(), reply_media_group(), reply_photo(), reply_poll(), reply_sticker(), reply_venue(), reply_video(), reply_video_note(), reply_voice(), reply_invoice(), forward(), copy(), reply_cached_media().

• Introduced the ability to add media to existing text messages using the method edit_message_media(), edit_cached_media(), edit_media(), edit_cached_media().

• Added the class CopyTextButton and the field copy_text in the class InlineKeyboardButton allowing bots to send and receive inline buttons that copy arbitrary text.

• View new and changed raw API methods.

Scheme layer used: 190

• Added the methods get_available_gifts(), get_user_gifts(), sell_gift(), send_gift(), toggle_gift_is_saved(), toggle() and the types UserGift and Gift.

• Added the parameter send_as in the appropriate methods and bound methods PR 107.

• View new and changed raw API methods.

Scheme layer used: 189

• Added toggle_forum_topic_is_pinned() to pin / unpin a ForumTopic.

• Added star() bound method to the Message.

• Added the field alternative_videos to the Message.

• Added the fields connected_website and write_access_allowed to the Message.

• Fix chat being None in some cases in the Message.

• Fix deleting messages does not return the count in some cases.

• View new and changed raw API methods.

Scheme layer used: 187

• Added the parameter emoji in send_sticker() and reply_sticker(). #86.

• Return list of photos and videos instead of bool in send_payment_form.

• Added the field prize_star_count to the classes GiveawayCreated, Giveaway, GiveawayWinners.

• Added the field is_star_giveaway to the class GiveawayCompleted.

• Added the ability to specify a payload in send_paid_media() that is unused currently.

• View new and changed raw API methods.

Scheme layer used: 186

• Try to return the service message (when applicable) in the methods set_chat_photo(), set_photo().

• Added the methods get_payment_form() and send_payment_form() #89.

• Added the fields expired_member_count, subscription_period and subscription_price to the class ChatInviteLink.

• Added the field can_enable_paid_reaction to the class Chat.

• Added link property to Story and fixed the link property in Message.

• Introduced DraftMessage type.

• Added the ability to send paid media to any chat and the parameter business_connection_id to the send_paid_media(), allowing bots to send paid media on behalf of a business account.

• Added the field until_date to the class ChatMember for members with an active subscription.

• Added add_paid_message_reaction() and ReactionTypePaid

• Updated errors list and improved documentation of some of the methods.

• Added missing parameters to get_dialogs() and Dialog.

• Added UNKNOWN type of service message #1147.

• Added a ChatJoinType to distinguish the different types of NEW_CHAT_MEMBERS.

• Added CONTACT_REGISTERED and SCREENSHOT_TAKEN types of service messages.

• View new and changed raw API methods.

Scheme layer used: 185

• Added the parameter chat_list to the methods get_dialogs() and get_dialogs_count().

• Added gifted_stars service message to the class Message.

• Added the fields have_access, has_main_web_app, active_user_count to the class User, which is returned in response to get_me().

• Added the parameter business_connection_id to the methods pin_chat_message() and unpin_chat_message(), allowing bots to manage pinned messages on behalf of a business account.

• View new and changed raw API methods.

Scheme layer used: 184

• Updated via_bot, to optionally support filtering invalid bot user_id.

• Added the get_active_sessions(), terminate_session(), terminate(), and terminate_all_other_sessions().

• Added the is_automatic_forward to the Message.

• Added the parameters offset_id to the search_messages() and the parameters min_date, max_date, min_id, max_id, saved_messages_topic_id to the search_messages_count().

• Dynamic session ReStart + restart optimizations (#56)

• Added the delete_account(), transfer_chat_ownership(), update_status() (#49, #51)

• Added the class RefundedPayment, containing information about a refunded payment.

• Added the field refunded_payment to the class Message, describing a service message about a refunded payment.

• View new and changed raw API methods.

Scheme layer used: 183

• Added the classes PaidMedia, PaidMediaInfo, PaidMediaPreview, PaidMediaPhoto and PaidMediaVideo, containing information about paid media.

• Added the method send_paid_media() and the classes InputPaidMedia, InputPaidMediaPhoto and InputPaidMediaVideo, to support sending paid media.

• Added the field paid_media to the classes Message and ExternalReplyInfo.

• Added get_stories().

• Added filters thread and self_destruct.

• Added the field can_send_paid_media to the class Chat.

• Added support for launching Web Apps via t.me link in the class MenuButtonWebApp.

• View new and changed raw API methods.

Scheme layer used: 182

• Updated the parameter business_connection_id to the methods edit_text(), edit_media(), edit_reply_markup(), edit_message_text(), edit_message_media(), edit_message_reply_markup().

• Added the parameter business_connection_id to the methods edit_message_text(), edit_message_media(), edit_cached_media(), edit_message_caption() and edit_message_reply_markup(), allowing the bot to edit business messages.

• Added the parameter business_connection_id to the method stop_poll(), allowing the bot to stop polls it sent on behalf of a business account.

• Added support for callback queries originating from a message sent on behalf of a business account.

Scheme layer used: 181

• Added the classes InputLocationMessageContent, InputVenueMessageContent, InputContactMessageContent, InputInvoiceMessageContent.`

• Added background to Chat (#40)

• Added the methods translate_text(), translate_message_text(), translate() and the type TranslatedText (#39).

• Added the methods create_video_chat(), discard_group_call(), get_video_chat_rtmp_url() and the type RtmpUrl (#37).

• Added on_story() to listen to story updates.

• Ability to run in replit environment without creating a deployment. Set the environment variable PYROGRAM_REPLIT_NWTRAFIK_PORT value to 5222 if you want to connect to Production Telegram Servers, OR Set the environment variable PYROGRAM_REPLIT_WNTRAFIK_PORT value to 5223 if you want to connect to Test Telegram Servers, before starting the Client.

• Added the invite_group_call_participants() (#35).

• Added the types LabeledPrice, OrderInfo, PreCheckoutQuery, ShippingAddress, ShippingOption, ShippingQuery and SuccessfulPayment.

• Added the successful_payment parameter to the Message. Added the filter successful_payment to detect service messages of Successful Payment type.

• Added the methods send_invoice(), answer_pre_checkout_query() (answer()), answer_shipping_query() (answer()), refund_star_payment() and create_invoice_link().

• Added the send_web_app_custom_request().

• Added the search_public_messages_by_tag() and count_public_messages_by_tag().

• Added the fetch_replies parameter to Client.

• Added the get_message_effects().

• Added the parameter message_effect_id to the methods send_message(), send_photo(), send_video(), send_animation(), send_audio(), send_document(), send_sticker(), send_video_note(), send_voice(), send_location(), send_venue(), send_contact(), send_poll(), send_dice(), send_game(), and send_media_group(), and the corresponding reply_* methods in the class Message.

• Added the field effect_id to the class Message.

• Added the field show_caption_above_media to the classes Message, InputMediaAnimation, InputMediaPhoto, InputMediaVideo, InlineQueryResultAnimation, InlineQueryResultCachedAnimation, InlineQueryResultPhoto, InlineQueryResultCachedPhoto, InlineQueryResultVideo, InlineQueryResultCachedVideo, send_cached_media(), send_animation(), send_photo(), send_video(), copy_message() and edit_message_caption(), and the corresponding reply_* methods.

• Added support for EXPANDABLE_BLOCKQUOTE entities in received messages.

• Added support for EXPANDABLE_BLOCKQUOTE entity parsing in HTML parse mode.

• Allowed to explicitly specify EXPANDABLE_BLOCKQUOTE entities in formatted texts.

• View new and changed raw API methods.

Scheme layer used: 179

• Add invoice to Message and ExternalReplyInfo.

• Add link_preview_options to Client.

• Support for the updated Channel ID format. #28

• Improvements to save_file() and get_file() to handle the new FLOOD_PREMIUM_WAIT errors.

• Added has_animation, is_personal, minithumbnail parameters to ChatPhoto.

• Changed return type of get_chat_photos() to return Photo or Animation.

• Added get_chat_sponsored_messages() and the type SponsoredMessage, by stealing unauthored changes from KurimuzonAkuma/pyrogram#55.

• Added load_group_call_participants() and the type GroupCallParticipant, by stealing unauthored changes from 6df467f.

• Added view_messages() and the bound methods read() and view().

• Added the field question_entities to the class Poll.

• Added the field text_entities to the class PollOption.

• Added the parameters question_parse_mode and question_entities to the method send_poll().

• Added the class InputPollOption and changed the type of the parameter options in the method send_poll() to Array of InputPollOption.

• Added the field max_reaction_count to the class Chat.

• Added the field via_join_request to the class ChatMemberUpdated.

• Added the class TextQuote and the field quote of type TextQuote to the class Message, which contains the part of the replied message text or caption that is quoted in the current message.

• Added full_name to Chat and User only for PRIVATE.

• Added revoke_messages parameter to ban_chat_member() and ban_member().

• Added get_collectible_item_info().

• Added reverse parameter to get_chat_history(). (855e69e, a086b49)

• View new and changed raw API methods.

Scheme layer used: 178

• Added search_chats().

• Added get_bot_name(), get_bot_info_description(), get_bot_info_short_description(), set_bot_name(), set_bot_info_description(), set_bot_info_short_description().

• Added edit_cached_media() and edit_cached_media().

• Steal d51eef3 without attribution.

• Added max_reaction_count to ChatReactions.

• Added personal_chat_message to Chat.

• Added only_in_channels parameter to search_global() and search_global_count().

Scheme layer used: 177

• Added emoji_message_interaction parameter to send_chat_action() and reply_chat_action().

• BOTS ONLY: Updated ChatMemberUpdatedHandler to handle updates when the bot is blocked or unblocked by a user.

• Added missing parameters in create_group(), create_supergroup(), create_channel().

• Try to return the service message (when applicable) in the methods add_chat_members(), promote_chat_member()

• Add TRIGGER_EMOJI_ANIMATION and WATCH_EMOJI_ANIMATION in send_chat_action() and reply_chat_action().

• Attempted to revert the Backward Incompatible changes in the commits fb118f95d and 848bc8644.

• Added callback_data_with_password to InlineKeyboardButton and added support in click() for such buttons.

• PR from upstream: 1391 without attribution.

• Added gifted_premium service message to Message.

• Added get_stickers().

• Added filters.users_shared and filters.chat_shared.

• Added the field origin of type MessageOrigin in the class ExternalReplyInfo.

• Added the class MessageOrigin and replaced the fields forward_from, forward_from_chat, forward_from_message_id, forward_signature, forward_sender_name, and forward_date with the field forward_origin of type MessageOrigin in the class Message.

• Added accent_color, profile_color, emoji_status, is_close_friend to Chat and User.

• Added the method get_created_chats().

• Added the class ForumTopic and the methods get_forum_topics(), get_forum_topic().

• Install the version, from PyPI, using pip uninstall -y pyrogram && pip install pyrotgfork==2.1.17.

• Added the classes BusinessOpeningHours and BusinessOpeningHoursInterval and the field business_opening_hours to the class Chat.

• Added the class BusinessLocation and the field business_location to the class Chat.

• Added the class BusinessIntro and the field business_intro to the class Chat.

• Added the parameter business_connection_id to the methods send_message(), send_photo(), send_video(), send_animation(), send_audio(), send_document(), send_sticker(), send_video_note(), send_voice(), send_location(), send_venue(), send_contact(), send_poll(), send_game(), send_media_group(), send_dice(), send_chat_action(), send_cached_media() and copy_message() and the corresponding reply_* methods.

• Added get_business_connection().

• Added active_usernames to Chat and User.

• Added BusinessConnection.

• Added support for https://t.me/m/blah links in the link parameter of get_messages()

• Added the parameter message_thread_id to the search_messages() and search_messages_count().

• Added the parameter chat_list to search_global() and search_global_count().

• BOTS ONLY: Handled the parameter business_connection_id to the update handlers MessageHandler, EditedMessageHandler, DeletedMessagesHandler.

• Added the field business_connection_id to the class Message.

• Bug fix for the users_shared, chat_shared logic in Message.

• Added set_birthdate() and set_personal_chat(), for user accounts only.

• Added the field birthdate to the class Chat.

• Added the field is_from_offline to the class Message.

• Added the field sender_business_bot to the class Message.

• Added the fields users_shared, chat_shared to the class Message.

• Added the field personal_chat to the class Chat.

• Added the field can_connect_to_business to the class User.

• Rearrange send_sticker() parameter names.

• Added the fields request_title, request_username, and request_photo to the class KeyboardButtonRequestChat.

• Added the fields request_name, request_username, and request_photo to the class KeyboardButtonRequestUsers.

Scheme layer used: 176

• Add message_thread_id parameter to unpin_all_chat_messages().

• Add create_forum_topic(), edit_forum_topic(), close_forum_topic(), reopen_forum_topic(), hide_forum_topic(), unhide_forum_topic(), delete_forum_topic(), get_forum_topic_icon_stickers().

• Add AioSQLiteStorage, by stealing the following commits:

  • fded06e

• Add skip_updates parameter to Client class, by stealing the following commits:

  • c16c83a

  • 55aa162

• Add public, for_my_bot to delete_profile_photos().

• Make photo_ids parameter as optional in delete_profile_photos().

• Add supergroup_chat_created to Message.

• Add forum_topic_created, forum_topic_closed, forum_topic_edited, forum_topic_reopened, general_forum_topic_hidden, general_forum_topic_unhidden to Message.

• Add custom_action to Message.

• Add public, for_my_bot, photo_frame_start_timestamp to set_profile_photo().

• Add inline_need_location, can_be_edited to User.

• Add giveaway, giveaway_created, giveaway_completed and giveaway_winners in Message and ExternalReplyInfo.

• Bug fix for send_message() with the message_thread_id parameter.

• Added request_users and request_chat to KeyboardButton.

• NOTE: using the scheduled parameter, please be aware about using the correct Message Identifiers.

  • Add is_scheduled parameter to delete_messages().

  • Add schedule_date parameter to edit_message_caption(), edit_message_media(), edit_message_text().

  • Added is_scheduled to get_messages().

  • Added is_scheduled to get_chat_history().

• Added new parameter client_platform to Client.

• PR from upstream: 1403.

• Added story to ExternalReplyInfo.

• Added story_id to ReplyParameters.

• Added support for clicking (WebAppInfo, LoginUrl, user_id, switch_inline_query_chosen_chat) buttons in click().

• Rewrote download_media() to support Story, and also made it future proof.

• Fix bug in clicking UpdateBotCallbackQuery buttons

PmOItrOAe

• Renamed placeholder to input_field_placeholder in ForceReply and ReplyKeyboardMarkup.

• Add link parameter in get_messages()

• fix(filters): add type hints in filters.py

• Documentation Builder Fixes

• faster-pyrogram is not polished or documented for anyone else’s use. We don’t have the capacity to support faster-pyrogram as an independent open-source project, nor any desire for it to become an alternative to Pyrogram. Our goal in making this code available is a unified faster Pyrogram. …

Leaked Scheme Layers (2)

• Add ttl_seconds attribute to Voice and VideoNote class

• #713

• Removed ChatPreview class, and merged the parameters with the Chat class.

• Added description, accent_color_id, is_verified, is_scam, is_fake, is_public, join_by_request attributes to the class ChatPreview.

• Added force_full parameter to get_chat().

• Bug Fix for get_chat() and join_chat() when https://t.me/username was passed.

• Added missing attributes to the class Story when it is available.

• Added the field reply_to_story to the class Message.

• Added the field user_chat_id to the class ChatJoinRequest.

• Added the field switch_inline_query_chosen_chat of the type SwitchInlineQueryChosenChat to the class InlineKeyboardButton, which allows bots to switch to inline mode in a chosen chat of the given type.

• Add support for pay in InlineKeyboardButton

• #1345

• Add undocumented things

• Add missing enums.SentCodeType

• #693

• Revert e678c05 and stole squashed unauthored changes from bcd18d5

Scheme layer used: 174

• Added the field story to the class Message for messages with forwarded stories. Currently, it holds no information.

• Added the class ChatBoostAdded and the field boost_added to the class Message for service messages about a user boosting a chat.

• Added the field custom_emoji_sticker_set_name to the class Chat.

• Added the field unrestrict_boost_count to the class Chat.

• Added the field sender_boost_count to the class Message.

Scheme layer used: 173

• Fix ConnectionResetError when only ping task (#24)

• Added is_topic_message to the Message object.

• Added has_visible_history, has_hidden_members, has_aggressive_anti_spam_enabled, message_auto_delete_time, slow_mode_delay, slowmode_next_send_date, is_forum to the Chat object.

• Added add_to_recent, story_id parameters in set_reaction().

• Bug fix in parsing Vector<Bool> (Thanks to @AmarnathCJD and @roj1512).

• Documentation Fix of max_concurrent_transmissions type hint.

• Bug Fix in the get_file method. (Thanks to @ALiwoto).

• Added missing attributes to ChatPermissions and ChatPrivileges.

• Bug Fix for MIN_CHAT_ID.

• Added new parameter no_joined_notifications to Client.

• Fix history TTL Service Message Parse.

• Thanks to …. If you want to change the location of the unknown_errors.txt file that is created by Client, set the environment variable PYROGRAM_LOG_UNKNOWN_ERRORS_FILENAME value to the path where the file should get created.

• Renamed force_document to disable_content_type_detection in send_document() and reply_document().

• Added missing attributes added_to_attachment_menu, can_be_added_to_attachment_menu, can_join_groups, can_read_all_group_messages, supports_inline_queries, restricts_new_chats to the User.

• Migrate project to pyproject.toml from setup.py.

• PRs from upstream: 1366, 1305, 1288, 1262, 1253, 1234, 1210, 1201, 1197, 1143, 1059.

• Bug fix for send_audio() and send_voice(). (Thanks to …).

• Add waveform parameter to send_voice().

• Added view_once parameter to send_photo(), send_video(), send_video_note(), send_voice().

• Add missing parameters to reply_photo(), reply_video(), reply_video_note(), reply_voice().

Scheme layer used: 170

• Stole documentation from PyrogramMod.

• Renamed send_reaction to set_reaction().

• Added support for send_photo(), send_video(), send_animation(), send_voice() messages that could be played once.

• Added the field via_chat_folder_invite_link to the class ChatMemberUpdated.

• BOTS ONLY: Added updates about a reaction change on a message with non-anonymous reactions, represented by the class MessageReactionUpdatedHandler and the field message_reaction in the class Update.

• BOTS ONLY: Added updates about reaction changes on a message with anonymous reactions, represented by the class MessageReactionCountUpdatedHandler and the field message_reaction_count in the class Update.

• Replaced the parameter disable_web_page_preview with LinkPreviewOptions in the methods send_message() and edit_message_text().

• Replaced the field disable_web_page_preview with LinkPreviewOptions in the class InputTextMessageContent.

• Added missing parameters to forward_messages().

• Added the class ReplyParameters and replaced parameters reply_to_message_id in the methods copy_message(), send_message(), send_photo(), send_video(), send_animation(), send_audio(), send_document(), send_sticker(), send_video_note(), send_voice(), send_location(), send_venue(), send_contact(), send_poll(), send_dice(), send_game(), send_media_group(), copy_media_group(), send_inline_bot_result(), send_cached_media(), and the corresponding reply_* methods with the field reply_parameters of type ReplyParameters.

• Bug fixes for sending ttl_seconds and has_spoiler.

Scheme layer used: 169

• Changed condition in join_chat() and get_chat().

• Added disable_content_type_detection parameter to InputMediaVideo.

• Added has_spoiler parameter to copy_message().

• Improved get_chat_history(): add min_id and max_id params.

• Prevent connection to dc every time in get_file

• Added _raw to the Chat, Dialog, Message and User objects.

• Fix downloading media to WORKDIR when WORKDIR was not specified.

• Update multiple fragment chat usernames

• Custom Storage Engines

• Documentation fix for user.mention in User.

Scheme layer used: 167

• Fixed the TL flags being Python reserved keywords: from and self.

Scheme layer used: 161

• Added my_stories_from to the block_user() and unblock_user() methods.

Scheme layer used: 160

• Added message_thread_id to the methods copy_message(), forward_messages(), send_message(), send_photo(), send_video(), send_animation(), send_audio(), send_document(), send_sticker(), send_video_note(), send_voice(), send_location(), send_venue(), send_contact(), send_poll(), send_dice(), send_game(), send_media_group(), copy_media_group(), send_inline_bot_result(), send_cached_media().