• Home »
• Available Methods

View on GitHub

Star

—

Used by

—

Available Methods

All methods listed here are bound to a Client instance.

from pyrogram import Client

app = Client("my_account")

with app:
    app.send_message(chat_id="me", text="Hi!")

---

Account

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()

Advanced

invoke() recover_gaps()

resolve_peer()

save_file()

Authorization

accept_terms_of_service() change_phone_number() check_password() connect() disconnect() get_active_sessions() get_password_hint() initialize()

log_out() recover_password() resend_code() resend_phone_number_code() reset_session() reset_sessions() send_code()

send_phone_number_code() send_recovery_code() sign_in() sign_in_bot() sign_in_qrcode() sign_up() terminate()

Bots

answer_callback_query() answer_guest_query() answer_inline_query() answer_pre_checkout_query() answer_shipping_query() answer_web_app_query() check_bot_username() create_bot() create_invoice_link() create_managed_bot() delete_bot_commands() edit_user_star_subscription() get_bot_commands() get_bot_default_privileges() get_bot_info() get_bot_info_description()

get_bot_info_short_description() get_bot_name() get_chat_menu_button() get_collectible_item_info() get_game_high_scores() get_inline_bot_results() get_managed_bot_access_settings() get_managed_bot_token() get_owned_bots() get_similar_bots() list_managed_bots() refund_star_payment() remove_chat_verification() remove_user_verification() replace_managed_bot_token() request_callback_answer()

save_prepared_inline_message() send_game() send_inline_bot_result() send_invoice() set_bot_commands() set_bot_default_privileges() set_bot_info() set_bot_info_description() set_bot_info_short_description() set_bot_name() set_chat_menu_button() set_game_score() set_managed_bot_access_settings() set_user_emoji_status() verify_chat() verify_user()

Business

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()

Chats

add_chat_members() archive_chats() ban_chat_member() ban_chat_sender_chat() close_forum_topic() close_general_topic() create_channel() create_folder() create_folder_invite_link() create_forum_topic() create_group() create_supergroup() delete_channel() delete_chat_photo() delete_chat_reactions_by_sender() delete_folder() delete_folder_invite_link() delete_forum_topic() delete_supergroup() delete_user_history() edit_folder() edit_folder_invite_link() 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_chats_for_folder_invite_link() get_dialogs() get_dialogs_count() get_direct_messages_topics() get_direct_messages_topics_by_id() get_folder_invite_links() get_folders() get_forum_topics() get_forum_topics_by_id() get_forum_topics_count() get_personal_channels() get_send_as_chats() get_similar_channels() get_suitable_discussion_chats() get_top_chats() hide_general_topic() join_chat() join_folder() leave_chat() leave_folder() mark_chat_unread() pin_chat_message() pin_forum_topic() process_chat_has_protected_content_disable_request() promote_chat_member() reopen_forum_topic() reopen_general_topic() reorder_folders()

restrict_chat_member() set_administrator_title() set_chat_description() set_chat_direct_messages_group() set_chat_discussion_group() set_chat_member_tag() set_chat_permissions() set_chat_photo() set_chat_protected_content() set_chat_title() set_chat_ttl() set_chat_username() set_main_profile_tab() set_send_as_chat() set_slow_mode() set_upgraded_gift_colors() toggle_folder_tags() toggle_forum_topics() toggle_join_to_send() transfer_chat_ownership() unarchive_chats() unban_chat_member() unban_chat_sender_chat() unhide_general_topic() unpin_all_chat_messages() unpin_chat_message() unpin_forum_topic() update_chat_notifications() update_color() update_folder()

Contacts

add_contact() delete_contacts() get_blocked_message_senders()

get_contacts() get_contacts_count() import_contacts()

search_contacts() set_contact_note()

Invite Links

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()

Messages

add_checklist_tasks() add_poll_answer() add_poll_option() add_task_to_todo() add_to_gifs() append_todo_list() approve_suggested_post() compose_text_with_ai() copy_media_group() copy_message() decline_suggested_post() delete_chat_history() delete_direct_messages_chat_topic_history() delete_messages() delete_poll_answer() delete_poll_option() 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() fix_text_with_ai() forward_media_group() forward_messages() get_available_effects() get_chat_history() get_chat_history_count()

get_custom_emoji_stickers() get_direct_messages_chat_topic_history() get_discussion_message() get_discussion_replies() get_discussion_replies_count() get_main_web_app() get_media_group() get_message_read_participants() get_messages() get_scheduled_messages() get_stickers() get_web_app_link_url() get_web_app_url() mark_checklist_tasks_as_done() open_web_app() read_chat_history() read_mentions() read_reactions() remove_message_reaction() retract_vote() search_channel_posts() search_global() search_global_count() search_global_hashtag_messages() search_global_hashtag_messages_count() search_messages() search_messages_count() search_posts() search_posts_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_paid_media() send_paid_reaction() send_photo() send_poll() send_reaction() send_screenshot_notification() send_sticker() send_todo() send_venue() send_video() send_video_note() send_voice() send_web_page() set_direct_messages_chat_topic_is_marked_as_unread() set_todo_tasks_completion() start_bot() stop_poll() stream_media() summarize_message() transcribe_audio() translate_message_text() translate_text() view_messages() vote_poll()

Password

change_cloud_password()

enable_cloud_password()

remove_cloud_password()

Payments

add_collection_gifts() apply_gift_code() buy_gift_upgrade() check_gift_code() convert_gift() convert_gift_to_stars() craft_gift() create_gift_collection() create_star_gift_collection() delete_gift_collection() delete_passkey() delete_star_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_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_ton_balance() get_upgraded_gift() get_upgraded_gift_value_info() get_user_gifts() gift_premium_subscription() 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() reorder_star_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() update_star_gift_collection() upgrade_gift()

Phone

get_call_members()

Premium

apply_boost() get_boosts()

get_boosts_status()

get_user_chat_boosts()

Pyromod

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_listener()

stop_listener() stop_listening() wait_for_callback_query() wait_for_message()

Stickers

add_sticker_to_set()

create_sticker_set()

get_sticker_set()

Stories

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()

Users

block_user() check_username() create_story_album() delete_profile_photos() delete_story_album() edit_story() export_story_link() get_chat_audios() get_chat_audios_count() get_chat_photos() get_chat_photos_count()

get_common_chats() get_default_emoji_statuses() get_me() get_peer_stories() get_stories_history() get_story_albums() get_user_profile_audios() get_users() remove_my_profile_photo() repost_story() set_emoji_status()

set_my_profile_photo() set_personal_channel() set_profile_photo() set_username() unblock_user() update_birthday() update_personal_chat() update_profile() update_status() update_story_album()

Utilities

add_handler() compose() export_session_string() idle() ping()

remove_error_handler() remove_handler() restart() run()

run_sync() start() stop() stop_transmission()

Folders

check_chat_folder_invite_link()