PyroTGFork

https://telegramplayground.github.io/pyrogram
Admin
PyroTGFork is a Telegram client API framework that allows developers to interact with the Telegram...
Tokens:316,672
Snippets:3,447
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Client.initialize()

Source: https://telegramplayground.github.io/pyrogram/api/methods/initialize.html

Initializes the client by starting up workers, loading plugins, and starting the internal dispatcher.

```APIDOC
## Client.initialize()

### Description
Initializes the client by starting up workers. This method will start updates and download workers, load plugins, and start the internal dispatcher.

### Method
Method call

### Signature
Client.initialize()

### Raises
- **ConnectionError** - Raised if you try to initialize a disconnected client or if you try to initialize an already initialized client.
```

--------------------------------

### Verify Installation

Source: https://telegramplayground.github.io/pyrogram/intro/install.html

Check that the library is correctly installed by importing the version attribute in a Python shell.

```python
>>> from pyrogram import __version__
>>> __version__
'2.0.106-TL-158'
```

--------------------------------

### Client.start()

Source: https://telegramplayground.github.io/pyrogram/api/methods/start.html

Starts the client, connects to Telegram, and manages authorization.

```APIDOC
## Client.start()

### Description
Starts the client. This method connects the client to Telegram and, in case of new sessions, automatically manages the authorization process using an interactive prompt.

### Signature
`Client.start()`

### Returns
- **Client** - The started client itself.

### Raises
- **ConnectionError** - In case you try to start an already started client.

### Example
```python
from pyrogram import Client

app = Client("my_account")

async def main():
    await app.start()
    ...  # Invoke API methods
    await app.stop()

app.run(main())
```
```

--------------------------------

### Install uvloop

Source: https://telegramplayground.github.io/pyrogram/topics/speedups.html

Install the uvloop package to replace the default asyncio event loop.

```bash
$ pip3 install -U uvloop
```

--------------------------------

### Manual client start and stop

Source: https://telegramplayground.github.io/pyrogram/start/invoking.html

An alternative to the context manager approach, requiring explicit calls to start and stop the client.

```python
from pyrogram import Client

app = Client("my_account")


async def main():
    await app.start()
    await app.send_message(chat_id="me", text="Hi!")
    await app.stop()


app.run(main())
```

--------------------------------

### Install TgCrypto

Source: https://telegramplayground.github.io/pyrogram/topics/speedups.html

Install the PyTgCrypto package to enable high-performance cryptographic algorithms.

```bash
$ pip3 install -U PyTgCrypto
```

--------------------------------

### CallbackQuery.answer() example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/CallbackQuery.answer.html

A simple example of using the bound method to answer a callback query.

```python
await callback_query.answer("Hello", show_alert=True)
```

--------------------------------

### account.InstallTheme

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/account/install-theme.html

Installs a theme for the user account.

```APIDOC
## account.InstallTheme

### Description
Install a theme for the user account.

### Parameters
- **dark** (bool) - Optional - Whether to install the dark version
- **theme** (InputTheme) - Optional - Theme to install
- **format** (str) - Optional - Theme format, a string that identifies the theming engines supported by the client
- **base_theme** (BaseTheme) - Optional - Indicates a basic theme provided by all clients

### Returns
- **bool** - Returns true on success.
```

--------------------------------

### account.InstallWallPaper

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/account/install-wall-paper.html

Installs a wallpaper using the provided wallpaper object and settings.

```APIDOC
## account.InstallWallPaper

### Description
Install wallpaper.

### Parameters
- **wallpaper** (`InputWallPaper`) - Required - Wallpaper to install
- **settings** (`WallPaperSettings`) - Required - Wallpaper settings

### Returns
- `bool`
```

--------------------------------

### Usage example for ShippingQuery.answer

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/ShippingQuery.answer.html

Demonstrates the concise syntax for responding to a shipping query.

```python
await shipping_query.answer(ok=True)
```

--------------------------------

### Basic usage

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_document.html

Example of calling reply_document on a message object.

```python
await message.reply_document(document)
```

--------------------------------

### Basic usage

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_cached_media.html

