Available Methods

This page is about Pyrogram methods. All the methods listed here are bound to a Client instance, except for idle() and compose(), which are special functions that can be found in the main package directly.

from pyrogram import Client

app = Client("my_account")

with app:
    app.send_message("me", "hi")

---

Utilities

start	Start the client.
stop	Stop the Client.
run	Start the client, idle the main script and finally stop the client.
restart	Restart the Client.
add_handler	Register an update handler.
remove_handler	Remove a previously-registered update handler.
stop_transmission	Stop downloading or uploading a file.
export_session_string	Export the current authorized session as a serialized string.
set_parse_mode	Set the parse mode to be used globally by the client.
set_dc	Set configuration for the specified datacenter.
get_dc_option
get_session	Get existing session or create a new one.
get_file

idle	Block the main script execution until a signal is received.
compose	Run multiple clients at once.

Messages

send_message	Send text messages.
forward_media_group	Forward a media group by providing one of the message ids.
forward_messages	Forward messages of any kind.
copy_message	Copy messages of any kind.
copy_media_group	Copy a media group by providing one of the message ids.
send_photo	Send photos.
send_audio	Send audio files.
send_document	Send generic files.
send_screenshot_notification	Notify the other user in a private chat that a screenshot of the chat was taken.
send_sticker	Send static .webp or animated .tgs stickers.
send_video	Send video files.
send_animation	Send animation files (animation or H.264/MPEG-4 AVC video without sound).
send_voice	Send audio files.
send_video_note	Send video messages.
send_media_group	Send a group of photos or videos as an album.
send_message_draft	Use this method to stream a partial message to a user while the message is being generated.
send_location	Send points on the map.
send_venue	Send information about a venue.
send_contact	Send phone contacts.
send_cached_media	Send any media stored on the Telegram servers using a file_id.
send_reaction	Send a reaction to a message or story.
edit_message_text	Edit the text of messages.
fix_text_with_ai	Fixes text using an AI model.
edit_message_caption	Edit the caption of media messages.
edit_message_checklist	Use this method to edit a checklist.
edit_message_media	Edit animation, audio, document, photo or video messages, or to add media to text messages.
edit_message_reply_markup	Edit only the reply markup of messages sent by the bot.
edit_inline_text	Edit the text of inline messages.
edit_inline_caption	Edit the caption of inline media messages.
edit_inline_media	Edit inline animation, audio, document, photo or video messages, or to add media to text messages.
edit_inline_reply_markup	Edit only the reply markup of inline messages sent via the bot (for inline bots).
send_chat_action	Tell the other party that something is happening on your side.
send_checklist	Send a new checklist.
delete_messages	Delete messages, including service messages.
get_available_effects	Get all available effects.
get_messages	Get one or more messages from a chat by using message identifiers or link.
get_scheduled_messages	Get one or more scheduled messages from a chat.
get_stickers	Get all stickers from set by short name.
get_web_app_link_url	Returns an HTTPS URL of a Web App to open.
get_web_app_url	Returns an HTTPS URL of a Web App to open from the side menu, a KeyboardButton button with web app type, or an InlineKeyboardButton button with web app type.
mark_checklist_tasks_as_done	Add tasks of a checklist in a message as done or not done.
open_web_app	Informs pyrogram that a Web App is being opened from the attachment menu, a MenuButton, an url, or an InlineKeyboardButton button.
get_media_group	Get the media group a message belongs to.
get_chat_history	Get messages from a chat history.
get_chat_history_count	Get the total count of messages in a chat.
read_mentions	Mark a mention in the chat as read.
read_reactions	Mark a reaction in the chat as read.
read_chat_history	Mark a chat's message history as read.
send_poll	A message with a poll.
view_messages	Increment message views counter.
vote_poll	Vote a poll.
stop_poll	Stop a poll which was sent by you.
retract_vote	Retract your vote in a poll.
send_dice	Send a dice with a random value from 1 to 6.
search_messages	Search for text and media messages inside a specific chat.
search_messages_count	Get the count of messages resulting from a search inside a chat.
search_posts	Search posts globally by hashtag.
search_posts_count	Get the count of posts with hashtag resulting from a search.
search_global	Search messages globally from all of your chats.
search_global_count	Get the count of messages resulting from a global search.
download_media	Download the media from a message.
stream_media	Stream the media from a message chunk by chunk.
translate_message_text	Extract text or caption of the given message and translates it to the given language.
translate_text	Translate a text to the given language.
get_discussion_message	Get the first discussion message of a channel post or a discussion thread in a group.
get_discussion_replies	Get the message replies of a discussion thread.
get_discussion_replies_count	Get the total count of replies in a discussion thread.
get_main_web_app	Returns information needed to open the main Web App of a bot.
get_custom_emoji_stickers	Get information about custom emoji stickers by their identifiers.
get_direct_messages_chat_topic_history	Return messages in the topic in a channel direct messages chat administered by the current user.
delete_direct_messages_chat_topic_history	Delete messages in the topic in a channel direct messages chat administered by the current user.
set_direct_messages_chat_topic_is_marked_as_unread	Change the marked as unread state of the topic in a channel direct messages chat administered by the current user.
start_bot	Start bot
delete_chat_history	Delete the history of a chat.
send_paid_media	Send a group or one paid photo/video.
send_paid_reaction	Send a paid reaction to a message.
add_to_gifs	Add a GIF to the list of saved GIFs.
approve_suggested_post	Use this method to approve a suggested post in a direct messages chat.
compose_text_with_ai	Changes text using an AI model.
decline_suggested_post	Use this method to decline a suggested post in a direct messages chat.
add_checklist_tasks	Add tasks to a checklist in a message.
add_poll_option	Adds an option to a poll.
delete_poll_option	Deletes an option from a poll.
summarize_message	Summarizes content of the message with non-empty summary_language_code.

