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

Listeners

ask

Send a message and wait for the answer to it.

listen

Wait for the next update matching the given criteria.

register_next_step_handler

Run a callback once, on the next update matching the given criteria.

stop_listening

Stop the listeners covered by the given criteria.

wait_for_callback_query

Wait for the next callback query in a chat.

wait_for_message

Wait for the next message in a chat.

Utilities

add_handler

Register an update handler.

export_session_string

Export the current authorized session as a serialized string.

ping

Measure the round-trip network latency to the connected Telegram data center.

remove_handler

Remove a previously-registered update handler.

restart

Restart the Client.

run

Start the client, idle the main script and finally stop the client.

set_parse_mode

Set the parse mode to be used globally by the client.

start

Start the client.

stop

Stop the Client.

stop_transmission

Stop downloading or uploading a file.

Help

dismiss_suggestion

Dismiss a suggestion.

edit_user_info

Edit internal user info (for TSF members).

get_app_config

Get app-specific configuration.

get_app_update

Check for app updates.

get_cdn_config

Get CDN configuration.

get_countries_list

Get the list of supported countries.

get_deep_link_info

Get info about an unsupported deep link.

get_invite_text

Get the default invitation text for inviting new users to Telegram.

get_nearest_dc

Get the nearest data center based on client's IP.

get_passport_config

Get Telegram Passport configuration.

get_peer_colors

Get the set of name/message colors supported by the server.

get_peer_profile_colors

Get the set of profile colors supported by the server.

get_premium_promo

Get Telegram Premium promotion information.

get_promo_data

Get MTProxy/Public Service Announcement promotional information.

get_recent_me_urls

Get recent t.me URLs.

get_support

Get Telegram support user.

get_support_name

Get localized name of the Telegram support user.

get_terms_of_service_update

Check for updates of terms of service.

get_timezones_list

Get the list of supported timezones.

get_user_info

Get internal user info (can only be used by TSF members).

hide_promo_data

Hide MTProxy/Public Service Announcement information.

save_app_log

Saves logs of application on the server.

set_bot_updates_status

Informs the server about the number of pending bot updates if they haven't been processed for a long time (bots only).

Language Pack

get_difference

Get new strings in language pack.

get_lang_pack

Get localization pack strings.

get_language

Get information about a language in a localization pack.

get_languages

Get information about all languages in a localization pack.

get_strings

Get strings from a language pack.

idle

Block the main script execution until a signal is received.

compose

Run multiple clients at once.

Account

accept_authorization

Accept a Telegram Passport authorization request and send requested values.

add_profile_audio

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

cancel_password_email

Cancel the code that was sent to verify an email to use as 2FA recovery method.

change_authorization_settings

Change settings related to a session.

clear_recent_emoji_statuses

Clear list of recently used emoji statuses.

confirm_bot_connection

Confirm a bot connection.

confirm_password_email

Verify an email to use as 2FA recovery method.

confirm_phone

Confirm a phone number to cancel account deletion.

create_theme

Create a theme.

decline_password_reset

Abort a pending 2FA password reset.

delete_account

Delete the user's account from the telegram servers.

delete_auto_save_exceptions

Clear all peer-specific autosave settings.

delete_passkey

Delete a passkey associated to the current account.

delete_secure_value

Delete stored Telegram Passport documents.

delete_web_browser_settings_exceptions

Delete all web browser settings exceptions.

disable_peer_connected_bot

Permanently disconnect a specific chat from all business bots.

edit_business_chat_link

Edit a created business chat deep link.

get_account_ttl

Get days to live of account.

get_all_secure_values

Get all stored Telegram Passport documents.

get_authorization_form

Returns a Telegram Passport authorization form for sharing data with a service.

get_auto_download_settings

Get media autodownload settings.

get_auto_save_settings

Get autosave settings.

get_channel_default_emoji_statuses

Get a list of default suggested channel emoji statuses.

get_channel_restricted_status_emojis

Fetch the full list of custom emoji IDs that cannot be used in channel emoji statuses.

get_chat_themes

Get all available chat themes.

get_collectible_emoji_statuses

Obtain a list of emoji statuses for owned or hosted collectible gifts.

get_contact_sign_up_notification

Whether the user will receive notifications when contacts sign up.

get_content_settings

Get sensitive content settings.

get_default_background_emojis

Get suggested custom emoji stickers that can be used in an accent color pattern.

get_default_group_photo_emojis

Get suggested custom emoji stickers that can be used as group picture.

get_default_profile_photo_emojis

Get suggested custom emoji stickers that can be used as profile picture.

get_global_privacy_settings

Get account global privacy settings.

get_multi_wall_papers

Get info about multiple wallpapers.

get_notify_exceptions

Returns list of chats with non-default notification settings.

get_notify_settings

Gets current notification settings for a given user/group, or all users/all groups.

get_paid_messages_revenue

Get the number of stars received from the specified user via paid messages.

get_passkeys

List the passkeys associated to the current account that can be used to log in.

get_password_settings

Get private info associated to the password info (recovery email, telegram passport info, etc.).

get_privacy

Get account privacy rules.

get_reactions_notify_settings

Get the current reaction notification settings.

get_recent_emoji_statuses

Get recently used emoji statuses.

get_saved_music_ids

Fetch the full list of only the IDs of songs currently added to the profile.

get_saved_ringtones

Fetch saved notification sounds.

get_secure_value

Get saved Telegram Passport documents.

get_theme

Get theme information.

get_themes

Get installed themes.

get_tmp_password

Get temporary payment password.

get_unique_gift_chat_themes

Obtain all chat themes associated to owned or hosted collectible gifts.

get_wall_paper

Get info about a certain wallpaper.

get_wall_papers

Returns a list of available wallpapers.

get_web_authorizations

Get web login widget authorizations.

get_web_browser_settings

Get in-app web browser settings.

init_passkey_registration

Initialize passkey registration for the current account.

install_theme

Install a theme.

install_wall_paper

Install wallpaper.

invalidate_sign_in_codes

Invalidate the specified login codes.

register_device

Register device to receive PUSH notifications.

register_passkey

Complete passkey registration for the current account.

remove_profile_audio

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

reorder_usernames

Reorder usernames associated with the currently logged-in user.

resend_password_email

Resend the code to verify an email to use as 2FA recovery method.

reset_notify_settings

Resets all notification settings from users and groups.

reset_password

Initiate a 2FA password reset: can only be used if the user is already logged-in.

reset_wall_papers

Delete all installed wallpapers, reverting to the default wallpaper set.

reset_web_authorization

Log out an active web telegram login session.

reset_web_authorizations

Reset all active web telegram login sessions.

save_auto_download_settings

Change media autodownload settings.

save_auto_save_settings

Modify autosave settings.

save_ringtone

Save or remove a saved notification sound.

save_secure_value

Securely save a Telegram Passport document.

save_theme

Save or unsave a theme.

save_wall_paper

Install or uninstall wallpaper.

send_confirm_phone_code

Send confirmation code to cancel account deletion.

set_account_ttl

Set days to live of account.

set_contact_sign_up_notification

Toggle contact sign up notifications.

set_content_settings

Set sensitive content settings (for viewing or hiding NSFW content).

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.

