Available Methods

This page is about pyroblack 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.

run_sync

Run the given sync function (optionally with arguments) on a separate thread.

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.

ping

Measure the round-trip time (RTT) to the Telegram server.

idle

Block the main script execution until a signal is received.

compose

Run multiple clients at once.

Conversation

ask

Send a message then listen for a message, callback query, etc.

listen

Listen for a message, callback query, etc.

get_listener_matching_with_data

Gets a listener that matches the given data.

get_listener_matching_with_identifier_pattern

Gets a listener that matches the given identifier pattern.

get_many_listeners_matching_with_data

Gets multiple listener that matches the given data.

get_many_listeners_matching_with_identifier_pattern

Gets multiple listener that matches the given identifier pattern.

register_next_step_handler

Registers a listener with a callback to be called when the listener is fulfilled.

remove_listener

Removes a listener from the listeners() dictionary.

stop_listener

Stops a listener, calling stopped_handler if applicable or raising ListenerStopped if throw_exceptions is True.

stop_listening

Stops all listeners that match the given identifier pattern.

wait_for_callback_query

Wait for callback query.

wait_for_message

Wait for message.

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_paid_media

Use this method to send paid media.

send_photo

Send photos.

send_audio

Send audio files.

send_document

Send generic files.

send_invoice

Use this method to send invoices.

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_web_page

Send text Web Page Preview.

start_bot

Start bot.

send_media_group

Use this method to send a group of photos, videos, documents or audios as an album.

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

Use this method to send reactions on a message/stories.

edit_message_text

Edit the text of messages.

edit_message_caption

Edit the caption of media messages.

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

Use this method when you need to tell the user that something is happening on the bot's side.

send_checklist

Send a new checklist.

delete_messages

Delete messages, including service messages, with the following limitations:

get_available_effects

Get all available effects.

get_messages

Get one or more messages from a chat by using message identifiers.

get_message_read_participants

Get the list of users who have read a message.

get_scheduled_messages

Get one or more scheduled messages from a chat.

get_stickers

Get all stickers from set by short name.

mark_checklist_tasks_as_done

Add tasks of a checklist in a message as done or not done.

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_chat_history

Mark a chat's message history as read.

send_poll

Send a native poll.

view_messages

Informs the server that messages are being viewed by the current user.

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.

search_global_hashtag_messages

Searches for public channel posts with the given hashtag.

search_global_hashtag_messages_count

Get the count of messages with the provided hashtag.

download_media

Download the media from a message.

stream_media

Stream the media from a message chunk by chunk.

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_custom_emoji_stickers

Get information about custom emoji stickers by their identifiers.

delete_chat_history

Deletes all messages in the chat.

transcribe_audio

Transcribes the audio of a voice message.

translate_message_text

Extracts text or caption of the given message and translates it to the given language.

translate_text

Translates a text to the given language.

delete_chat_history

Deletes all messages in the chat.

add_paid_message_reaction

Adds the paid message reaction to a message.

add_poll_option

Adds an option to a poll.

count_public_messages_by_tag

Get the count of messages with the provided hashtag or cashtag.

delete_poll_option

Deletes an option from a poll.

edit_cached_media

Edit a media stored on the Telegram servers using a file_id.

edit_message_checklist

Use this method to edit a checklist.

get_chat_sponsored_messages

Returns sponsored messages to be shown in a chat; for channel chats only.

search_public_messages_by_tag

Searches for public channel posts containing the given hashtag or cashtag.

send_screenshot_notification

Notify the other user in a chat that screenshot of the chat was taken.

set_reaction

Use this method to change the chosen reactions on a message.

Stories

can_post_stories

Check whether we can post stories as the specified chat.

can_post_story

Checks whether the current user can post a story on behalf of a chat.

copy_story

Copy story.

delete_stories

Deletes a previously sent story.

edit_story

Changes content, privacy settings and caption of a story.

edit_story_caption

Edit the caption of story.

edit_story_media

Edit story media.

edit_story_privacy

Edit the privacy of story.

enable_stealth_mode

Activates stories stealth mode.

export_story_link

Get one story link from an user by using story identifiers.

forward_story

Forward story.

get_all_stories

Get all active or hidden stories that displayed on the action bar on the homescreen.