Chats

join_chat	Join a group chat or channel.
leave_chat	Leave a group chat or channel.
ban_chat_member	Ban a user from a group, a supergroup or a channel.
unban_chat_member	Unban a previously banned user in a supergroup or channel.
restrict_chat_member	Restrict a user in a supergroup.
promote_chat_member	Promote or demote a user in a supergroup or a channel.
set_administrator_title	Set a custom title (rank) to an administrator of a supergroup.
set_chat_photo	Set a new chat photo or video (H.264/MPEG-4 AVC video, max 5 seconds).
delete_chat_photo	Delete a chat photo.
set_chat_title	Change the title of a chat.
set_chat_description	Change the description of a supergroup or a channel.
set_chat_direct_messages_group	Change direct messages group settings for a channel chat.
set_chat_permissions	Set default chat permissions for all members.
pin_chat_message	Pin a message in a group, channel or your own chat.
unpin_chat_message	Unpin a message in a group, channel or your own chat.
pin_forum_topic	Pin a forum topic.
process_chat_has_protected_content_disable_request	Processes request to disable has_protected_content in a chat.
unpin_forum_topic	Unpin a forum topic.
unpin_all_chat_messages	Use this method to clear the list of pinned messages in a chat.
get_chat	Get up to date information about a chat.
get_chat_member	Get information about one member of a chat.
get_chat_members	Get the members list of a chat.
get_chat_members_count	Get the number of members in a chat.
get_dialogs	Get a user's dialogs sequentially.
get_dialogs_count	Get the total count of your dialogs.
get_direct_messages_topics_by_id	Get one or more direct message topic from a chat by using topic identifiers.
get_direct_messages_topics	Get one or more topic from a direct messages channel chat.
set_chat_username	Set a channel or a supergroup username.
archive_chats	Archive one or more chats.
unarchive_chats	Unarchive one or more chats.
add_chat_members	Add new chat members to a group, supergroup or channel.
create_channel	Create a new broadcast channel.
create_group	Create a new basic group.
create_supergroup	Create a new supergroup.
delete_channel	Delete a channel.
delete_folder_invite_link	Deletes an invite link for a chat folder.
get_folder_invite_links	Returns invite links created by the current user for a shareable chat folder.
delete_supergroup	Delete a supergroup.
delete_user_history	Delete all messages sent by a certain user in a supergroup.
set_slow_mode	Set the slow mode interval for a chat.
mark_chat_unread	Mark a chat as unread.
get_chat_event_log	Get the actions taken by chat members and administrators in the last 48h.
get_chat_online_count	Get the number of members that are currently online in a chat.
get_send_as_chats	Get the list of "send_as" chats available.
set_send_as_chat	Set the default "send_as" chat for a chat.
set_chat_protected_content	Set the chat protected content setting.
close_forum_topic	Close a forum topic.
create_forum_topic	Create a new forum topic.
delete_forum_topic	Delete a forum topic.
edit_forum_topic	Edit a forum topic.
get_forum_topics	Get one or more topic from a chat.
get_forum_topics_by_id	Get one or more topic from a chat by using topic identifiers.
update_color	Update color
set_upgraded_gift_colors	Changes color scheme for the current user based on an owned or a hosted upgraded gift.
update_chat_notifications	Update the notification settings for the selected chat
toggle_forum_topics	Enable or disable forum functionality in a supergroup.
create_folder_invite_link	Create a new invite link for a chat folder.
get_chats_for_folder_invite_link	Returns chats from a chat folder, suitable for adding to a chat folder invite link.
get_folders	Return information about a chat folders.
create_folder	Create new chat folder.
delete_folder	Delete a user's folder.
reorder_folders	Change the order of chat folders.
edit_folder	Update chat folder.
get_similar_channels	Get similar channels.
join_folder	Join a folder by its invite link.
leave_folder	Leave a folder by its invite link.
toggle_join_to_send	Enable or disable guest users' ability to send messages in a supergroup.
toggle_folder_tags	Toggles whether chat folder tags are enabled.
set_chat_ttl	Set the time-to-live for the chat.
get_personal_channels	Get all your public channels.
get_chat_settings	Get information about a chat settings.
transfer_chat_ownership	Change the owner of a chat or channel.
get_suitable_discussion_chats	Return a list of basic group and supergroup chats, which can be used as a discussion group for a channel.
set_chat_discussion_group	Change the discussion group of a channel chat.
set_chat_member_tag	Use this method to set a tag for a regular member in a group or a supergroup.
set_main_profile_tab	Changes the main profile tab of the user or channel.