Example of how to use the reply_cached_media method on a message object.

```python
await message.reply_cached_media(file_id)
```

--------------------------------

### Basic usage example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_video_note.html

Demonstrates the standard way to call the method on a message object.

```python
await message.reply_video_note(video_note)
```

--------------------------------

### Basic usage

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_voice.html

A simple example of how to use the reply_voice method on a message object.

```python
await message.reply_voice(voice)
```

--------------------------------

### Use uvloop with asyncio.run

Source: https://telegramplayground.github.io/pyrogram/topics/speedups.html

Initialize uvloop before starting the application with asyncio.run.

```python
import asyncio
import uvloop

from pyrogram import Client


async def main():
    app = Client("my_account")

    async with app:
        print(await app.get_me())


uvloop.install()
asyncio.run(main())
```

--------------------------------

### Chat.join() example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Chat.join.html

Basic usage of the join method on a chat object.

```python
await chat.join()
```

--------------------------------

### Basic usage

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_location.html

A simple example of how to call the reply_location method on a message object.

```python
await message.reply_location(latitude, longitude)
```

--------------------------------

### Basic usage

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_media_group.html

Simple example of using the reply_media_group method on a message object.

```python
await message.reply_media_group(list_of_media)
```

--------------------------------

### Initialize Client with plugins

Source: https://telegramplayground.github.io/pyrogram/topics/smart-plugins.html

Configuration for the main entry point to enable automatic plugin discovery.

```python
from pyrogram import Client

plugins = dict(root="plugins")

Client("my_account", plugins=plugins).run()
```

--------------------------------

### Get contacts count example

Source: https://telegramplayground.github.io/pyrogram/api/methods/get_contacts_count.html

Retrieves the total count of contacts and prints the result to the console.

```python
count = await app.get_contacts_count()
print(count)
```

--------------------------------

### Example usage of Chat.set_description

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Chat.set_description.html

Demonstrates how to update a chat description using the bound method.

```python
await chat.set_chat_description("Don't spam!")
```

--------------------------------

### Chat.add_members() usage example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Chat.add_members.html

Demonstrates the basic usage of the bound method.

```python
await chat.add_members(user_id)
```

--------------------------------

### Usage examples for Message.star()

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.star.html

Demonstrates how to add standard and anonymous paid reactions to a message.

```python
# Add a paid reaction to a message
await message.star(1)

# Add an anonymous paid reaction to a message
await message.star(1, True)
```

--------------------------------

### Basic Client Usage

Source: https://telegramplayground.github.io/pyrogram/api/methods/index.html

Demonstrates initializing a client and sending a message within a context manager.

```python
from pyrogram import Client

app = Client("my_account")

with app:
    app.send_message(chat_id="me", text="hi")
```

--------------------------------

### Get chat photos count example

Source: https://telegramplayground.github.io/pyrogram/api/methods/get_chat_photos_count.html

Retrieves the photo count for the current user's saved messages.

```python
count = await app.get_chat_photos_count("me")
print(count)
```

--------------------------------

### Get chat members count example

Source: https://telegramplayground.github.io/pyrogram/api/methods/get_chat_members_count.html

Retrieves the member count for a given chat ID and prints the result.

```python
count = await app.get_chat_members_count(chat_id)
print(count)
```

--------------------------------

### Answer Callback Query Examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/answer_callback_query.html

Demonstrates various ways to respond to a callback query, including simple acknowledgments, notifications, and alerts.

```python
# Answer only (remove the spinning circles)
await app.answer_callback_query(query_id)

# Answer without alert
await app.answer_callback_query(query_id, text=text)

# Answer with alert
await app.answer_callback_query(query_id, text=text, show_alert=True)
```

--------------------------------

### Enable Cloud Password Examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/enable_cloud_password.html

Demonstrates various ways to enable Two-Step Verification, including optional hint and recovery email parameters.

```python
# Enable password without hint and email
await app.enable_cloud_password("password")

# Enable password with hint and without email
await app.enable_cloud_password("password", hint="hint")

# Enable password with hint and email
await app.enable_cloud_password("password", hint="hint", email="user@email.com")
```