get_archived_stories

Get all archived stories from a chat by using chat identifier.

get_chat_active_stories

Get all non expired stories from a chat by using chat identifier.

get_chat_archived_stories

Get all archived stories from a chat by using chat identifier.

get_chat_stories

Get all non expired stories from a chat by using chat identifier.

get_peer_stories

Get all active stories from an user/channel by using user identifiers.

get_pinned_stories

Get all pinned stories from a chat by using chat identifier.

get_stories

Get one or more stories from a chat by using stories identifiers.

get_stories_history

Get stories history.

get_story_views

Obtain the list of users that have viewed a specific story we posted.

hide_chat_stories

Hide the active stories of a user, preventing them from being displayed on the action bar on the homescreen.

hide_my_story_view

Activates stealth mode for stories, which hides all views of stories from the current user in the last "stories_stealth_past_period" seconds and for the next "stories_stealth_future_period" seconds; for Telegram Premium users only.

pin_chat_stories

Pin one or more stories in a chat by using stories identifiers.

post_story

Posts a new story on behalf of a chat.

read_chat_stories

Mark all stories up to a certain identifier as read, for a given chat.

send_story

Post new story.

show_chat_stories

Show the active stories of a user and display them in the action bar on the homescreen.

toggle_story_is_posted_to_chat_page

Toggles whether a story is accessible after expiration.

unpin_chat_stories

Unpin one or more stories in a chat by using stories identifiers.

view_stories

Increment story views.

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.

delete_folder

Delete a user's folder.

export_folder_link

Export link to a user's folder.

update_folder

Create or update a user's folder.

set_chat_title

Change the title of a chat.

set_chat_description

Change the description of a supergroup or a channel.

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.

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_folders

Get one or more folders by using folder identifiers.

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.

get_forum_topics_count

Get forum topics count from a 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_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

Use this method to close an open topic in a forum supergroup chat.

close_general_topic

Close a forum topic.

create_forum_topic

Use this method to create a topic in a forum supergroup chat or a private chat with a user.

delete_forum_topic

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user.

edit_forum_topic

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user.

edit_general_topic

Edit a general forum topic.

hide_general_topic

Hide a general forum topic.

reopen_forum_topic

Use this method to reopen a closed topic in a forum supergroup chat.

reopen_general_topic

Reopen a general forum topic.

unhide_general_topic

Unhide a general forum topic.

join_folder

Join a folder by its invite link.

leave_folder

Leave a folder by its invite link.

update_color

Update color.

update_folder

Create or update a user's folder.

get_forum_topic

Get one or more topic from a chat by using topic identifiers.

get_forum_topic_icon_stickers

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user.

hide_forum_topic

Use this method to hide a topic in a forum supergroup chat.

toggle_forum_topic_is_pinned

Changes the pinned state of a forum topic; requires can_manage_topics right in the supergroup.

unhide_forum_topic

Use this method to unhide a topic in a forum supergroup chat.

get_chat_audios

Get a user profile audios sequentially.

get_chat_audios_count

Get the total count of audios for a chat.

get_created_chats

Get a list of chats of the specified type of the current user account.

get_direct_messages_topics

Get one or more topic from a direct messages channel chat.

get_direct_messages_topics_by_id

Get one or more direct message topic from a chat by using topic identifiers.

get_nearby_chats

Returns a list of users and location-based supergroups nearby.

search_chats

Searches for the specified query in the title and username of already known chats via request to the server.

set_chat_direct_messages_group

Change direct messages group settings for a channel chat.

set_chat_message_auto_delete_time

Changes the message auto-delete or self-destruct (for secret chats) time in a chat.

transfer_chat_ownership

Changes the owner of a chat.

Stickers

add_sticker_to_set

Add a sticker to stickerset.

create_sticker_set

Create a new stickerset.

get_sticker_set

Get info about a stickerset.

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_photos_count

Get the total count of photos for a chat.

set_profile_photo

Set a new profile photo or video (H.264/MPEG-4 AVC video, max 5 seconds).

delete_profile_photos

Delete your own profile photos.

set_username

Changes the editable username of the current user.

set_birthdate

Changes the birthdate of the current user.

set_personal_chat

Changes the personal chat of the current user.

update_birthday