Users

get_me	Get your own user identity.
get_users	Get information about a user.
get_chat_photos	Get a chat or a user profile photos sequentially.
get_chat_audios	Get a user profile audios sequentially.
get_chat_photos_count	Get the total count of photos for a chat.
get_chat_audios_count	Get the total count of audios for a chat.
set_profile_photo	Changes a profile photo for the current user.
set_personal_channel	Set a personal channel in bio.
delete_profile_photos	Delete your own profile photos.
set_username	Set your own username.
update_profile	Update your profile details such as first name, last name and bio.
block_user	Block a user.
unblock_user	Unblock a user.
get_common_chats	Get the common chats you have with a user.
get_default_emoji_statuses	Get the default emoji statuses.
set_emoji_status	Set the emoji status.
update_status	Update your profile status.
check_username	Check if a username is available.
update_birthday	Update birthday in your profile.

Invite Links

get_chat_invite_link	Get detailed information about a chat invite link.
export_chat_invite_link	Generate a new primary invite link for a chat; any previously generated primary link is revoked.
create_chat_invite_link	Create an additional invite link for a chat.
edit_chat_invite_link	Edit a non-primary invite link.
revoke_chat_invite_link	Revoke a previously created invite link.
delete_chat_invite_link	Delete an already revoked invite link.
get_chat_invite_link_joiners	Get the members who joined the chat with the invite link.
get_chat_invite_link_joiners_count	Get the count of the members who joined the chat with the invite link.
get_chat_admin_invite_links	Get the invite links created by an administrator in a chat.
get_chat_admin_invite_links_count	Get the count of the invite links created by an administrator in a chat.
get_chat_admins_with_invite_links	Get the list of the administrators that have exported invite links in a chat.
get_chat_join_requests	Get the pending join requests of a chat.
delete_chat_admin_invite_links	Delete all revoked invite links of an administrator.
approve_chat_join_request	Approve a chat join request.
approve_all_chat_join_requests	Approve all pending join requests in a chat.
decline_chat_join_request	Decline a chat join request.
decline_all_chat_join_requests	Decline all pending join requests in a chat.

Contacts

add_contact	Add an existing Telegram user as contact, even without a phone number.
delete_contacts	Delete contacts from your Telegram address book.
import_contacts	Import contacts to your Telegram address book.
get_blocked_message_senders	Returns users and chats that were blocked by the current user.
get_contacts	Get contacts from your Telegram address book.
get_contacts_count	Get the total count of contacts from your Telegram address book.
search_contacts	Returns users or channels found by name substring and auxiliary data.
set_contact_note	Changes a note of a contact user.

Password

enable_cloud_password	Enable the Two-Step Verification security feature (Cloud Password) on your account.
change_cloud_password	Change your Two-Step Verification password (Cloud Password) with a new one.
remove_cloud_password	Turn off the Two-Step Verification security feature (Cloud Password) on your account.

Bots