--------------------------------

### Send video examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/send_video.html

Demonstrates various ways to send videos, including adding captions, setting self-destruct timers, using view-once mode, and tracking upload progress.

```python
# Send video by uploading from local file
await app.send_video("me", "video.mp4")

# Add caption to the video
await app.send_video("me", "video.mp4", caption="video caption")

# Send self-destructing video
await app.send_video("me", "video.mp4", ttl_seconds=10)

# Send view-once video
await app.send_video("me", "video.mp4", view_once=True)

# Keep track of the progress while uploading
async def progress(current, total):
    print(f"{current * 100 / total:.1f}%")

await app.send_video("me", "video.mp4", progress=progress)
```

--------------------------------

### Send audio file examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/send_audio.html

Demonstrates various ways to send audio files, including adding captions, setting metadata, and tracking upload progress.

```python
# Send audio file by uploading from file
await app.send_audio("me", "audio.mp3")

# Add caption to the audio
await app.send_audio("me", "audio.mp3", caption="audio caption")

# Set audio metadata
await app.send_audio(
    "me", "audio.mp3",
    title="Title", performer="Performer", duration=234)

# Keep track of the progress while uploading
async def progress(current, total):
    print(f"{current * 100 / total:.1f}%")

await app.send_audio("me", "audio.mp3", progress=progress)
```

--------------------------------

### Set bot commands example

Source: https://telegramplayground.github.io/pyrogram/api/methods/set_bot_commands.html

Demonstrates how to define and apply a list of BotCommand objects to the bot.

```python
from pyrogram.types import BotCommand

# Set new commands
await app.set_bot_commands([
    BotCommand("start", "Start the bot"),
    BotCommand("settings", "Bot settings")])
```

--------------------------------

### Install Pyrogram v2.1.19

Source: https://telegramplayground.github.io/pyrogram/releases/v2.1.19.html

Use this command to uninstall the existing version and install the specific Pyrogram fork version.

```bash
pip uninstall -y pyrogram && pip install pyrotgfork==2.1.17
```

--------------------------------

### Running multiple clients with compose()

Source: https://telegramplayground.github.io/pyrogram/api/methods/compose.html

Demonstrates how to initialize a list of Client objects and execute them concurrently using the compose function.

```python
import asyncio
from pyrogram import Client, compose


async def main():
    apps = [
        Client("account1"),
        Client("account2"),
        Client("account3")
    ]

    ...

    await compose(apps)


asyncio.run(main())
```

--------------------------------

### Install Development Version

Source: https://telegramplayground.github.io/pyrogram/intro/install.html

Use these commands to install the development version of Pyrogram, optionally including TgCrypto for improved performance.

```bash
$ pip uninstall -y pyrogram && pip install pyrotgfork
```

```bash
$ pip install pyrotgfork[fast]
```

--------------------------------

### messages.InstallStickerSet

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/messages/install-sticker-set.html

Installs a sticker set for the user.

```APIDOC
## messages.InstallStickerSet

### Description
Install a stickerset.

### Parameters
- **stickerset** (InputStickerSet) - Required - Stickerset to install
- **archived** (bool) - Required - Whether to archive stickerset

### Returns
- messages.StickerSetInstallResult
```

--------------------------------

### Basic API call with Pyrogram

Source: https://telegramplayground.github.io/pyrogram/start/invoking.html

A complete example demonstrating how to initialize a client, define an async main function, and execute it using the run method.

```python
from pyrogram import Client

app = Client("my_account")


async def main():
    async with app:
        await app.send_message(chat_id="me", text="Hi!")


app.run(main())
```

--------------------------------

### messages.GetAllStickers

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/messages/get-all-stickers.html

Retrieves all installed stickers for the user.

```APIDOC
## messages.GetAllStickers

### Description
Get all installed stickers.

### Parameters
- **hash** (int 64-bit) - Required - Hash used for caching.

### Returns
- **messages.AllStickers** - The list of all installed stickers.
```

--------------------------------

### Join Chat Examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/join_chat.html