set_reactions_notify_settings

Change the reaction notification settings.

toggle_connected_bot_paused

Pause or unpause a specific chat, temporarily disconnecting it from all business bots.

toggle_no_paid_messages_exception

Allow a user to send messages without paying if paid messages are enabled.

toggle_sponsored_messages

Disable or re-enable Telegram ads for the current Premium account.

toggle_username

Activate or deactivate a collectible username associated to the currently logged-in user.

toggle_web_browser_settings_exception

Toggle web browser settings exception for a specific URL.

unregister_device

Deletes a device by its token, stops sending PUSH notifications to it.

update_connected_bot

Connect a business bot to the current account, or change connection settings.

update_device_locked

When passcode lock is enabled, hides message texts in incoming PUSH notifications after inactivity period.

update_theme

Update a theme.

update_web_browser_settings

Update in-app web browser settings.

upload_ringtone

Upload a notification sound.

upload_theme

Upload a theme file with platform-specific colors.

upload_wall_paper

Create and upload a new wallpaper.

verify_phone

Verify a phone number for Telegram Passport.

Messages

add_checklist_tasks

Add tasks to a checklist in a message.

add_poll_option

Adds an option to a poll.

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.

check_quick_reply_shortcut

Check whether a quick reply shortcut name is valid and available.

check_search_posts_flood

Check the current flood status and quota for searching public channel posts.

clear_all_drafts

Clear all message drafts.

clear_recent_reactions

Clear recently used reactions.

click_sponsored_message

Report a sponsored message as clicked.

compose_text_with_ai

Changes text using an AI model.

copy_media_group

Copy a media group by providing one of the message ids.

copy_message

Copy messages of any kind.

copy_messages

Copy messages of any kind in bulk without a forward link.

decline_suggested_post

Use this method to decline a suggested post in a direct messages chat.

delete_chat_history

Delete the history of a chat.

delete_direct_messages_chat_topic_history

Delete messages in the topic in a channel direct messages chat administered by the current user.

delete_fact_check

Delete the fact-check on a message (channel admins only).

delete_messages

Delete messages, including service messages.

delete_participant_reaction

Remove all reactions of a specific participant from a single message.

delete_participant_reactions

Remove all reactions of a specific participant from every message in a group or channel.

delete_poll_option

Deletes an option from a poll.

delete_quick_reply_messages

Delete specific messages from a quick reply shortcut.

delete_quick_reply_shortcut

Delete an entire quick reply shortcut.

delete_scheduled_messages

Delete scheduled messages.

download_media

Download the media from a message.

edit_fact_check

Edit the fact-check on a message (channel admins only).

edit_inline_caption

Edit the caption of inline media messages.

edit_inline_media

Edit inline animation, audio, document, photo or video messages.

edit_inline_reply_markup

Edit only the reply markup of inline messages sent via the bot (for inline bots).

edit_inline_text

Edit the text of inline messages.

edit_message_caption

Edit the caption of media messages.

edit_message_checklist

Use this method to edit a checklist.

edit_message_live_location

Edit a live location message.

edit_message_media

Edit animation, audio, document, photo or video messages.

edit_message_reply_markup

Edit only the reply markup of messages sent by the bot.

edit_message_text

Edit the text of a message.

edit_quick_reply_shortcut

Edit the name of a quick reply shortcut.

emojify_text_with_ai

Adds emojis to text using an AI model.

export_message_link

Export an HTTP link to a message in a channel or supergroup.

fix_text_with_ai

Fixes text using an AI model.

forward_media_group

Forward a media group by providing one of the message ids.

forward_messages

Forward messages of any kind.

get_all_drafts

Get all saved message drafts.

get_all_stickers

Get all installed sticker sets.

get_archived_stickers

Get archived sticker sets.

get_available_effects

Get all available effects.

get_available_reactions

Get the reactions available on Telegram.

get_chat_history

Get messages from a chat history.

get_chat_history_count

Get the total count of messages in a chat.

get_default_history_ttl

Get the default Time-To-Live for messages.

get_default_tag_reactions

Get default reaction tags for saved messages.

get_direct_messages_chat_topic_history

Return messages in the topic in a channel direct messages chat administered by the current user.

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_emoji_stickers

Get custom emoji sticker sets.

get_custom_emoji_stickers

Get information about custom emoji stickers by their identifiers.

get_featured_emoji_stickers

Get featured/trending custom emoji sticker sets.

get_featured_stickers

Get featured/trending sticker sets.

get_stickers

Get sticker set by short name.

get_main_web_app

Returns information needed to open the main Web App of a bot.

get_mask_stickers

Get all installed mask sticker sets.

get_media_group

Get the media group a message belongs to.

get_message_author

Get the author of a message in a channel or supergroup.

get_message_reactions

Get reactions added to a specific message.

get_message_read_participants

Get the list of participants who read a specific message in a chat.

get_messages

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

get_messages_reactions

Get detailed reactions for a list of messages.

get_paid_reaction_privacy

Get default privacy setting for paid reactions (anonymous vs public).

get_poll_results

Get the current results of a poll.

get_poll_stats

Get statistics for a poll sent in a message.

get_prepared_inline_message

Get a prepared inline message by ID.

get_quick_replies

Get all quick reply shortcuts created by the user.

get_quick_reply_messages

Get messages contained in a quick reply shortcut.

get_recent_reactions

Get recently used message reactions.

get_rich_message

Get the full rich message of a message that arrived truncated.

get_saved_gifs

Get saved GIFs.

get_saved_history

Get saved messages history for a specific peer.

get_saved_reaction_tags

Get reaction tags assigned to saved messages.

get_scheduled_messages

Get one or more scheduled messages from a chat.

get_search_results_calendar

Get a calendar view of search results.

get_search_results_positions

Get positions of search results within a chat history.

get_sponsored_messages

Get sponsored messages for a channel.

get_top_reactions

Get top reactions used on Telegram.

get_unread_reactions

Get messages with unread reactions in a chat.

get_user_gifts

Get the gifts owned by a user.

get_user_personal_chat_messages

Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user.

get_user_profile_audios

Get the list of profile audios (voice/audio messages) for a user.

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.

get_web_page

Get information about a web page via URL.

get_web_page_preview

Get a web page preview from a message containing a URL.

gift_premium_subscription

Gift a Telegram Premium subscription to a user.

hide_peer_settings_bar

Hide the peer settings bar (the "Add to contacts" / "Block" bar) for a user.

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.

read_chat_history

Mark a chat's message history as read.

read_chat_message_contents

Mark audio/video message contents as listened or watched in a channel or supergroup.

read_featured_stickers

Mark featured sticker sets as read.

read_mentions

Mark a mention in the chat as read.

read_reactions

Mark a reaction in the chat as read.

read_saved_history

Mark saved messages history as read up to a given message ID.

reorder_pinned_dialogs

Reorder pinned dialogs.

reorder_quick_replies

Reorder quick reply shortcuts.

reorder_sticker_sets

Reorder installed sticker sets.

rephrase_text_with_ai

Rephrases text using an AI model tone.

report_messages

Report specific messages in a chat for rule violations.

report_reaction

Report an abusive or inappropriate reaction on a message.