get_inline_bot_results	Get bot results via inline queries.
send_inline_bot_result	Send an inline bot result.
send_invoice	Use this method to send invoices.
answer_callback_query	Send answers to callback queries sent from inline keyboards.
answer_inline_query	Send answers to an inline query.
request_callback_answer	Request a callback answer from bots.
send_game	Send a game.
set_game_score	Set the score of the specified user in a game.
get_game_high_scores	Get data for high score tables.
set_bot_commands	Set the list of the bot's commands.
get_bot_commands	Get the current list of the bot's commands for the given scope and user language.
delete_bot_commands	Delete the list of the bot's commands for the given scope and user language.
edit_user_star_subscription	Cancels or re-enables Telegram Star subscription for a user.
set_bot_default_privileges	Change the default privileges requested by the bot when it's added as an administrator to groups or channels.
get_bot_default_privileges	Get the current default privileges of the bot.
set_chat_menu_button	Change the bot's menu button in a private chat, or the default menu button.
get_chat_menu_button	Get the current value of the bot's menu button in a private chat, or the default menu button.
answer_web_app_query	Set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated.
check_bot_username	Checks whether a username can be set for a new bot.
create_bot	Creates a bot which will be managed by another bot.
answer_pre_checkout_query	Send answers to pre-checkout queries.
answer_shipping_query	If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the API sends the confirmation in the form of an ShippingQueryHandler.
create_invoice_link	Create invoice link.
refund_star_payment	Refunds a successful payment in Telegram Stars.
set_bot_info_description	Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty.
get_bot_info_description	Use this method to get the current / owned bot description for the given user language.
set_bot_info_short_description	Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot.
get_bot_info_short_description	Use this method to get the current / owned bot short description for the given user language.
set_bot_name	Use this method to get the current / owned bot name for the given user language.
get_bot_name	Use this method to get the current / owned bot name for the given user language.
get_managed_bot_token	Use this method to get the token of a managed bot.
replace_managed_bot_token	Use this method to revoke the current token of a managed bot and generate a new one.
get_owned_bots	Returns the list of bots owned by the current user.

Authorization

connect	Connect the client to Telegram servers.
disconnect	Disconnect the client from Telegram servers.
initialize	Initialize the client by starting up workers.
terminate	Terminate the client by shutting down workers.
send_phone_number_code	Sends a code to the specified phone number.
resend_phone_number_code	Re-send the confirmation code using a different type.
sign_in	Authorize a user in Telegram with a valid confirmation code.
sign_in_bot	Authorize a bot using its bot token generated by BotFather.
sign_up	Register a new user in Telegram.
get_password_hint	Get your Two-Step Verification password hint.
check_password	Check your Two-Step Verification password and log in.
change_phone_number	Change a user phone number in Telegram with a valid confirmation code.
send_recovery_code	Send a code to your email to recover your password.
recover_password	Recover your password with a recovery code and log in.
accept_terms_of_service	Accept the given terms of service.
log_out	Log out from Telegram and delete the *.session file.
get_active_sessions	Returns all active sessions of the current user.
reset_session	Log out an active authorized session by its hash.
reset_sessions	Terminates all user's authorized sessions except for the current one.

Stories

can_post_stories	Check whether we can post stories as the specified chat.
copy_story	Copy story.
delete_stories	Delete posted stories.
edit_story_caption	Edit the caption of story.
edit_story_media	Edit story media.
edit_story_privacy	Edit the privacy of story.
forward_story	Forward story.
get_all_stories	Get all active or hidden stories that displayed on the action bar on the homescreen.
get_chat_stories	Get all non expired stories from a chat by using chat identifier.
get_pinned_stories	Get all pinned stories from a chat by using chat identifier.
get_archived_stories	Get all archived stories from a chat by using chat identifier.
get_stories	Get one or more stories from a chat by using stories identifiers.
hide_chat_stories	Hide the active stories of a user, preventing them from being displayed on the action bar on the homescreen.
show_chat_stories	Show the active stories of a user and display them in the action bar on the homescreen.
view_stories	Increment story views.
pin_chat_stories	Pin one or more stories in a chat by using stories identifiers.
unpin_chat_stories	Unpin one or more stories in a chat by using stories identifiers.
read_chat_stories	Mark all stories up to a certain identifier as read, for a given chat.
send_story	Post new story.
enable_stealth_mode	Activates stories stealth mode.
get_story_views	Obtain the list of users that have viewed a specific story we posted.

Premium

apply_boost	Apply boost
get_boosts	Get your boosts list
get_boosts_status	Get boosts status of channel