Demonstrates various ways to join a chat, including invite links, usernames, and linked chat IDs.

```python
# Join chat via invite link
await app.join_chat("https://t.me/+AbCdEf0123456789")

# Join chat via username
await app.join_chat("pyrogram")

# Join chat via Telegram Public Link
await app.join_chat("https://t.me/pyrogram")

# Join a linked chat
await app.join_chat(app.get_chat("pyrogram").linked_chat.id)
```

--------------------------------

### stories.GetAlbumStories

Source: https://telegramplayground.github.io/pyrogram/telegram/base/stories/stories.html

Get stories in a story album.

```APIDOC
## stories.GetAlbumStories

### Description
Get stories in a story album.
```

--------------------------------

### Send document examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/send_document.html

Demonstrates basic file upload, adding a caption, and tracking upload progress using a callback function.

```python
# Send document by uploading from local file
await app.send_document("me", "document.zip")

# Add caption to the document file
await app.send_document("me", "document.zip", caption="document caption")

# Keep track of the progress while uploading
async def progress(current, total):
    print(f"{current * 100 / total:.1f}%")

await app.send_document("me", "document.zip", progress=progress)
```

--------------------------------

### phone.StartScheduledGroupCall

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/phone/start-scheduled-group-call.html

Starts a scheduled group call or livestream.

```APIDOC
## phone.StartScheduledGroupCall

### Description
Starts a scheduled video chat or livestream, before or after its scheduled date.

### Parameters
- **call** (`InputGroupCall`) - Required - Scheduled video chat/livestream to start.

### Returns
- `Updates`
```

--------------------------------

### account.GetThemes

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/account/get-themes.html

Retrieves installed themes for the user account.

```APIDOC
## account.GetThemes

### Description
Get installed themes for the user account.

### Parameters
- **format** (str) - Theme format, a string that identifies the theming engines supported by the client.
- **hash** (int 64-bit) - Hash used for caching.

### Returns
- **account.Themes** - The list of installed themes.

### Details
- **Layer**: 227
- **ID**: 7206E458
```

--------------------------------

### Edit inline media examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/edit_inline_media.html

Demonstrates replacing current inline media with new photo, video, or audio files using InputMedia objects.

```python
from pyrogram.types import InputMediaPhoto, InputMediaVideo, InputMediaAudio

# Bots only

# Replace the current media with a local photo
await app.edit_inline_media(inline_message_id, InputMediaPhoto("new_photo.jpg"))

# Replace the current media with a local video
await app.edit_inline_media(inline_message_id, InputMediaVideo("new_video.mp4"))

# Replace the current media with a local audio
await app.edit_inline_media(inline_message_id, InputMediaAudio("new_audio.mp3"))
```

--------------------------------

### premium.GetBoostsStatus

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/premium/get-boosts-status.html

Gets the current number of boosts of a channel/supergroup.

```APIDOC
## premium.GetBoostsStatus

### Description
Gets the current number of boosts of a channel/supergroup.

### Parameters
- **peer** (`InputPeer`) - Required - The peer.

### Returns
- `premium.BoostsStatus`
```

--------------------------------

### messages.GetRecentReactions

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/messages/get-recent-reactions.html

Get recently used message reactions.

```APIDOC
## messages.GetRecentReactions

### Description
Get recently used message reactions.

### Parameters
- **limit** (int 32-bit) - Maximum number of results to return, see pagination
- **hash** (int 64-bit) - Hash used for caching

### Returns
messages.Reactions
```

--------------------------------

### messages.GetFeaturedEmojiStickers

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/messages/get-featured-emoji-stickers.html

Gets featured custom emoji stickersets.

```APIDOC
## messages.GetFeaturedEmojiStickers

### Description
Gets featured custom emoji stickersets.

### Parameters
- **hash** (int 64-bit) - Required - Hash used for caching.

### Returns
- **messages.FeaturedStickers** - The featured stickersets.
```

--------------------------------

### Client Initialization After Authorization

Source: https://telegramplayground.github.io/pyrogram/start/auth.html

Simplified client initialization once the session file has been created and credentials are no longer required.