report_sponsored_message

Report a sponsored message.

retract_vote

Retract your vote in a poll.

save_draft

Save a message draft.

save_prepared_inline_message

Store a message that can be sent by a user of a Mini App.

save_prepared_keyboard_button

Store a keyboard button that can be used by a user within a Mini App.

save_recent_sticker

Save or remove a sticker from recently used stickers.

search_global

Search messages globally from all of your chats.

search_global_count

Get the count of messages resulting from a global search.

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 public posts by hashtag or by text.

search_posts_count

Get the number of public posts matching a hashtag or a text search.

send_animation

Send animation files (animation or H.264/MPEG-4 AVC video without sound).

send_audio

Send audio files.

send_cached_media

Send any media stored on the Telegram servers using a file_id.

send_chat_action

Tell the other party that something is happening on your side.

send_checklist

Send a checklist (todo list).

send_contact

Send phone contacts.

send_dice

Send a dice with a random value from 1 to 6.

send_document

Send generic files.

send_live_photo

Send a live photo, a still image paired with the short video it was taken with.

send_location

Send points on the map.

send_media_group

Send a group of photos or videos as an album.

send_message

Send text messages.

send_message_draft

Send a text draft action, allowing bots to stream a partial message.

send_paid_media

Send a group or one paid photo/video.

send_paid_reaction

Send a paid reaction to a message, spending Telegram Stars.

send_photo

Send photos.

send_poll

Send a new poll.

send_quick_reply_messages

Send messages from a quick reply shortcut into a target chat.

send_reaction

Send a reaction to a message.

send_rich_message

Send a rich formatted message.

send_rich_message_draft

Send a rich message draft action, allowing bots to stream partial rich messages.

send_scheduled_messages

Send scheduled messages immediately.

send_screenshot_notification

Notify the other user that you took a screenshot.

send_sticker

Send static .webp or animated .tgs stickers.

send_venue

Send information about a venue.

send_video

Send video files.

send_video_note

Send video note files.

send_voice

Send audio files.

set_chat_available_reactions

Set allowed reactions in a chat or channel.

set_chat_theme

Set a theme for a chat.

set_chat_wallpaper

Set a wallpaper for a chat.

set_default_history_ttl

Set the default Time-To-Live for messages.

set_default_reaction

Set default quick reaction (e.g. for double-tap).

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.

set_passport_data_errors

Inform a user that some Telegram Passport elements they provided contain errors.

start_bot

Start a bot, optionally passing a deep linking parameter.

stop_message_live_location

Stop updating a live location message before its live_period expires.

stop_poll

Stop a poll which was sent by you.

stream_media

Stream the media from a message chunk by chunk.

summarize_text

Summarize text content using AI.

toggle_dialog_pin

Pin or unpin a dialog.

toggle_paid_reaction_privacy

Toggle whether your paid reaction on a specific message is anonymous.

toggle_peer_translations

Toggle the translation bar for a peer.

toggle_saved_dialog_pin

Pin or unpin a dialog in Saved Messages.

transcribe_audio

Transcribe speech in a voice message or video note into text.

translate_text

Translate text or a message to another language.

update_saved_reaction_tag

Update or rename the tag associated with a saved reaction.

view_messages

Increment the view counter of one or more messages.

view_sponsored_message

Mark a sponsored message as viewed.

vote_poll

Vote a poll.

get_attached_stickers

Get sticker sets attached to a photo or video.

get_dialog_unread_marks

Get dialogs marked as unread.

get_document_by_hash

Get a document by its SHA256 hash.

get_emoji_groups

Get emoji groups (categories) for the emoji panel.

get_emoji_keywords

Get emoji keywords for a given language.

get_emoji_keywords_difference

Get emoji keywords difference (updates) for a given language.

get_emoji_keywords_languages

Get emoji keyword language codes that need to be fetched.

get_emoji_profile_photo_groups

Get emoji groups for the profile photo emoji panel.

get_emoji_sticker_groups

Get emoji groups for the custom emoji sticker panel.

get_emoji_status_groups

Get emoji groups for the emoji status panel.

get_emoji_url

Get a CDN URL for downloading emoji keywords for a language.

get_extended_media

Request extended media for paid media messages.

get_fact_check

Get fact-check information for one or more messages.

get_message_edit_data

Check if a message can be edited and get the current edit data.

get_outbox_read_date

Get the date when the recipient read an outgoing message.

get_pinned_saved_dialogs

Get pinned saved dialogs (pinned chats in Saved Messages).

get_poll_votes

Get votes in a poll.

get_recent_locations

Get recently shared live locations in a chat.

get_stickers_by_emoticon

Get stickers associated with an emoticon.

get_unread_mentions

Get messages with unread mentions in a chat.

get_unread_poll_votes

Get unread poll votes in a chat.

rate_transcribed_audio

Rate the quality of a transcribed audio message.

read_discussion

Mark a discussion (comment thread) as read.

read_poll_votes

Mark the results of a poll as read.

reorder_pinned_saved_dialogs

Reorder pinned dialogs in Saved Messages.

report_messages_delivery

Report successful delivery of messages (for analytics).

search_custom_emoji

Search for custom emoji by emoticon text.

search_emoji_sticker_sets

Search for custom emoji sticker sets.

search_sent_media

Search for media sent by the current user.

accept_url_auth

Accept URL authorization (login via Telegram for a website).

check_url_auth_match_code

Check a URL auth match code.

decline_url_auth

Decline URL authorization for a login button.

delete_chat

Delete a basic group (legacy group chat).

delete_phone_call_history

Delete the phone call history.

edit_chat_admin

Make or revoke admin status in a basic group.

get_attach_menu_bot

Get information about a bot that can be used in the attach menu.

get_attach_menu_bots

Get the list of bots available in the attach menu.

get_bot_app

Get information about a bot web app.

get_dh_config

Get Diffie-Hellman configuration for end-to-end encryption.

get_emoji_game_info

Get information about the emoji game.

get_future_chat_creator_after_leave

Get the user who will become the creator of a chat after the current creator leaves.

get_old_featured_stickers

Get old featured/trending sticker sets (pagination).

get_split_ranges

Get the ranges of locally stored messages that need to be fetched from the server.

get_suggested_dialog_filters

Get suggested chat folder (dialog filter) configurations.

migrate_chat

Upgrade a basic group to a supergroup.

prolong_web_view

Prolong an open web app session to prevent it from expiring.

read_message_contents

Mark the content of messages as read (e.g., mark voice notes as listened).

received_messages

Confirm received messages up to a given max ID.

received_queue

Acknowledge received secret chat messages up to a given QTS.

report_music_listen

Report that the user listened to a music message (for analytics).

report_read_metrics

Report read metrics for messages in a chat.

request_chat_join_web_view

Request joining a chat via a web view.

request_url_auth

Request URL authorization for a login button or link preview.

send_bot_requested_peer

Send a peer chosen by the user via a KeyboardButtonRequestPeer button.

send_web_view_data

Send data from a web app button to a bot.

toggle_bot_in_attach_menu

Enable or disable a bot in the attach menu.

toggle_sticker_sets

Install, uninstall, archive or unarchive multiple sticker sets at once.