Phone

get_call_members

Get the members list of a chat call.

Business

delete_business_messages	Delete messages on behalf of a business account.
get_business_account_gifts	Return the gifts received and owned by a managed business account.
get_business_account_star_balance	Return the amount of Telegram Stars owned by a managed business account.
get_business_connection	Use this method to get information about the connection of the bot with a business account.
transfer_business_account_stars	Transfers Telegram Stars from the business account balance to the bot’s balance.

Payments

apply_gift_code	Apply a gift code.
buy_gift_upgrade	Pays for upgrade of a regular gift that is owned by another user or channel chat.
check_gift_code	Get information about a gift code.
convert_gift_to_stars	Convert a given regular gift to Telegram Stars.
get_available_gifts	Get all available star gifts that can be sent to other users.
get_chat_gifts	Get all gifts owned by specified chat.
get_gift_auction_state	Returns auction state for a gift.
get_chat_gifts_count	Get the total count of owned gifts of specified chat.
add_collection_gifts	Adds gifts to the beginning of a previously created collection.
create_gift_collection	Creates a collection from gifts on the current user's or a channel's profile page.
delete_gift_collection	Deletes a gift collection.
drop_gift_original_details	Drops original details for an upgraded gift.
edit_star_subscription	Cancels or re-enables Telegram Star subscription.
get_gift_collections	Returns collections of gifts owned by the given user or chat.
remove_collection_gifts	Removes gifts from a collection.
reorder_collection_gifts	Changes order of gifts in a collection.
reorder_gift_collections	Changes order of gift collections.
reuse_star_subscription	Reuses an active Telegram Star subscription to a channel chat and joins the chat again.
set_gift_collection_name	Changes name of a gift collection.
get_gift_upgrade_preview	Return examples of possible upgraded gifts for a regular gift.
get_gift_upgrade_variants	Returns all possible variants of upgraded gifts for a regular gift.
get_gifts_for_crafting	Returns upgraded gifts of the current user that can be used to craft another gifts.
craft_gift	Crafts a new gift from other gifts that will be permanently lost.
get_payment_form	Get an invoice payment form.
get_stars_balance	Get the current Telegram Stars balance of the current account.
get_ton_balance	Get the current TON balance of the current account.
get_upgraded_gift_value_info	Returns information about value of an upgraded gift by its name.
get_upgraded_gift	Get information about upgraded gift.
gift_premium_with_stars	Allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars.
hide_gift	Hide gift on the current user's or the channel's profile page.
increase_gift_auction_bid	Increases a bid for an auction gift without changing gift text and receiver.
place_gift_auction_bid	Places a bid on an auction gift.
search_gifts_for_resale	Get upgraded gifts that can be bought from other owners.
send_gift	Send a gift to another user or channel chat.
send_payment_form	Send a filled-out payment form to the bot for final verification.
send_resold_gift	Send an upgraded gift that is available for resale to another user or channel chat.
set_gift_resale_price	Change resale price of a unique gift owned by the current user.
set_pinned_gifts	Change the list of pinned gifts on the current user.
show_gift	Display gift on the current user's or the channel's profile page.
suggest_birthday	Suggests a birthdate to another regular user with common messages and allowing non-paid messages.
transfer_gift	Transfers an owned unique gift to another user.
upgrade_gift	Upgrade a given regular gift to a unique gift.
process_gift_purchase_offer	Handles a pending gift purchase offer.
send_gift_purchase_offer	Sends an offer to purchase an upgraded gift.

Account

add_profile_audio	Adds an audio file to the beginning of the profile audio files of the current user.
remove_profile_audio	Removes an audio file from the profile audio files of the current user.
set_profile_audio_position	Changes position of an audio file in the profile audio files of the current user.
get_account_ttl	Get days to live of account.
set_account_ttl	Set days to live of account.
set_privacy	Set account privacy rules.
get_privacy	Get account privacy rules.
set_global_privacy_settings	Set account global privacy settings.
set_inactive_session_ttl	Changes the period of inactivity after which sessions will automatically be terminated.
get_global_privacy_settings	Get account global privacy settings.

Advanced

Methods used only when dealing with the raw Telegram API. Learn more about how to use the raw API at Advanced Usage.

invoke	Invoke raw Telegram functions.
recover_gaps	Restores updates for the time while the client was offline.
resolve_peer	Get the InputPeer of a known peer id.
save_file	Upload a file onto Telegram servers, without actually sending the message to anyone.