```python
from pyrogram import Client

app = Client("my_account")
app.run()
```

--------------------------------

### Send Message with HTML Formatting

Source: https://telegramplayground.github.io/pyrogram/topics/text-formatting.html

Example of sending a message using HTML parse mode with various styles and nested elements.

```python
from pyrogram.enums import ParseMode

await app.send_message(
    chat_id="me",
    text=(
        "<b>bold</b>, <strong>bold</strong>"
        "<i>italic</i>, <em>italic</em>"
        "<u>underline</u>, <ins>underline</ins>"
        "<s>strike</s>, <strike>strike</strike>, <del>strike</del>"
        "<tg-spoiler>spoiler</tg-spoiler>\n\n"

        "<b>bold <i>italic bold <s>italic bold strike <tg-spoiler>italic bold strike spoiler</tg-spoiler></s> <u>underline italic bold</u></i> bold</b>\n\n"

        "<a href=\"https://telegramplayground.github.io/pyrogram/\">inline URL</a> "
        "<a href=\"tg://user?id=23122162\">inline mention of a user</a>\n"
        "<tg-emoji emoji-id=5469770542288478598>👍</tg-emoji> "
        "<code>inline fixed-width code</code> "
        "<pre>pre-formatted fixed-width code block</pre>\n\n"
        "<pre><code class='language-python'>"
        "for i in range(10):\n"
        "    print(i)"
        "</code></pre>\n\n"

        "<blockquote>Block quotation started"
        "Block quotation continued"
        "The last line of the block quotation</blockquote>"
        "<blockquote expandable>Expandable block quotation started"
        "Expandable block quotation continued"
        "Expandable block quotation continued"
        "Hidden by default part of the block quotation started"
        "Expandable block quotation continued"
        "The last line of the block quotation</blockquote>"
    ),
    parse_mode=ParseMode.HTML
)
```

--------------------------------

### contacts.ResolveUsername

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/contacts/resolve-username.html

Resolves a @username to get peer info.

```APIDOC
## contacts.ResolveUsername

### Description
Resolve a @username to get peer info.

### Parameters
- **username** (str) - Required - @username to resolve
- **referer** (str) - Optional - Referrer ID from referral links

### Returns
- **contacts.ResolvedPeer** - The resolved peer information.
```

--------------------------------

### Define Handlers in Separate Module

Source: https://telegramplayground.github.io/pyrogram/topics/smart-plugins.html

Example of defining handler functions in a separate file to be imported later.

```python
async def echo(client, message):
    await message.reply(message.text)


async def echo_reversed(client, message):
    await message.reply(message.text[::-1])
```

--------------------------------

### Define handlers in a plugin module

Source: https://telegramplayground.github.io/pyrogram/topics/smart-plugins.html

Example of defining multiple message handlers within a plugin file using the Client class decorator.

```python
from pyrogram import Client, filters


@Client.on_message(filters.text & filters.private)
async def echo(client, message):
    await message.reply(message.text)


@Client.on_message(filters.text & filters.private, group=1)
async def echo_reversed(client, message):
    await message.reply(message.text[::-1])
```

--------------------------------

### Send sticker examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/send_sticker.html

Demonstrates sending a sticker from a local file and using a pre-existing file_id.

```python
# Send sticker by uploading from local file
await app.send_sticker("me", "sticker.webp")

# Send sticker using file_id
await app.send_sticker("me", file_id)
```

--------------------------------

### resolve_peer

Source: https://telegramplayground.github.io/pyrogram/api/methods/index.html

Get the InputPeer of a known peer id.

```APIDOC
## resolve_peer

### Description
Get the InputPeer of a known peer id.

### Method
Method call

### Signature
`resolve_peer(peer_id)`
```

--------------------------------

### messages.RequestEncryption

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/messages/request-encryption.html

Sends a request to start a secret chat to the user.

```APIDOC
## messages.RequestEncryption

### Description
Sends a request to start a secret chat to the user.

### Parameters
- **user_id** (InputUser) - Required - User ID
- **random_id** (int 32-bit) - Required - Unique client request ID required to prevent resending. This also doubles as the chat ID.
- **g_a** (bytes) - Required - A = g ^ a mod p, see Wikipedia

### Returns
- **EncryptedChat**
```