translate_rich_message

Translate a rich message (with formatting) to another language.

accept_encryption

Accept an incoming end-to-end encrypted chat request.

check_history_import

Check if a chat history export file can be imported.

check_history_import_peer

Check if a chat history can be imported into a specific chat.

discard_encryption

Discard/close a secret (end-to-end encrypted) chat.

init_history_import

Initialize a chat history import.

read_encrypted_history

Mark the history of a secret chat as read up to a given date.

report_encrypted_spam

Report a secret chat for spam.

request_encryption

Request an end-to-end encrypted chat (secret chat) with a user.

send_encrypted

Send an encrypted message to a secret chat.

send_encrypted_file

Send an encrypted file to a secret chat.

send_encrypted_service

Send a service message to a secret chat.

set_encrypted_typing

Send a typing action to a secret chat.

start_history_import

Start a previously initialized history import.

upload_encrypted_file

Upload an encrypted file to a secret chat.

upload_imported_media

Upload a media file for a history import session.

compose_rich_message_with_ai

Use AI to compose, proofread, translate or emojify a rich text message.

Ephemeral

delete_all_welcome_messages

Delete every welcome message a bot has stored for a chat.

delete_ephemeral_message

Delete an ephemeral message.

delete_welcome_message

Delete one of the welcome messages a bot has stored for a chat.

edit_ephemeral_message_caption

Edit the caption of an ephemeral media message.

edit_ephemeral_message_media

Edit the media of an ephemeral message.

edit_ephemeral_message_reply_markup

Edit only the inline keyboard of an ephemeral message.

edit_ephemeral_message_text

Edit the text of an ephemeral message.

get_ephemeral_callback_answer

Get callback answer from an ephemeral message inline button.

get_welcome_messages

Get the welcome messages a bot has stored for a chat.

report_ephemeral_message

Report an ephemeral message.

send_ephemeral_message

Send an ephemeral message visible only to a specific user and the bot in a group.

AI Compose

create_ai_tone

Create a custom AI writing tone.

delete_ai_tone

Permanently delete a custom AI composer tone created by the current user.

get_ai_tone

Get details about a specific AI writing tone.

get_ai_tone_example

Get an example generated text for a specific AI writing tone.

get_ai_tones

Get the list of available AI writing tones.

save_ai_tone

Install or uninstall an AI composer tone, adding it to or removing it from the list of saved tones.

update_ai_tone

Update an existing custom AI writing tone.

Chats

add_chat_members

Add new chat members to a group, supergroup or channel

archive_chats

Archive one or more chats.

ban_chat_member

Ban a user from a group, a supergroup or a channel.

ban_chat_sender_chat

Ban a channel chat from sending messages in a supergroup or channel.

close_forum_topic

Close a forum topic.

close_general_forum_topic

Close a 'General' topic in a forum supergroup chat.

convert_to_gigagroup

Convert a supergroup to a gigagroup (broadcast group).

create_channel

Create a new broadcast channel.

create_forum_topic

Create a new forum topic.

create_group

Create a new basic group.

create_supergroup

Create a new supergroup.

deactivate_chat_usernames

Deactivate all secondary collectible usernames of a channel or supergroup.

delete_all_message_reactions

Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat.

delete_channel

Delete a channel.

delete_chat_photo

Delete a chat photo.

delete_chat_sticker_set

Delete a group sticker set from a supergroup.

delete_forum_topic

Delete a forum topic.

delete_message_reaction

Use this method to remove a reaction from a message in a group or a supergroup chat.

delete_supergroup

Delete a supergroup.

delete_user_history

Delete all messages sent by a certain user in a supergroup.

edit_chat_location

Edit the location of a geogroup.

edit_forum_topic

Edit a forum topic.

edit_general_forum_topic

Edit the name of the 'General' topic in a forum supergroup chat.

get_chat

Get up to date information about a chat.

get_chat_event_log

Get the actions taken by chat members and administrators in the last 48h.

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_chat_online_count

Get the number of members that are currently online in a chat.

get_chat_settings

Get information about a chat settings.

get_dialogs

Get a user's dialogs sequentially.

get_dialogs_count

Get the total count of your dialogs.

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_forum_topic_icon_stickers

Get custom emoji stickers, which can be used as a forum topic icon by any user.

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_inactive_channels

Get the list of inactive channels and supergroups.

get_left_channels

Get a list of channels that the current user has left.

get_nearby_chats

Get nearby chats.

get_personal_channels

Get all your public channels.

get_send_as_chats

Get the list of "send_as" chats available.

get_similar_channels

Get similar channels.

get_suitable_discussion_chats

Return a list of basic group and supergroup chats, which can be used as a discussion group for a channel.

get_top_chats

Returns a list of frequently used chats.

hide_general_forum_topic

Hide the 'General' topic in a forum supergroup chat.

join_chat

Join a group chat or channel.

leave_chat

Leave a group chat or channel.

mark_chat_unread

Mark a chat as unread.

pin_chat_message

Pin a message in a group, channel or your own chat.

pin_forum_topic

Pin a forum topic to the top of the topic list.

promote_chat_member

Promote or demote a user in a supergroup or a channel.

remove_chat_verification

Remove verification from a chat currently verified on behalf of the organization.

remove_user_verification

Remove verification from a user currently verified on behalf of the organization.

reopen_forum_topic

Reopen a closed forum topic.

reopen_general_forum_topic

Reopen a closed 'General' topic in a forum supergroup chat.

reorder_chat_usernames

Reorder active collectible usernames of a channel or supergroup.

reorder_pinned_forum_topics

Reorder pinned forum topics in a forum supergroup.

report_anti_spam_false_positive

Report a false positive action by Telegram's native automated anti-spam system in a supergroup.

report_chat

Report a chat (channel, supergroup, group, or user) for rule violations.

report_spam

Report a peer as spam and dismiss dialog.

restrict_chat_member

Restrict a user in a supergroup.

restrict_sponsored_messages

Restrict sponsored messages in a channel.

set_administrator_title

Set a custom title (rank) to an administrator of a supergroup.

set_boosts_to_unblock_restrictions

Set the required boost level to unblock chat restrictions or slowmode.

set_chat_accent_color

Change the accent color of your account or of a channel.

set_chat_custom_emoji_sticker_set

Set or remove the custom emoji sticker set for a supergroup.

set_chat_description

Change the description of a supergroup or a channel.

set_chat_direct_messages_group

Change the direct messages group settings of a channel.

set_chat_discussion_group

Link or unlink a discussion group to a channel.

set_chat_member_tag

Set a custom tag for a member of a group or a supergroup.

set_chat_permissions

Set default chat permissions for all members.

set_chat_photo

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

set_chat_protected_content

Set the chat protected content setting.

set_chat_sticker_set

Set a new group sticker set for a supergroup.

set_chat_title

Change the title of a chat.

set_chat_ttl

Set the auto-delete timer of a chat.

set_chat_username

Set a channel or a supergroup username.

set_main_profile_tab

Change the main profile tab of your account or of a channel.

set_send_as_chat

Set the default "send_as" chat for a chat.

set_slow_mode

Set the slow mode interval for a chat.

set_upgraded_gift_colors

