Available Methods ================= This page is about Pyrogram methods. All the methods listed here are bound to a :class:`~pyrogram.Client` instance, except for :meth:`~pyrogram.idle()` and :meth:`~pyrogram.compose()`, which are special functions that can be found in the main package directly. .. code-block:: python from pyrogram import Client app = Client("my_account") with app: app.send_message("me", "hi") ----- .. currentmodule:: pyrogram.Client Utilities --------- .. autosummary:: :nosignatures: add_handler export_session_string remove_handler restart run start stop stop_transmission .. toctree:: :hidden: add_handler export_session_string remove_handler restart run start stop stop_transmission .. currentmodule:: pyrogram .. autosummary:: :nosignatures: idle compose .. toctree:: :hidden: idle compose .. currentmodule:: pyrogram.Client Account -------- .. autosummary:: :nosignatures: add_profile_audio get_account_ttl get_global_privacy_settings get_privacy remove_profile_audio set_account_ttl set_global_privacy_settings set_inactive_session_ttl set_privacy set_profile_audio_position .. toctree:: :hidden: add_profile_audio get_account_ttl get_global_privacy_settings get_privacy remove_profile_audio set_account_ttl set_global_privacy_settings set_inactive_session_ttl set_privacy set_profile_audio_position Messages -------- .. autosummary:: :nosignatures: copy_media_group copy_message delete_messages delete_scheduled_messages download_media edit_fact_check 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_messages 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_messages get_poll_results read_chat_history retract_vote search_global search_global_count search_messages search_messages_count send_animation send_audio send_cached_media send_checklist send_chat_action send_contact send_dice send_document send_location send_media_group send_message send_photo send_poll send_reaction send_scheduled_messages send_screenshot_notification send_sticker send_venue send_video send_video_note send_voice stop_poll stream_media summarize_text translate_text vote_poll .. toctree:: :hidden: copy_media_group copy_message delete_messages delete_scheduled_messages download_media edit_fact_check 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_messages 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_messages get_poll_results read_chat_history retract_vote search_global search_global_count search_messages search_messages_count send_animation send_audio send_cached_media send_checklist send_chat_action send_contact send_dice send_document send_location send_media_group send_message send_photo send_poll send_reaction send_scheduled_messages send_screenshot_notification send_sticker send_venue send_video send_video_note send_voice stop_poll stream_media summarize_text translate_text vote_poll Chats ----- .. autosummary:: :nosignatures: add_chat_members archive_chats ban_chat_member create_channel create_group create_supergroup delete_channel delete_chat_photo delete_supergroup delete_user_history get_chat get_chat_event_log get_chat_member get_chat_members get_chat_members_count get_chat_online_count get_dialogs get_dialogs_count get_nearby_chats get_send_as_chats join_chat leave_chat mark_chat_unread pin_chat_message promote_chat_member restrict_chat_member restrict_sponsored_messages set_administrator_title set_chat_description set_chat_permissions set_chat_photo set_chat_protected_content set_chat_title set_chat_username set_send_as_chat set_slow_mode toggle_anti_spam toggle_auto_translation toggle_forum toggle_join_to_send toggle_participants_hidden toggle_pre_history_hidden toggle_signatures toggle_slow_mode toggle_view_forum_as_messages unarchive_chats unban_chat_member unpin_all_chat_messages unpin_chat_message update_channel_color .. toctree:: :hidden: add_chat_members archive_chats ban_chat_member create_channel create_group create_supergroup delete_channel delete_chat_photo delete_supergroup delete_user_history get_chat get_chat_event_log get_chat_member get_chat_members get_chat_members_count get_chat_online_count get_dialogs get_dialogs_count get_nearby_chats get_send_as_chats join_chat leave_chat mark_chat_unread pin_chat_message promote_chat_member restrict_chat_member restrict_sponsored_messages set_administrator_title set_chat_description set_chat_permissions set_chat_photo set_chat_protected_content set_chat_title set_chat_username set_send_as_chat set_slow_mode toggle_anti_spam toggle_auto_translation toggle_forum toggle_join_to_send toggle_participants_hidden toggle_pre_history_hidden toggle_signatures toggle_slow_mode toggle_view_forum_as_messages unarchive_chats unban_chat_member unpin_all_chat_messages unpin_chat_message update_channel_color Users ----- .. autosummary:: :nosignatures: block_user delete_profile_photos get_chat_photos get_chat_photos_count get_common_chats get_default_emoji_statuses get_me get_users set_emoji_status set_profile_photo set_username unblock_user update_profile .. toctree:: :hidden: block_user delete_profile_photos get_chat_photos get_chat_photos_count get_common_chats get_default_emoji_statuses get_me get_users set_emoji_status set_profile_photo set_username unblock_user update_profile Invite Links ------------ .. autosummary:: :nosignatures: 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 .. toctree:: :hidden: 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 Contacts -------- .. autosummary:: :nosignatures: add_contact delete_contacts get_contacts get_contacts_count import_contacts .. toctree:: :hidden: add_contact delete_contacts get_contacts get_contacts_count import_contacts Folders ------- .. autosummary:: :nosignatures: check_chat_folder_invite_link .. toctree:: :hidden: check_chat_folder_invite_link Password -------- .. autosummary:: :nosignatures: change_cloud_password enable_cloud_password remove_cloud_password .. toctree:: :hidden: change_cloud_password enable_cloud_password remove_cloud_password Bots ---- .. autosummary:: :nosignatures: allow_bot_send_message answer_callback_query answer_inline_query answer_web_app_query can_bot_send_message delete_bot_commands get_admined_bots get_bot_commands get_bot_default_privileges get_bot_info get_chat_menu_button get_game_high_scores get_inline_bot_results request_callback_answer send_game send_inline_bot_result set_bot_commands set_bot_default_privileges set_chat_menu_button set_game_score .. toctree:: :hidden: allow_bot_send_message answer_callback_query answer_inline_query answer_web_app_query can_bot_send_message delete_bot_commands get_admined_bots get_bot_commands get_bot_default_privileges get_bot_info get_chat_menu_button get_game_high_scores get_inline_bot_results request_callback_answer send_game send_inline_bot_result set_bot_commands set_bot_default_privileges set_chat_menu_button set_game_score Business --------- .. autosummary:: :nosignatures: create_business_chat_link delete_business_chat_link delete_business_messages get_business_account_gifts get_business_account_star_balance get_business_chat_links get_business_connection get_connected_bots resolve_business_chat_link transfer_business_account_stars update_business_away_message update_business_greeting_message update_business_intro update_business_location update_business_work_hours .. toctree:: :hidden: create_business_chat_link delete_business_chat_link delete_business_messages get_business_account_gifts get_business_account_star_balance get_business_chat_links get_business_connection get_connected_bots resolve_business_chat_link transfer_business_account_stars update_business_away_message update_business_greeting_message update_business_intro update_business_location update_business_work_hours Payments --------- .. autosummary:: :nosignatures: add_collection_gifts apply_gift_code buy_gift_upgrade check_gift_code convert_gift_to_stars craft_gift create_gift_collection delete_gift_collection drop_gift_original_details edit_star_subscription get_available_gifts get_chat_gifts get_chat_gifts_count get_gift_auction_state get_gift_collections get_gift_upgrade_preview get_gift_upgrade_variants get_gifts_for_crafting get_payment_form get_stars_balance get_ton_balance get_upgraded_gift get_upgraded_gift_value_info gift_premium_with_stars hide_gift increase_gift_auction_bid place_gift_auction_bid process_gift_purchase_offer remove_collection_gifts reorder_collection_gifts reorder_gift_collections reuse_star_subscription search_gifts_for_resale send_gift send_gift_purchase_offer send_payment_form send_resold_gift set_gift_collection_name set_gift_resale_price set_pinned_gifts show_gift suggest_birthday transfer_gift upgrade_gift .. toctree:: :hidden: add_collection_gifts apply_gift_code buy_gift_upgrade check_gift_code convert_gift_to_stars craft_gift create_gift_collection delete_gift_collection drop_gift_original_details edit_star_subscription get_available_gifts get_chat_gifts get_chat_gifts_count get_gift_auction_state get_gift_collections get_gift_upgrade_preview get_gift_upgrade_variants get_gifts_for_crafting get_payment_form get_stars_balance get_ton_balance get_upgraded_gift get_upgraded_gift_value_info gift_premium_with_stars hide_gift increase_gift_auction_bid place_gift_auction_bid process_gift_purchase_offer remove_collection_gifts reorder_collection_gifts reorder_gift_collections reuse_star_subscription search_gifts_for_resale send_gift send_gift_purchase_offer send_payment_form send_resold_gift set_gift_collection_name set_gift_resale_price set_pinned_gifts show_gift suggest_birthday transfer_gift upgrade_gift Stories -------- .. autosummary:: :nosignatures: can_post_stories copy_story delete_stories edit_story_caption edit_story_media edit_story_privacy enable_stealth_mode forward_story get_all_stories get_archived_stories get_chat_stories get_pinned_stories get_stories get_story_views hide_chat_stories pin_chat_stories read_chat_stories send_story show_chat_stories unpin_chat_stories view_stories .. toctree:: :hidden: can_post_stories copy_story delete_stories edit_story_caption edit_story_media edit_story_privacy enable_stealth_mode forward_story get_all_stories get_archived_stories get_chat_stories get_pinned_stories get_stories get_story_views hide_chat_stories pin_chat_stories read_chat_stories send_story show_chat_stories unpin_chat_stories view_stories Phone ------ .. autosummary:: :nosignatures: get_call_members .. toctree:: :hidden: get_call_members Premium -------- .. autosummary:: :nosignatures: apply_boost get_boosts get_boosts_status .. toctree:: :hidden: apply_boost get_boosts get_boosts_status Decorators ----------- .. autosummary:: :nosignatures: on_business_connection on_business_message on_callback_query on_chat_boost on_chat_join_request on_chat_member_updated on_chosen_inline_result on_connect on_deleted_business_messages on_deleted_messages on_disconnect on_edited_business_message on_edited_message on_error on_guest_message on_inline_query on_managed_bot on_message on_message_reaction on_message_reaction_count on_poll on_pre_checkout_query on_purchased_paid_media on_raw_update on_shipping_query on_start on_stop on_story on_user_status .. toctree:: :hidden: on_business_connection on_business_message on_callback_query on_chat_boost on_chat_join_request on_chat_member_updated on_chosen_inline_result on_connect on_deleted_business_messages on_deleted_messages on_disconnect on_edited_business_message on_edited_message on_error on_guest_message on_inline_query on_managed_bot on_message on_message_reaction on_message_reaction_count on_poll on_pre_checkout_query on_purchased_paid_media on_raw_update on_shipping_query on_start on_stop on_story on_user_status Authorization -------------- .. autosummary:: :nosignatures: accept_terms_of_service check_password connect disconnect get_password_hint initialize log_out recover_password resend_code send_code send_recovery_code sign_in sign_in_bot sign_up terminate .. toctree:: :hidden: accept_terms_of_service check_password connect disconnect get_password_hint initialize log_out recover_password resend_code send_code send_recovery_code sign_in sign_in_bot sign_up terminate Advanced -------- Methods used only when dealing with the raw Telegram API. Learn more about how to use the raw API at :doc:`Advanced Usage <../../topics/advanced-usage>`. .. autosummary:: :nosignatures: invoke recover_gaps resolve_peer save_file .. toctree:: :hidden: invoke recover_gaps resolve_peer save_file