--------------------------------

### Create chat invite links

Source: https://telegramplayground.github.io/pyrogram/api/methods/create_chat_invite_link.html

Examples showing how to generate a standard invite link and one restricted by a member limit.

```python
# Create a new link without limits
link = await app.create_chat_invite_link(chat_id)

# Create a new link for up to 3 new users
link = await app.create_chat_invite_link(chat_id, member_limit=3)
```

--------------------------------

### Invoke raw Telegram API functions

Source: https://telegramplayground.github.io/pyrogram/topics/advanced-usage.html

Examples demonstrating how to use the invoke method with raw functions for profile updates, status changes, and retrieving channel information.

```python
from pyrogram import Client
from pyrogram.raw import functions

async with Client("my_account") as app:
    await app.invoke(
        functions.account.UpdateProfile(
            first_name="First Name", last_name="Last Name",
            about="New bio text"
        )
    )
```

```python
from pyrogram import Client
from pyrogram.raw import functions, types

async with Client("my_account") as app:
    # Set online status
    await app.invoke(functions.account.UpdateStatus(offline=False))

    # Set offline status
    await app.invoke(functions.account.UpdateStatus(offline=True))
```

```python
from pyrogram import Client
from pyrogram.raw import functions, types

async with Client("my_account") as app:
    r = await app.invoke(
        functions.channels.GetFullChannel(
            channel=app.resolve_peer("username")
        )
    )

    print(r)
```

--------------------------------

### Instantiating the Client object

Source: https://telegramplayground.github.io/pyrogram/start/invoking.html

Creating a new Client instance with a specified session name.

```python
app = Client("my_account")
```

--------------------------------

### Using User.block()

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/User.block.html

Usage example for the User.block() bound method.

```python
await user.block()
```

--------------------------------

### Download shortcut equivalent

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/ExternalReplyInfo.download.html

Shows the underlying client method call that the download() shortcut replaces.

```python
await client.download_media(message.external_reply.document)
```

--------------------------------

### Usage of Message.get_media_group

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.get_media_group.html

Basic usage example for the bound method.

```python
await message.get_media_group()
```

--------------------------------

### Set profile photo or video

Source: https://telegramplayground.github.io/pyrogram/api/methods/set_profile_photo.html

Examples showing how to update a profile using either a photo file or a video file.

```python
# Set a new profile photo
await app.set_profile_photo(photo="new_photo.jpg")

# Set a new profile video
await app.set_profile_photo(video="new_video.mp4")
```

--------------------------------

### photos.UpdateProfilePhoto

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/photos/update-profile-photo.html

Installs a previously uploaded photo as a profile photo.

```APIDOC
## photos.UpdateProfilePhoto

### Description
Installs a previously uploaded photo as a profile photo.

### Parameters
- **id** (InputPhoto) - Required - Input photo
- **fallback** (bool) - Optional - If set, the chosen profile photo will be shown to users that can’t display your main profile photo due to your privacy settings.
- **bot** (InputUser) - Optional - Can contain info of a bot we own, to change the profile photo of that bot, instead of the current user.

### Returns
- **photos.Photo**
```

--------------------------------

### aicompose.GetToneExample

Source: https://telegramplayground.github.io/pyrogram/telegram/base/ai-compose-tone-example.html

Fetches an example showing how an AI composer tone rephrases a sample message, used as a preview in the tone picker.

```APIDOC
## aicompose.GetToneExample

### Description
Fetch an example showing how an AI composer tone rephrases a sample message, used as a preview in the tone picker.

### Returns
- **AiComposeToneExample** - An example showing how an AI composer tone rephrases a message.
```

--------------------------------

### Implement Custom Storage Engine

Source: https://telegramplayground.github.io/pyrogram/api/storage/index.html

Demonstrates using a custom storage engine by passing a subclass of Storage to the Client constructor.