Take the colors of an upgraded gift you own as your account colors.

toggle_anti_spam

Toggle the anti-spam filter in a supergroup.

toggle_auto_translation

Toggle automatic message translation for a channel.

toggle_chat_username

Activate or deactivate a collectible username on a channel or supergroup.

toggle_forum

Toggle forum mode in a supergroup.

toggle_join_request

Toggle join requests (admin approval to join) on a channel or supergroup.

toggle_join_to_send

Toggle whether users must join before sending messages.

toggle_participants_hidden

Toggle whether participant list is hidden.

toggle_pre_history_hidden

Toggle pre-history visibility for new members.

toggle_signatures

Toggle channel signatures.

toggle_slow_mode

Toggle slow mode in a supergroup.

toggle_view_forum_as_messages

Toggle whether forum topics are displayed as messages.

transfer_chat_ownership

Transfer the ownership of a supergroup or a channel to another user.

unarchive_chats

Unarchive one or more chats.

unban_chat_member

Unban a previously banned user in a supergroup or channel.

unban_chat_sender_chat

Unban a previously banned channel chat in a supergroup or channel.

unhide_general_forum_topic

Unhide the 'General' topic in a forum supergroup chat.

unpin_all_chat_messages

Use this method to clear the list of pinned messages in a chat.

unpin_all_forum_topic_messages

Clear the list of pinned messages in a forum topic.

unpin_all_general_forum_topic_messages

Clear the list of pinned messages in the General forum topic.

unpin_chat_message

Unpin a message in a group, channel or your own chat.

unpin_forum_topic

Unpin a forum topic.

update_channel_color

Update the accent color of a channel.

update_chat_notifications

Update the notification settings of a chat.

verify_chat

Verify a chat on behalf of the organization represented by the bot.

verify_user

Verify a user on behalf of the organization represented by the bot.

Communities

approve_community_link_request

Approve or reject a specific chat's request to link to a community.

ban_community_participant

Ban or unban a participant from an entire community.

collapse_community

Collapse or expand a community folder in the user's dialogs list.

create_community

Create a new Telegram Community around a channel or supergroup.

get_community_link_requests

Get pending chat link requests for a community.

get_joined_communities

Get the list of Telegram Communities that the current user has joined.

get_participant_joined_community_chats

Get the list of chats within a community that a specific participant has joined.

toggle_all_community_link_requests

Approve or reject all pending chat link requests for a community in bulk.

toggle_community_chat_link

Link, unlink, hide, or make visible a chat/channel in a community.

Users

block_user

Block a user.

check_username

Check if a username is available.

delete_profile_photos

Delete your own profile photos.

get_chat_audios

Get a user profile audios sequentially.

get_chat_audios_count

Get the total count of audios for a chat.

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.

get_common_chats

Get the common chats you have with a user.

get_default_emoji_statuses

Get the default emoji statuses.

get_me

Get your own user identity.

get_requirements_to_contact

Check whether we can write to the specified users.

get_saved_music_by_id

Check if the passed songs are still pinned to the user's profile, or refresh their file references.

get_users

Get information about a user.

report_profile_photo

Report a profile photo of a user or channel for rule violations.

report_user

Report a user for rule violations or abuse.

set_bot_profile_photo

Set or remove the profile photo or video of a bot you own.

set_emoji_status

Set the emoji status.

set_personal_channel

Set a personal channel in bio.

set_profile_photo

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

set_secure_value_errors

Notify the user that the sent passport data contains some errors.

set_username

Set your own username.

unblock_user

Unblock a user.

update_birthday

Update birthday in your profile.

update_profile

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

update_status

Update your profile status.

Contacts

accept_contact

Accept an incoming contact if the add contact action bar is active.

add_contact

Add an existing Telegram user as contact, even without a phone number.

block_from_replies

Stop getting notifications about discussion replies of a certain user in @replies.

delete_contacts

Delete contacts from your Telegram address book.

delete_contacts_by_phones

Delete contacts by phone number.

edit_close_friends

Edit the close friends list.

export_contact_token

Generate a temporary profile link token for the currently logged-in user.

get_birthdays

Get contacts' upcoming birthdays.

get_blocked_message_senders

Returns users and chats that were blocked by the current user.

get_contact_ids

Get the Telegram user IDs of all contacts.

get_contact_statuses

Obtain the online statuses of all contacts.

get_contacts

Get contacts from your Telegram address book.

get_contacts_count

Get the total count of contacts from your Telegram address book.

get_saved_contacts

Get list of saved phone contacts.

get_sponsored_peers

Obtain a list of sponsored peer search results for a given query.

import_contact_token

Obtain user info from a temporary profile link token.

import_contacts

Import contacts to your Telegram address book.

reset_saved_contacts

Remove all contacts without an associated Telegram account.

reset_top_peer_rating

Reset rating of a top peer in a given category.

resolve_phone

Resolve a phone number to get user info, if their privacy settings allow it.

search_contacts

Returns users or channels found by name substring and auxiliary data.

set_blocked

Replace the contents of an entire blocklist.

set_contact_note

Changes a note of a contact user.

toggle_top_peers

Enable or disable top peers rating.

upload_contact_profile_photo

Upload a custom profile picture for a contact, or suggest a new profile picture to a contact.

Folders

check_chat_folder_invite_link

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

create_folder

Create new chat folder.

create_folder_invite_link

Create a new invite link for a chat folder.

delete_folder

Delete a user's folder.

delete_folder_invite_link

Deletes an invite link for a chat folder.

edit_folder

Update chat folder.

edit_folder_invite_link

Edits an invite link for a chat folder.

get_chatlist_updates

Fetch new chats associated with an imported chat folder deep link.

get_chats_for_folder_invite_link

Returns chats from a chat folder, suitable for adding to a chat folder invite link.

get_folder_invite_links

Returns invite links created by the current user for a shareable chat folder.

get_folders

Return information about a chat folders.

get_leave_chatlist_suggestions

Return identifiers of pinned or always included chats suggested to be left when deleting a chat folder.

hide_chatlist_updates

Dismiss new pending peers recently added to a chat folder deep link.

join_chatlist_updates

Join channels and supergroups recently added to a chat folder deep link.

join_folder

Join a folder by its invite link.

leave_folder

Leave a folder by its invite link.

reorder_folders

Change the order of chat folders.

toggle_folder_tags

Enable or disable chat folder tags.

Password

change_cloud_password

Change your Two-Step Verification password (Cloud Password) with a new one.

enable_cloud_password

Enable the Two-Step Verification security feature (Cloud Password) on your account.

remove_cloud_password

Turn off the Two-Step Verification security feature (Cloud Password) on your account.

Bots

add_bot_preview_media

Add a Main Mini App preview for a bot.

add_bot_username

Add an additional username to a bot we own.

allow_bot_send_message

Allow a bot to send messages to the user.

answer_callback_query

Send answers to callback queries sent from inline keyboards.

answer_chat_join_request_query

Use this method to process a received chat join request query.

answer_guest_query

Use this method to reply to a received guest message.

answer_inline_query

Send answers to an inline query.

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.

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_webhook_json_query

Answer a custom webhook JSON query (for bots).

can_bot_send_message