Update your birthday details.

update_personal_chat

Update your birthday details.

update_profile

Update your profile details such as first name, last name and bio.

update_status

Updates online user status.

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.

delete_account

Deletes the account of the current user, deleting all information associated with the user from the server.

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.

check_chat_folder_invite_link

Checks the validity of an invite link for a chat folder and returns information about the corresponding chat folder.

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_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.

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.

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.

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.

answer_pre_checkout_query

Once the user has confirmed their payment and shipping details, the API sends the final confirmation in the form of an PreCheckoutQueryHandler.

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.

refund_star_payment

Refunds a successful payment in Telegram Stars.

get_bot_info

Get the bot info in given language.

set_bot_info

Get the bot info in given language.

get_bot_info_description

Use this method to get the current / owned bot description for the given user language.

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_short_description

Use this method to get the current / owned bot short 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_name

Use this method to get the current / owned bot name for the given user language.

set_bot_name

Use this method to get the current / owned bot name for the given user language.

get_collectible_item_info

Returns information about a given collectible item that was purchased at https://fragment.com.

get_owned_bots

Returns the list of bots owned by the current user.

get_similar_bots

Returns a list of bots similar to the given bot.

send_message_draft

Sends a draft for a being generated text message.

send_web_app_custom_request

Sends a custom request from a Web App.

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_code

Send the confirmation code to the given phone number.

resend_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_in_qrcode

Authorize a user in Telegram with a QR code.

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.

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.

Account

add_profile_audio

Adds an audio file to the beginning of the profile audio files of the current user.

get_account_ttl

Get days to live of account.

get_global_privacy_settings

Get account global privacy settings.

get_privacy

Get account privacy rules.

remove_profile_audio

Removes an audio file from the profile audio files of the current user.

set_account_ttl

Set days to live of account.

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.

set_privacy

Set account privacy rules.

set_profile_audio_position

Changes position of an audio file in the profile audio files of the current user.

Payments

add_collection_gifts

Adds gifts to the beginning of a previously created collection.

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.

craft_gift

Crafts a new gift from other gifts that will be permanently lost.

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_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_chat_gifts_count

Get the total count of owned gifts of specified chat.

get_gift_auction_state

Returns auction state for a gift.

get_gift_collections

Returns collections of gifts owned by the given user or chat.

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.

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

Get information about upgraded gift.

get_upgraded_gift_value_info

Returns information about value of an upgraded gift by its name.

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.

process_gift_purchase_offer

Handles a pending gift purchase offer.

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.

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_gift_purchase_offer

Sends an offer to purchase an upgraded gift.

send_payment_form

Send a filled-out payment form / pay an invoice.

send_resold_gift

Send an upgraded gift that is available for resale to another user or channel chat.

set_gift_collection_name

Changes name of a gift collection.

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.

Premium

apply_boost

Apply boost.

get_boosts

Get your boosts list.

get_boosts_status

Get boosts status of channel.

Phone

create_video_chat

Creates a video chat (a group call bound to a chat).

discard_group_call

Terminate a group/channel call or livestream.

get_video_chat_rtmp_url

Returns RTMP URL for streaming to the chat; requires owner privileges.

invite_group_call_participants

Invites users to an active group call.

load_group_call_participants

Loads participants list in a group call of a chat.

Business

create_business_chat_link

Create a business chat link with a predefined message.

create_invoice_link

Use this method to create a link for an invoice.

delete_business_chat_link

Delete a business chat link by slug.

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

Returns the amount of Telegram Stars owned by a managed business account.

get_business_chat_links

Get all business chat links.

get_business_connection

Use this method to get information about the connection of the bot with a business account.

get_connected_bots

Get bots connected to your business account.

get_owned_star_count

Get the number of Telegram Stars count owned by the current account or the specified bot.

resolve_business_chat_link

Resolve a business chat link slug to its info.

transfer_business_account_stars

Transfers Telegram Stars from the business account balance to the bot’s balance.

update_business_away_message

Set an automatic away message when you are offline.

update_business_greeting_message

Set an automatic greeting message for new conversations.

update_business_intro

Update your business intro (title, description, sticker).

update_business_location

Update the business location shown on your business page.

update_business_work_hours

Update business work hours for your business account.

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.