```python
import asyncio
from pyrogram import Client
from .aio_sqlite_storage import AioSQLiteStorage  # assumes the file is available
api_id = 12345
api_hash = "0123456789abcdef0123456789abcdef"
async def main():
    async with Client(
        "my_account",
        api_id,
        api_hash,
        storage_engine=AioSQLiteStorage("/path/to/your/file.session")
    ) as app:
        await app.send_message(chat_id="me", text="Greetings from **Pyrogram**!")
asyncio.run(main())
```

--------------------------------

### account.SaveWallPaper

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/account/save-wall-paper.html

Install or uninstall a wallpaper using the account.SaveWallPaper function.

```APIDOC
## account.SaveWallPaper

### Description
Install or uninstall a wallpaper.

### Parameters
- **wallpaper** (`InputWallPaper`) - Required - Wallpaper to install or uninstall
- **unsave** (`bool`) - Required - Uninstall wallpaper?
- **settings** (`WallPaperSettings`) - Required - Wallpaper settings

### Returns
- `bool`
```

--------------------------------

### Send video note examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/send_video_note.html

Demonstrates various ways to send video notes, including setting length, self-destruct timers, and view-once restrictions.

```python
# Send video note by uploading from local file
await app.send_video_note("me", "video_note.mp4")

# Set video note length
await app.send_video_note("me", "video_note.mp4", length=25)

# Send self-destructing video note message
await app.send_video_note("me", "video_note.mp4", ttl_seconds=10)

# Send view-once video note message
await app.send_video_note("me", "video_note.mp4", view_once=True)
```

--------------------------------

### messages.GetExportedChatInvites

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/messages/get-exported-chat-invites.html

Get info about the chat invites of a specific chat.

```APIDOC
## messages.GetExportedChatInvites

### Description
Get info about the chat invites of a specific chat.

### Parameters
- **peer** (InputPeer) - Required - Chat
- **admin_id** (InputUser) - Required - Whether to only fetch chat invites from this admin
- **limit** (int 32-bit) - Required - Maximum number of results to return, see pagination
- **revoked** (bool) - Optional - Whether to fetch revoked chat invites
- **offset_date** (int 32-bit) - Optional - Offsets for pagination
- **offset_link** (str) - Optional - Offsets for pagination

### Returns
messages.ExportedChatInvites
```

--------------------------------

### Define Overlapping Handlers

Source: https://telegramplayground.github.io/pyrogram/topics/more-on-updates.html

Example of handlers with conflicting filters where the first registered handler prevents subsequent ones from executing.

```python
@app.on_message(filters.text | filters.sticker)
async def text_or_sticker(client, message):
    print("Text or Sticker")


@app.on_message(filters.text)
async def just_text(client, message):
    print("Just Text")
```

--------------------------------

### bots.GetPreviewMedias

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/bots/get-preview-medias.html

Fetch main mini app previews for a given bot.

```APIDOC
## bots.GetPreviewMedias

### Description
Fetch main mini app previews for a specified bot.

### Parameters
- **bot** (InputUser) - Required - The bot that owns the Main Mini App.

### Returns
- List of BotPreviewMedia
```

--------------------------------

### channels.GetFullChannel

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/channels/get-full-channel.html

Get full info about a supergroup, gigagroup or channel.

```APIDOC
## channels.GetFullChannel

### Description
Get full info about a supergroup, gigagroup or channel.

### Parameters
- **channel** (`InputChannel`) - Required - The channel, supergroup or gigagroup to get info about.

### Returns
- `messages.ChatFull`
```

--------------------------------

### bots.GetAdminedBots

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/bots/get-admined-bots.html

Get a list of bots owned by the current user.

```APIDOC
## bots.GetAdminedBots

### Description
Get a list of bots owned by the current user.

### Parameters
**No parameters required.**

### Returns
List of `User`
```

--------------------------------

### phone.JoinGroupCallPresentation

Source: https://telegramplayground.github.io/pyrogram/telegram/functions/phone/join-group-call-presentation.html

Start screen sharing in a non-RTMP video chat/livestream or conference.