Check if a bot can send messages to the user.

check_bot_username

Checks whether a username can be set for a new bot or as an additional username.

check_download_file_params

Check if a Mini App can request the download of a specific file.

create_bot

Creates a bot which will be managed by another bot.

create_invoice_link

Create invoice link.

delete_bot_commands

Delete the list of the bot's commands for the given scope and user language.

delete_bot_preview_media

Delete Main Mini App previews for a bot.

edit_bot_preview_media

Edit a Main Mini App preview for a bot.

edit_user_star_subscription

Cancels or re-enables Telegram Star subscription for a user.

get_admined_bots

Get a list of bots you administrate.

get_bot_commands

Get the current list of the bot's commands for the given scope and user language.

get_bot_default_privileges

Get the current default privileges of the bot.

get_bot_info

Get bot info (name, about, description).

get_bot_info_description

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

get_bot_info_short_description

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

get_bot_name

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

get_bot_preview_info

Fetch Main Mini App preview information for a bot.

get_bot_preview_medias

Fetch Main Mini App previews for a bot.

get_bot_recommendations

Obtain a list of similarly themed bots based on similarities in subscriber bases.

get_chat_menu_button

Get the current value of the bot's menu button in a private chat, or the default menu button.

get_game_high_scores

Get data for high score tables.

get_inline_bot_results

Get bot results via inline queries.

get_managed_bot_access_settings

Use this method to get the access settings of a managed bot.

get_managed_bot_token

Use this method to get the token of a managed bot.

get_owned_bots

Returns the list of bots owned by the current user.

get_popular_app_bots

Fetch popular Main Mini Apps used in global search.

get_requested_web_view_button

Fetch the peer request button a bot prepared for a Mini App.

invoke_web_view_custom_method

Send a custom request from a Mini Bot App.

refund_star_payment

Refunds a successful payment in Telegram Stars.

reorder_bot_preview_medias

Reorder Main Mini App previews for a bot.

reorder_bot_usernames

Reorder active usernames associated to a bot we own.

remove_bot_username

Remove an additional username from a bot we own.

replace_managed_bot_token

Use this method to revoke the current token of a managed bot and generate a new one.

request_callback_answer

Request a callback answer from bots.

request_web_view_button

Prepare a peer request button for a Mini App (for bots).

send_chat_join_request_web_app

Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome.

send_custom_request

Send a custom request (for bots).

send_game

Send a game.

send_inline_bot_result

Send an inline bot result.

send_invoice

Use this method to send invoices.

set_bot_commands

Set the list of the bot's commands.

set_bot_default_privileges

Change the default privileges requested by the bot when it's added as an administrator to groups or channels.

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.

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.

set_bot_name

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

set_chat_menu_button

Change the bot's menu button in a private chat, or the default menu button.

set_game_score

Set the score of the specified user in a game.

set_managed_bot_access_settings

Use this method to get the access settings of a managed bot.

toggle_bot_username

Activate or deactivate a purchased fragment.com username associated to a bot we own.

toggle_user_emoji_status_permission

Allow or prevent a bot from changing our emoji status.

update_star_ref_program

Create, edit or delete the affiliate program of a bot we own.

update_user_emoji_status

Change the emoji status of a user (for bots).

Business

create_business_chat_link

Create a business chat link with a predefined message.

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

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

read_business_message

Mark an incoming message as read on behalf of a managed business account.

remove_business_account_profile_photo

Remove the current profile photo of a managed business account.

resolve_business_chat_link

Resolve a business chat link slug to its info.

set_business_account_bio

Change the bio of a managed business account.

set_business_account_gift_settings

Change the privacy settings for incoming gifts of a managed business account.

set_business_account_name

Change the first and last name of a managed business account.

set_business_account_profile_photo

Change the profile photo of a managed business account.

set_business_account_username

Change the username of a managed business account.

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.

Payments

add_collection_gifts

Adds gifts to the beginning of a previously created collection.

apply_gift_code

Apply a gift code.

assign_app_store_transaction

Assign and verify an Apple App Store receipt to a payment purpose.

assign_play_market_transaction

Assign and verify a Google Play Store receipt to a payment purpose.

buy_gift_upgrade

Pays for upgrade of a regular gift that is owned by another user or channel chat.

can_purchase_store

Check if an in-app store purchase can be made for the given purpose.

check_can_send_gift

Check if a limited Star Gift can still be sent or is sold out.

check_gift_code

Get information about a gift code.

clear_saved_info

Clear saved payment credentials and/or shipping information.

connect_star_ref_bot

Connect a Star affiliate referral bot to a channel.

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.

create_onramp_session

Initiate a purchase session with an onramp provider.

delete_gift_collection

Deletes a gift collection.

drop_gift_original_details

Drops original details for an upgraded gift.

edit_connected_star_ref_bot

Edit or revoke a connected Star affiliate referral link.

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_bank_card_data

Get bank card BIN details and issuer information.

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_connected_star_ref_bot

Get details about a specific connected Star affiliate bot.

get_connected_star_ref_bots

Get the list of connected Star affiliate referral bots for a channel.

get_currency_rates

Get the current currency exchange rates.

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_giveaway_info

Get status and winners information of a Telegram Giveaway.

get_onramp_availability

Check availability and supported payment methods for an onramp provider.

get_onramp_base_currencies

Get the supported base fiat currencies for an onramp provider.

get_onramp_limits

Get transaction limits for an onramp provider and currency pair.

get_onramp_providers

Fetch available crypto onramp providers.

get_onramp_quote

Request a price quote for purchasing cryptocurrency via an onramp provider.

get_payment_form

Get an invoice payment form.

get_payment_receipt

Get payment receipt for a successful payment message.

get_premium_gift_code_options

Get Telegram Premium gift code options and pricing.

get_received_gifts

Get all gifts owned by specified chat.

get_received_gifts_count

Get the total count of owned gifts of specified chat.

get_saved_info

Get saved payment credentials and shipping information.

get_saved_star_gift

Get one or more saved star gifts by their input identifiers.

get_star_gift_active_auctions

Get the list of currently active Star Gift auctions.

get_star_gift_auction_acquired_gifts

Get the list of gifts acquired in a specific Star Gift auction.

get_star_gift_withdrawal_url

Get the blockchain/Fragment withdrawal URL to transfer an upgraded Star Gift.

get_stars_balance

Get the current Telegram Stars balance of the current account.

get_stars_gift_options

Get available Telegram Stars gift packages for a user.

get_stars_giveaway_options

Get options and pricing for launching a Telegram Stars giveaway.

get_stars_revenue_ads_account_url

Get the URL of the Telegram Ads account for stars revenue.

get_stars_revenue_stats

Get Telegram Stars revenue statistics and monetization status for a channel or bot.

get_stars_revenue_withdrawal_url

Get the Fragment withdrawal URL for Telegram Stars revenue.

get_stars_subscriptions

Get Telegram Stars subscriptions of a user or channel.

get_stars_topup_options

Get Telegram Stars top-up purchasing packages and pricing options.

get_stars_transactions

Get the Telegram Stars transaction history for an account, bot, or channel.

get_stars_transactions_by_id

Get Telegram Stars transactions by their identifiers.

get_suggested_star_ref_bots

Get suggested Star affiliate referral bots for a channel.

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.

launch_prepaid_giveaway

Launch a previously prepaid giveaway in a channel.

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

toggle_chat_star_gift_notifications

Toggle notifications for incoming star gifts in a channel or chat.

transfer_gift

Transfers an owned unique gift to another user.

upgrade_gift

Upgrade a given regular gift to a unique gift.

validate_requested_info

Validate requested order and shipping information before payment.

Stories

can_post_stories

Check whether we can post stories as the specified chat.

copy_story

Copy story.

copy_story_album

Copy all stories from a story album (highlight) to another chat and create a new album.

create_story_album

Create a new story album (highlight).

delete_stories

Delete posted stories.

delete_story_album

Delete a story album (highlight).

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

Generate a story deep link for a specific story.

forward_story

Forward story.

get_all_read_peer_stories

Fetch all read peer stories state.

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_stories

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

get_chats_to_send_stories

Get a list of chats and channels where the current user can post stories.

get_peer_max_story_ids

Get the maximum read story identifier for one or more peers.

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_views

Obtain view summary counts and reaction stats for multiple stories.

get_story_album_stories

Get all stories in a story album (highlight).

get_story_albums

Get all story albums (highlights) from a chat or channel.

get_story_reactions_list

Obtain the list of reactions sent to a specific story.

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.

pin_chat_stories

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

reorder_story_albums

Reorder story albums (highlights).

report_story

Report stories of a user or channel for rule violations.

repost_story

Repost a story on behalf of a user or business account.

search_stories

Search public stories by hashtag, location area, or chat.

send_story

Post new story.

send_story_reaction

React to a story.

show_chat_stories

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

start_live_story

Start a live stream broadcast in a story.

toggle_all_stories_hidden

Globally hide or unhide all stories from the top of the chat list.

toggle_stories_pinned_to_top

Pin stories to the top of the pinned stories list.

unpin_chat_stories

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

update_story_album

Update a story album (highlight).

view_stories

Increment story views.

Stickers

add_favorite_sticker

Add a sticker to the list of favorite stickers.

add_recent_sticker

Add a sticker to the list of recently used stickers.

add_sticker_to_set

Add a new sticker to a sticker set.

change_sticker_set

Install, uninstall, archive or unarchive a sticker set.

check_sticker_set_short_name

Check whether a short name can be used to create a sticker set.

clear_recent_stickers

Clear the list of recently used stickers.

create_new_sticker_set

Create a new sticker set.

delete_sticker_from_set

Delete a sticker from a sticker set.

delete_sticker_set

Delete a sticker set.

get_favorite_stickers

Get the list of favorite stickers.

get_owned_sticker_sets

Get the sticker sets owned by the current user.

get_recent_stickers

Get the list of recently used stickers.

get_sticker_set

Get a sticker set by its name.

get_suggested_sticker_set_name

Get a suggested name for a new sticker set with a given title.

remove_favorite_sticker

Remove a sticker from the list of favorite stickers.

remove_recent_sticker

Remove a sticker from the list of recently used stickers.

reorder_installed_sticker_sets

Change the order of installed sticker sets.

replace_sticker_in_set

Replace an existing sticker in a sticker set with a new one.

search_sticker_sets

Search for sticker sets by looking for the query in their title and name.

search_stickers

Search for stickers from public sticker sets that match any of the given emoji.

set_custom_emoji_sticker_set_thumbnail

Set the thumbnail of a custom emoji sticker set.

set_sticker_emoji_list

Change the list of emoji assigned to a regular or custom emoji sticker.

set_sticker_keywords

Change the search keywords assigned to a regular or custom emoji sticker.

set_sticker_mask_position

Change the mask position of a mask sticker.

set_sticker_position_in_set

Move a sticker in a sticker set to a specific position.

set_sticker_set_thumbnail

Set the thumbnail of a regular or mask sticker set.

set_sticker_set_title

Set the title of a sticker set.

upload_sticker_file

Upload a file with a sticker for later use in create_new_sticker_set(), add_sticker_to_set() and replace_sticker_in_set().

SMS Jobs

finish_sms_job

Finish an SMS job (official clients only).

get_sms_job

Get info about an SMS job (official clients only).

get_sms_jobs_status

Get SMS jobs status (official clients only).

is_eligible_to_join_sms_jobs

Check if we can process SMS jobs (official clients only).

join_sms_jobs

Enable SMS jobs (official clients only).

leave_sms_jobs

Disable SMS jobs (official clients only).

update_sms_jobs_settings

Update SMS job settings (official clients only).

Phone

accept_call

Accept an incoming 1-on-1 private phone call.

change_call_volume

Change the stream volume in a voice chat.

check_group_call

Check which audio/video source IDs the server still recognizes in a group call.

confirm_call

Confirm Diffie-Hellman encryption parameters for a 1-on-1 private call.

create_conference_call

Create and optionally join a new end-to-end encrypted conference call.

decline_conference_call_invite

Decline an invitation to join a conference call.

delete_conference_call_participants

Remove or kick participants from an end-to-end encrypted conference call.

delete_group_call_messages

Delete messages sent in a group call or live stream chat.

delete_group_call_participant_messages

Delete all messages from a specific participant in a group call or live stream chat.

decline_call

Decline, reject, or hang up a 1-on-1 private phone call.

edit_group_call_participant

Edit participant properties in a group voice chat (mute, volume, video, hand raise).

edit_group_call_settings

Edit settings for an active group voice chat (join muted, chat messages, stars).

edit_group_call_title

Edit the title of an active or scheduled group voice chat.

end_group_call

End and terminate an active group voice chat or live stream for all members.

export_group_call_invite

Export an invite link for an active group voice chat or live stream.

get_call_config

Get phone call VoIP configuration (STUN/TURN server endpoints).

get_call_members

Get the members list of a chat call.

get_group_call

Get details about an active group voice chat or live stream.

get_group_call_chain_blocks

Get chain blocks for an end-to-end encrypted conference call.

get_group_call_join_as

Get the list of peers (user profile or channels) that can be used to join a voice chat.

get_group_call_settings

Get current settings of an active group voice chat or live stream.

get_group_call_stars

Get Telegram Stars revenue / statistics for an active voice chat.

get_group_call_stream_channels

Get available audio/video stream channels in an RTMP livestream or group call.

get_group_call_stream_rtmp_url

Get RTMP streaming URL and Stream Key for broadcasting to a chat (e.g. via OBS).

invite_conference_call_participant

Invite a user to an end-to-end encrypted conference call.

invite_to_group_call

Invite one or more users to an active group voice chat.

join_group_call

Join a group call / voice chat via MTProto signaling.

join_group_call_presentation

Start screen sharing / presentation in an active group call.

leave_group_call

Leave an active group voice chat or video stream without ending the call for others.

leave_group_call_presentation

Stop screen sharing / presentation in an active group call.

pause_stream

Pause the current media stream in a voice chat.

play_audio

Stream an audio file, remote live URL, or Telegram media directly into group voice chat.

play_video

Stream a video file, remote stream, or Telegram media directly into group voice chat.

received_call