```APIDOC
## phone.JoinGroupCallPresentation

### Description
Start screen sharing in a non-RTMP video chat/livestream or conference. Presentations are not supported in live stories or RTMP-mode video chats/livestreams.

### Parameters
- **call** (`InputGroupCall`) - Joined non-RTMP video chat/livestream or conference in which to start presenting
- **params** (`DataJSON`) - Join payload generated by a separate local call-engine instance for the presentation

### Returns
`Updates`
```

--------------------------------

### Message.unpin() example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.unpin.html

Direct usage of the unpin method on a message object.

```python
await message.unpin()
```

--------------------------------

### Delete account example

Source: https://telegramplayground.github.io/pyrogram/api/methods/delete_account.html

Demonstrates the basic usage of the delete_account method with reason and password parameters.

```python
await app.delete_account(reason, password)
```

--------------------------------

### Update Profile Examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/update_profile.html

Demonstrates updating specific profile fields or removing the last name by passing an empty string.

```python
# Update your first name only
await app.update_profile(first_name="Pyrogram")

# Update first name and bio
await app.update_profile(first_name="Pyrogram", bio="https://github.com/TelegramPlayground/pyrogram")

# Remove the last name
await app.update_profile(last_name="")
```

--------------------------------

### Basic usage of reply_sticker

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.reply_sticker.html

Simple example of replying to a message with a sticker.

```python
await message.reply_sticker(sticker)
```

--------------------------------

### Use uvloop with app.run

Source: https://telegramplayground.github.io/pyrogram/topics/speedups.html

Initialize uvloop before creating the Client instance when using app.run.

```python
import uvloop
from pyrogram import Client

uvloop.install()

app = Client("my_account")


@app.on_message()
async def hello(client, message):
    print(await client.get_me())


app.run()
```

--------------------------------

### Usage of Message.read()

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.read.html

Basic usage example for marking a message as read.

```python
await message.read()
```

--------------------------------

### Set Chat Permissions Examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/set_chat_permissions.html

Demonstrates how to restrict all chat permissions or allow specific message and media types using ChatPermissions.

```python
from pyrogram.types import ChatPermissions

# Completely restrict chat
await app.set_chat_permissions(chat_id, ChatPermissions())

# Chat members can only send text messages and media messages
await app.set_chat_permissions(
    chat_id,
    ChatPermissions(
        can_send_messages=True,
        can_send_media_messages=True
    )
)
```

--------------------------------

### Basic message sending examples

Source: https://telegramplayground.github.io/pyrogram/api/methods/send_message.html

Demonstrates sending a simple message, disabling link previews, and replying to a specific message ID.

```python
# Simple example
await app.send_message(chat_id="me", text="Message sent with **Pyrogram**!")

# Disable web page previews
await app.send_message(
    chat_id="me", text="https://github.com/TelegramPlayground/pyrogram",
    link_preview_options=types.LinkPreviewOptions(
        is_disabled=True
    )
)

# Reply to a message using its id
await app.send_message(chat_id="me", text="this is a reply", reply_parameters=types.ReplyParameters(message_id=123))
```

--------------------------------

### Message.answer() usage example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Message.answer.html

Demonstrates how to use the answer method with an InlineQueryResultArticle.

```python
await message.answer(
    InlineQueryResultArticle(
        "Title",
        InputTextMessageContent("Message content")
    )
)
```

--------------------------------

### help.GetConfig

Source: https://telegramplayground.github.io/pyrogram/telegram/base/config.html

Retrieves the current configuration, including data center configuration details.

```APIDOC
## help.GetConfig

### Description
Returns the current configuration of the client, including data center configuration parameters.

### Returns
- **Config** (Object) - The current configuration object.
```

--------------------------------

### Chat.unpin_all_messages example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Chat.unpin_all_messages.html

Basic usage of the unpin_all_messages method on a chat object.

```python
chat.unpin_all_messages()
```

--------------------------------

### Chat.get_member() example

Source: https://telegramplayground.github.io/pyrogram/api/bound-methods/Chat.get_member.html

Basic usage of the bound method on a chat object.

```python
await chat.get_member(user_id)
```
Tokens:
Raw