Notify the server that the user received an incoming phone call and is currently busy.

request_call

Start a 1-on-1 private phone call.

resume_stream

Resume a paused media stream in a voice chat.

save_call_debug

Send phone call debug statistics to Telegram servers.

save_call_log

Upload VoIP phone call log file.

save_default_group_call_join_as

Save default peer identity (personal profile or channel) to join voice chats in a chat.

save_default_send_as

Save the default peer identity displayed as author of live story comments/reactions.

send_conference_call_broadcast

Broadcast state updates to all participants in an end-to-end encrypted conference call.

send_group_call_encrypted_message

Send an end-to-end encrypted message in a conference call.

send_group_call_message

Send a live chat text message during an active group voice chat or live stream.

send_signaling_data

Send VoIP signaling data (e.g. ICE candidates) for an ongoing phone call.

set_call_rating

Send quality rating and feedback for a finished phone call.

start_group_call

Start or schedule a group voice chat or live stream in a chat.

start_group_call_record

Start server-side recording of an active group voice chat or live stream.

start_scheduled_group_call

Start a previously scheduled group voice chat immediately.

stop_group_call_record

Stop server-side recording of an active group voice chat or live stream.

subscribe_to_group_call

Subscribe to notifications when a scheduled voice chat starts.

unsubscribe_from_group_call

Unsubscribe from notifications when a scheduled voice chat starts.

Stats

get_broadcast_stats

Get channel statistics.

get_megagroup_stats

Get supergroup statistics.

get_message_public_forwards

Obtain a list of public channel forwards for a message.

get_message_stats

Get message statistics.

get_story_public_forwards

Obtain forwards of a story as a message to public chats and reposts by public channels.

get_story_stats

Get statistics for a certain story.

load_async_graph

Load channel statistics graph asynchronously.

Premium

apply_boost

Apply boost

get_boosts

Get your boosts list

get_boosts_list

Obtains info about the boosts that were applied to a certain channel or supergroup (admins only).

get_boosts_status

Get boosts status of channel

get_user_boosts

Returns the list of boosts that were applied to a channel or supergroup by a specific user (admins only).

Decorators

on_business_connection

Decorator for handling changes in business connection.

on_business_message

Decorator for handling new messages from business connection.

on_callback_query

Decorator for handling callback queries.

on_chat_boost

Decorator for handling applied chat boosts.

on_chat_join_request

Decorator for handling chat join requests.

on_chat_left

Decorator for handling chat member leave events.

on_chat_member_updated

Decorator for handling event changes on chat members.

on_chosen_inline_result

Decorator for handling chosen inline results.

on_connect

Decorator for handling connections.

on_deleted_business_messages

Decorator for handling deleted messages from business connection.

on_deleted_messages

Decorator for handling deleted messages.

on_disconnect

Decorator for handling disconnections.

on_edited_business_message

Decorator for handling edited messages from business connection.

on_edited_message

Decorator for handling edited messages.

on_error

Decorator for handling unexpected errors.

on_guest_message

Decorator for handling new guest messages.

on_inline_query

Decorator for handling inline queries.

on_managed_bot

Decorator for handling new managed bot creation updates.

on_message

Decorator for handling new messages.

on_message_generation_stopped

Decorator for handling a user stopping the generation of a message.

on_message_reaction

Decorator for handling reaction changes on messages.

on_message_reaction_count

Decorator for handling anonymous reaction changes on messages.

on_poll

Decorator for handling poll updates.

on_pre_checkout_query

Decorator for handling pre-checkout queries.

on_purchased_paid_media

Decorator for handling purchased paid media.

on_raw_update

Decorator for handling raw updates.

on_shipping_query

Decorator for handling shipping queries.

on_start

Decorator for handling client start.

on_stop

Decorator for handling client stop.

on_story

Decorator for handling new stories.

on_stream_end

Decorator for handling when an audio or video stream in a voice chat ends.

on_stream_start

Decorator for handling when an audio or video stream in a voice chat starts.

on_user_status

Decorator for handling user status updates.

Authorization

accept_login_token

Accept a QR code login token, logging in the app that generated it.

accept_terms_of_service

Accept the given terms of service.

bind_temp_auth_key

Bind a temporary authorization key to a permanent authorization key.

cancel_code

Cancel the login verification code.

cancel_web_token_authorization

Cancel a web token authorization request.

change_phone_number

Change a user phone number in Telegram with a valid confirmation code.

check_paid_auth

Check the status of a login payment.

check_password

Check your Two-Step Verification password and log in.

check_recovery_password

Check if the 2FA recovery code is valid before passing it to recover_password.

connect

Connect the client to Telegram servers.

disconnect

Disconnect the client from Telegram servers.

drop_temp_auth_keys

Delete all temporary authorization keys except for the ones specified.

export_authorization

Export session authorization data to copy to another data center.

export_login_token

Generate a login token for login via QR code.

finish_firebase_pnv_login

Finish Firebase phone number verification login.

finish_passkey_login

Complete login with a passkey over an unauthenticated connection.

firebase_pnv_sign_up

Sign up a user verified via Firebase phone number verification.

get_active_sessions

Returns all active sessions of the current user.

get_password_hint

Get your Two-Step Verification password hint.

import_authorization

Log in a user using an exported authorization key transmitted from another data center.

import_login_token

Login using a redirected login token generated in case of DC mismatch during QR code login.

import_web_token_authorization

Login by importing a web authorization token.

init_firebase_pnv_login

Initialize Firebase phone number verification login.

init_passkey_login

Initialize login with a passkey over an unauthenticated connection.

initialize

Initialize the client by starting up workers.

log_out

Log out from Telegram and delete the *.session file.

recover_password

Recover your password with a recovery code and log in.

report_missing_code

Report that the SMS authentication code was not delivered.

request_firebase_sms

Request an SMS verification code via Firebase.

resend_code

Re-send the confirmation code using a different type.

resend_phone_number_code

Re-send the confirmation code using a different type.

reset_login_email

Reset the login email.

reset_session

Log out an active authorized session by its hash.

reset_sessions

Terminates all user's authorized sessions except for the current one.

send_code

Send the confirmation code to the given phone number.

send_phone_number_code

Sends a code to the specified phone number.

send_recovery_code

Send a code to your email to recover your password.

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.

terminate

Terminate the client by shutting down workers.

Advanced

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

get_collectible_info

Fetch information about a Fragment collectible (username or phone number).

get_file_hashes

Get SHA256 hashes for verifying downloaded files.

get_session

Get existing session or create a new one.

get_web_file

Returns content of a web file, by proxying the request through Telegram.

init_connection

Initialize connection with client information wrapping a query.

invoke

Invoke raw Telegram functions.

invoke_after_msg

Invokes a query after successful completion of one of the previous queries.

invoke_after_msgs

Invokes a query after successful completion of previous queries.

invoke_with_apns_secret

Official clients only, invoke query with Apple push verification secret.

invoke_with_google_play_integrity

Official clients only, invoke query with Google Play Integrity token.

invoke_with_layer

Invoke the specified query using the specified API layer.

invoke_with_messages_range

Invoke with the given message range.

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 sending the message to anyone.

set_dc

Set configuration for the specified datacenter.