Pyrogram

https://docs.kurigram.icu/
Admin
Pyrogram is a modern Telegram client library for Python that provides a simple and intuitive API for...
Tokens:1,054,320
Snippets:10,528
Trust Score:2.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Smart Plugin Setup Example

Source: https://docs.kurigram.icu/topics/smart-plugins

Demonstrates setting up a project with Smart Plugins. Handlers are placed in a 'plugins' folder and registered automatically via the `plugins` parameter in the Client.

```python
myproject/
    plugins/
        handlers.py
    main.py
```

```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])
```

```python
from pyrogram import Client

plugins = dict(root="plugins")

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

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

### initialize()

Source: https://docs.kurigram.icu/api/methods/initialize

Initializes the client by starting up workers, which includes starting updates and download workers. It also loads plugins and starts the internal dispatcher.

```APIDOC
## initialize()

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

### Method
Client.initialize()

### Raises
* **ConnectionError**: In case you try to initialize a disconnected client or in case you try to initialize an already initialized client.
```

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

### Start Client and Use API

Source: https://docs.kurigram.icu/api/methods/start

Connects the client to Telegram and allows invoking API methods. Ensure you install the `qrcode` package for QR code authorization if needed.

```python
import asyncio

from pyrogram import Client


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

    await app.start()
    ...  # Invoke API methods
    await app.stop()

asyncio.run(main())
```

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

### Install QR Code Package

Source: https://docs.kurigram.icu/start/auth

Before using QR code login, install the 'qrcode' package using pip.

```bash
$ pip3 install qrcode

```

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

### Start Bot with start_bot() and Parameter

Source: https://docs.kurigram.icu/api/methods/start_bot

Starts a bot and includes a deep linking parameter for custom initialization. The parameter can be up to 64 characters long.

```python
# Start bot with param
await app.start_bot("pyrogrambot", "ref123456")
```

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

### Start Bot with start_bot()

Source: https://docs.kurigram.icu/api/methods/start_bot

Initiates a bot using its username. This is the basic usage for starting a bot.

```python
# Start bot
await app.start_bot("pyrogrambot")
```

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

### Sending a Video with send_video()

Source: https://docs.kurigram.icu/api/methods/send_video

This is a basic example of how to send a video file using the send_video() method. Ensure you have the necessary Pyrogram client setup.

```python
await app.send_video(chat_id, "path/to/your/video.mp4")
```

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

### InstallWallPaper

Source: https://docs.kurigram.icu/telegram/functions/account

Installs a wallpaper.

```APIDOC
## InstallWallPaper

### Description
Installs a wallpaper.

### Method
Not specified

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

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

### start_bot

Source: https://docs.kurigram.icu/api/methods

Starts a bot.

```APIDOC
## start_bot

### Description
Start bot.

### Method
POST

### Endpoint
/start_bot

### Parameters
#### Query Parameters
- **bot_username** (string) - Required - The username of the bot to start.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of starting the bot.
```

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

### Basic Pyrogram Client Setup

Source: https://docs.kurigram.icu/

This snippet demonstrates how to set up a basic Pyrogram client to respond to private messages. Ensure you have Pyrogram installed and replace 'my_account' with your desired session name.

```python
from pyrogram import Client, filters

app = Client("my_account")


@app.on_message(filters.private)
async def hello(client, message):
    await message.reply("Hello from Kurigram!")


app.run()
```

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

### InstallTheme

Source: https://docs.kurigram.icu/telegram/functions/account

Installs a theme.

```APIDOC
## InstallTheme

### Description
Installs a theme.

### Method
Not specified

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

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

### Pyrogram Client Lifecycle Without Context Manager

Source: https://docs.kurigram.icu/start/invoking

Demonstrates manual starting and stopping of the Pyrogram client. This approach requires explicit calls to start() and stop().

```python
import asyncio
from pyrogram import Client

app = Client("my_account")


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


asyncio.run(main())
```

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

### Install uvloop

Source: https://docs.kurigram.icu/topics/speedups

Install uvloop using pip. This is a drop-in replacement for the built-in asyncio event loop, offering significant speed improvements.

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

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

### StartLive

Source: https://docs.kurigram.icu/telegram/functions/stories

Starts a live story broadcast.

```APIDOC
## StartLive

### Description
Starts a live broadcast as a story.

### Method
stories.StartLive

### Parameters
#### Query Parameters
- **peer** (Peer) - Required - The peer to broadcast to.
- **media** (InputMedia) - Required - The live media stream.

### Request Example
```json
{
  "stories.StartLive": {
    "peer": {"_": "inputPeerUser", "user_id": 123456789, "access_hash": "..."},
    "media": {"_": "inputMediaWebDocument", "url": "...", "mime_type": "video/mp4"}
  }
}
```

### Response
#### Success Response (200)
- **updates** (list of Update) - A list of updates related to the live broadcast.
```

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

### Run the Client

Source: https://docs.kurigram.icu/api/methods/run

Use this method to start the client, idle the main script, and then stop the client. It simplifies running a single client by sequentially calling start(), idle(), and stop().

```python
from pyrogram import Client

app = Client("my_account")
...  # Set handlers up
app.run()
```

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

### account.InstallWallPaper

Source: https://docs.kurigram.icu/telegram/functions/account/install-wall-paper

Installs a wallpaper for the user with custom settings.

```APIDOC
## account.InstallWallPaper

### Description
Installs a wallpaper for the user.

### Method
POST

### Endpoint
/account.InstallWallPaper

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

### Response
#### Success Response (200)
- **bool** - True if the wallpaper was installed successfully.
```

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

### Client.run()

Source: https://docs.kurigram.icu/api/methods/run

Starts the client, idles the main script, and stops the client. When called without arguments, it sequentially calls start(), idle(), and stop(). This simplifies running a single client.

```APIDOC
## Client.run()

### Description
Starts the client, idles the main script, and stops the client. When called without arguments, it sequentially calls start(), idle(), and stop(). This simplifies running a single client.

### Method
`run()`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **use_qr** (`bool`, _optional_) – Use QR code authorization instead of the interactive prompt. For new authorizations only. Defaults to False.
* **except_ids** (List of `int`, _optional_) – List of already logged-in user IDs, to prevent logging in twice with the same user.

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

app = Client("my_account")
# ... Set handlers up
app.run()
```

### Response
#### Success Response (200)
None explicitly documented.

#### Response Example
None explicitly documented.

### Raises
**ConnectionError** – In case you try to run an already started client.
```

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

### start_bot()

Source: https://docs.kurigram.icu/api/methods/start_bot

Starts a bot. This method can be used by both Users and Bots.

```APIDOC
## start_bot()

### Description
Starts a bot. This method can be used by both Users and Bots.

### Method
Client.start_bot()

### Parameters
#### Path Parameters
- **chat_id** (int | str) – Unique identifier of the bot you want to be started. You can specify a @username (str) or a bot ID (int).
- **param** (str) – Text of the deep linking parameter (up to 64 characters). Defaults to "" (empty string).

### Request Example
```python
# Start bot
await app.start_bot("pyrogrambot")

# Start bot with param
await app.start_bot("pyrogrambot", "ref123456")
```

### Response
#### Success Response (200)
`Message` – On success, the sent message is returned.
```

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

### StartBot

Source: https://docs.kurigram.icu/telegram/functions/messages

Starts a bot in a chat.

```APIDOC
## StartBot

### Description
Starts a bot in a chat.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC
```

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

### Get Chat Gifts

Source: https://docs.kurigram.icu/api/methods/get_chat_gifts

Iterate through all gifts owned by a specified chat. This example demonstrates basic usage by printing each gift.

```python
async for gift in app.get_chat_gifts(chat_id):
    print(gift)
```

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

### Client Initialization Options

Source: https://docs.kurigram.icu/api/client

When creating a new client instance, you can pass several optional arguments to configure its behavior.

```APIDOC
## Client Initialization

### Description
Allows configuration of various client behaviors upon initialization.

### Parameters
#### Optional Parameters
- **sleep_threshold** (int) - Set a sleep threshold for flood wait exceptions. Defaults to 10 seconds.
- **hide_password** (bool) - Pass True to hide the password when typing it during login. Defaults to False.
- **max_concurrent_transmissions** (int) - Set the maximum amount of concurrent transmissions (uploads & downloads). Defaults to 1.
- **max_message_cache_size** (int) - Set the maximum size of the message cache. Defaults to 1000.
- **max_topic_cache_size** (int) - Set the maximum size of the topic cache. Defaults to 1000.
- **storage_engine** (Storage) - Pass an instance of your own implementation of session storage engine.
- **client_platform** (ClientPlatform) - The platform where this client is running. Defaults to ‘other’.
- **link_preview_options** (LinkPreviewOptions) - Global link preview options for the client.
- **fetch_replies** (bool) - Pass True to automatically fetch replies for messages. Defaults to True.
- **fetch_topics** (bool) - Pass True to automatically fetch forum topics. Defaults to True.
- **fetch_stories** (bool) - Pass True to automatically fetch stories if they are missing. Defaults to True.
- **fetch_stickers** (bool) - Pass True to automatically fetch names of sticker sets. Defaults to True.
- **loop** (asyncio.AbstractEventLoop) - Event loop.
- **init_connection_params** (dict) - Additional initConnection parameters. For now, only the tz_offset field is supported.
```

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

### Basic Pyrogram Message Sending

Source: https://docs.kurigram.icu/start/invoking

A fundamental example of sending a message using Pyrogram. Ensure Pyrogram is installed and your account is authorized before running.

```python
import asyncio
from pyrogram import Client


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

    async with app:
        await app.send_message("me", "Hi!")


asyncio.run(main())
```

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

### Get Chat Event Log

Source: https://docs.kurigram.icu/api/methods/get_chat_event_log

Iterate through chat events using the get_chat_event_log method. This example shows a basic usage to print each event.

```python
async for event in app.get_chat_event_log(chat_id):
    print(event)
```

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

### on_start()

Source: https://docs.kurigram.icu/api/decorators

Decorator to register a callback function for handling the /start command.

```APIDOC
## @app.on_start()

### Description
Registers a callback function to be executed when the bot receives the /start command.

### Parameters
- `client`: The `Client` instance.
- `message`: The incoming `Message` object.
```

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

### Get Archived Stories from a Specific Chat

Source: https://docs.kurigram.icu/api/methods/get_archived_stories

Fetches all archived stories from a given chat ID. This example iterates through the generator and prints each story.

```python
async for story in app.get_stories_archive(chat_id):
    print(story)
```

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

### Send Paid Media Example

Source: https://docs.kurigram.icu/api/methods/send_paid_media

Demonstrates how to send multiple paid photos and a video to a chat. Ensure you have the necessary imports for InputMediaPhoto and InputMediaVideo.

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

await app.send_paid_media(
    chat_id,
    stars_amount=50,
    caption="Look at this!",
    media=[
        InputMediaPhoto("photo1.jpg"),
        InputMediaPhoto("photo2.jpg"),
        InputMediaVideo("video.mp4")
    ]
)
```

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

### Get Full Chat History with Pyrogram

Source: https://docs.kurigram.icu/start/examples/get_chat_history

Use this snippet to fetch all messages from a chat, starting with the latest. Ensure you have initialized the Client with your account details.

```python
import asyncio
from pyrogram import Client


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

    async with app:
        # "me" refers to your own chat (Saved Messages)
        async for message in app.get_chat_history("me"):
            print(message)


asyncio.run(main())
```

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

### Client.start()

Source: https://docs.kurigram.icu/api/methods/start

Starts the client, connecting to Telegram and managing authorization. Supports interactive prompt or QR code authorization for new sessions.

```APIDOC
## Client.start()

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

Note: You should install `qrcode` package if you want to use QR code authorization.

### Parameters
#### Optional Parameters
- **use_qr** (`bool`) – Use QR code authorization instead of the interactive prompt. For new authorizations only. Defaults to False.
- **except_ids** (List of `int`) – List of already logged-in user IDs, to prevent logging in twice with the same user.

### Returns
`Client` – The started client itself.

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

### Example
```python
import asyncio

from pyrogram import Client


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

    await app.start()
    ...  # Invoke API methods
    await app.stop()

asyncio.run(main())
```
```

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

### Get Direct Messages Chat Topic History

Source: https://docs.kurigram.icu/api/methods/get_direct_messages_chat_topic_history

Iterate through messages in a direct messages chat topic. This example demonstrates fetching messages in reverse chronological order by default. Ensure `chat_id` and `topic_id` are defined.

```python
async for message in app.get_direct_messages_chat_topic_history(chat_id, topic_id):
    print(message.text)
```

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

### FloodWait Error Example

Source: https://docs.kurigram.icu/api/errors

Example of how to catch a FloodWait error in Pyrogram.

```APIDOC
## FloodWait Error

### Description
Handles the FloodWait error, which occurs when an action is rate-limited.

### Method
`try...except` block

### Endpoint
N/A (Exception handling)

### Parameters
N/A

### Request Example
```python
from pyrogram.errors import FloodWait

try:
    # Your Pyrogram code here
    pass
except FloodWait as e:
    # Handle the error, e.g., wait for e.value seconds
    print(f"Flood wait: {e.value} seconds")
```

### Response
#### Success Response
N/A (This is for error handling)

#### Response Example
N/A
```

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

### Install Kurigram with pip

Source: https://docs.kurigram.icu/intro/install

Use this command to install the stable version of Kurigram from PyPI.

```bash
pip install kurigram
```

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

### Forward Story Example

Source: https://docs.kurigram.icu/api/methods/forward_story

Demonstrates how to forward a story to a specified chat. Ensure you have the necessary chat IDs and story ID.

```python
await app.forward_story(to_chat, from_chat, 123)
```

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

### search_posts_count()

Source: https://docs.kurigram.icu/api/methods/search_posts_count

Get the count of posts with a hashtag resulting from a search. If you want to get the actual posts, see `search_posts()`.

```APIDOC
## search_posts_count()

### Description
Get the count of posts with a hashtag resulting from a search. If you want to get the actual posts, see `search_posts()`.

### Method
Client.search_posts_count()

### Parameters
#### Query Parameters
- **hashtag** (str) - Required - Text query string.

### Returns
#### Success Response (int)
- On success, the posts count is returned.
```

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

### search_global_count()

Source: https://docs.kurigram.icu/api/methods/search_global_count

Get the count of messages resulting from a global search. If you want to get the actual messages, see search_global().

```APIDOC
## search_global_count()

### Description
Get the count of messages resulting from a global search. If you want to get the actual messages, see `search_global()`.

### Method
Client.search_global_count()

### Parameters
#### Query Parameters
- **query** (str, optional) - Text query string. Use “@” to search for mentions.
- **filter** (MessagesFilter, optional) - Pass a filter in order to search for specific kind of messages only.
- **channels_only** (bool, optional) - Pass True to search only in channels.
- **groups_only** (bool, optional) - Pass True to search only in groups.
- **users_only** (bool, optional) - Pass True to search only in users.

### Response
#### Success Response (200)
- **int** - On success, the messages count is returned.
```

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

### Simplified Client Initialization

Source: https://docs.kurigram.icu/start/auth

After successful authorization, you can simplify client initialization by omitting api_id and api_hash, as they are no longer needed.

```python
from pyrogram import Client

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

```

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

### bots.GetPreviewMedias

Source: https://docs.kurigram.icu/telegram/base/bot-preview-media

Fetches the main mini app previews. Retrieves a list of configured previews.

```APIDOC
## bots.GetPreviewMedias

### Description
Fetch main mini app previews.

### Method
Not specified (assumed to be a function call within an SDK)

### Endpoint
Not applicable (SDK function)

### Parameters
None explicitly mentioned.

### Request Example
```python
# Example usage (assuming 'bots' is an initialized object)
previews = bots.GetPreviewMedias()
```

### Response
- **Success Response**: A list of BotPreviewMedia objects (specifics not provided in source).

### Response Example
```json
{
  "example": "response body"
}
```
```

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

### InlineQuery.answer() Usage Example

Source: https://docs.kurigram.icu/api/bound-methods/InlineQuery.answer

This is a direct usage example of the inline_query.answer() bound method. It takes a list of results as its primary argument.

```python
await inline_query.answer([...])
```

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

### Install TgCrypto

Source: https://docs.kurigram.icu/topics/speedups

Install TgCrypto using pip. This library provides a faster alternative for cryptographic operations required by Telegram.

```bash
$ pip3 install -U tgcrypto
```

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

### account.InstallTheme

Source: https://docs.kurigram.icu/telegram/functions/account/install-theme

Installs a theme for the user. This function can be used by both regular users and bots.

```APIDOC
## account.InstallTheme

### Description
Installs a theme. Usable by users and bots.

### Method
`account.InstallTheme`

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

### Returns
- **bool** - True if the theme was installed successfully.
```

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

### Verify Kurigram Installation

Source: https://docs.kurigram.icu/intro/install

Open a Python shell and import pyrogram to confirm a successful installation. This checks if the library is accessible.

```python
>>> import pyrogram
>>> pyrogram.__version__
'x.y.z'
```

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

### help.GetPromoData

Source: https://docs.kurigram.icu/telegram/base/help/promo-data

Returns a set of useful suggestions and PSA/MTProxy sponsored peers.

```APIDOC
## help.GetPromoData

### Description
Returns a set of useful suggestions and PSA/MTProxy sponsored peers.

### Method
GET

### Endpoint
/help/getPromoData

### Response
#### Success Response (200)
- **promo_data** (PromoData) - Information about pinned MTProxy or Public Service Announcement peers.
```

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

### search_messages_count

Source: https://docs.kurigram.icu/api/methods/search_messages_count

Get the count of messages resulting from a search inside a chat. If you want to get the actual messages, see `search_messages()`.

```APIDOC
## search_messages_count()

### Description
Get the count of messages resulting from a search inside a chat. If you want to get the actual messages, see `search_messages()`.

### Method
Client.search_messages_count()

### Parameters
#### Path Parameters
None

#### Query Parameters
* **chat_id** (`int` | `str`) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).
* **query** (`str`, _optional_) – Text query string. Required for text-only messages, optional for media messages (see the `filter` argument). When passed while searching for media messages, the query will be applied to captions. Defaults to “” (empty string).
* **filter** (`MessagesFilter`, _optional_) – Pass a filter in order to search for specific kind of messages only.
* **from_user** (`int` | `str`, _optional_) – Unique identifier (int) or username (str) of the target user you want to search for messages from.
* **message_thread_id** (`int`, _optional_) – Unique identifier for the target message thread (topic) of the forum. For supergroups only.

### Request Example
```python
# Example usage (assuming 'client' is an authenticated client instance)
# count = client.search_messages_count(chat_id='me', query='hello')
```

### Response
#### Success Response (200)
* **count** (`int`) – On success, the messages count is returned.
```

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

### Get Replied-to Message

Source: https://docs.kurigram.icu/api/methods/get_messages

Retrieve the message that a given message is replying to. Set reply=True to get the direct replied-to message.

```python
await app.get_messages(chat_id=chat_id, message_ids=message_id, reply=True)
```

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

### BotPreviewMedia Constructor

Source: https://docs.kurigram.icu/telegram/types/bot-preview-media

Represents a Main Mini App preview media. This is the constructor for the BotPreviewMedia object.

```APIDOC
## BotPreviewMedia

### Description
Represents a Main Mini App preview media.

### Constructor
`BotPreviewMedia(date: int, media: MessageMedia)`

### Parameters
#### Constructor Parameters
- **date** (int 32-bit) - Required - When was this media last updated.
- **media** (MessageMedia) - Required - The actual photo/video.
```

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

### BotVerifierSettings Constructor

Source: https://docs.kurigram.icu/telegram/base/bot-verifier-settings

Info about the current verifier bot.

```APIDOC
## BotVerifierSettings

### Description
Info about the current verifier bot.

### Constructor
`BotVerifierSettings`
```

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

### Get Gift Code Information

Source: https://docs.kurigram.icu/api/methods/check_gift_code

Use this snippet to get information about a gift code by providing its URL. Ensure the app object is initialized.

```python
# get information about a gift code
await app.check_gift_code("t.me/giftcode/abc1234567def")
```

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

### Schedule Task Non-Asynchronously with BackgroundScheduler

Source: https://docs.kurigram.icu/topics/scheduling

Use BackgroundScheduler for scheduling tasks in a non-asynchronous Pyrogram application. Ensure apscheduler is installed (`pip3 install apscheduler`).

```python
from apscheduler.schedulers.background import BackgroundScheduler

from pyrogram import Client

app = Client("my_account")


def job():
    app.send_message("me", "Hi!")


scheduler = BackgroundScheduler()
scheduler.add_job(job, "interval", seconds=3)

scheduler.start()
app.run()

```

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

### Client Initialization and Usage

Source: https://docs.kurigram.icu/api/client

Demonstrates how to initialize and use the Pyrogram Client to send a message.

```APIDOC
## Pyrogram Client

### Description
The `Client` class is the main entry point for interacting with the Telegram API using Pyrogram. It provides high-level methods for ease of use.

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

app = Client("my_account")

with app:
    app.send_message("me", "Hi!")
```

### Method
`Client` initialization and context management (`with app:`)

### Parameters
- `name` (str): The name of the session file.

### Request Example
(Not applicable for initialization)

### Response
(Not applicable for initialization)

### Method
`send_message`

### Endpoint
(Not applicable - SDK method)

### Parameters
#### Path Parameters
(Not applicable)

#### Query Parameters
(Not applicable)

#### Request Body
- `chat_id` (str or int): The ID or username of the chat to send the message to.
- `text` (str): The text of the message to send.

### Request Example
```json
{
  "chat_id": "me",
  "text": "Hi!"
}
```

### Response
#### Success Response (200)
- `message` (Message): An object representing the sent message.

#### Response Example
(Example response structure for a Message object would be detailed here if provided in source)
```

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

### Schedule Task Asynchronously with AsyncIOScheduler

Source: https://docs.kurigram.icu/topics/scheduling

Use AsyncIOScheduler for scheduling tasks in an asynchronous Pyrogram application. Ensure apscheduler is installed (`pip3 install apscheduler`).

```python
from apscheduler.schedulers.asyncio import AsyncIOScheduler

from pyrogram import Client

app = Client("my_account")


async def job():
    await app.send_message("me", "Hi!")


scheduler = AsyncIOScheduler()
scheduler.add_job(job, "interval", seconds=3)

scheduler.start()
app.run()

```

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

### Proceed with Order using answer_pre_checkout_query()

Source: https://docs.kurigram.icu/api/methods/answer_pre_checkout_query

Use this snippet to confirm that the order can proceed. Ensure `ok` is set to `True`.

```python
await app.answer_pre_checkout_query(query_id, ok=True)
```

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

### BotVerifierSettings Constructor

Source: https://docs.kurigram.icu/telegram/types/bot-verifier-settings

Represents settings for a verifier bot, including verification icon, company name, and optional custom description settings.

```APIDOC
## BotVerifierSettings

### Description
Info about the current verifier bot.

### Constructor
`BotVerifierSettings(icon: int, company: str, can_modify_custom_description: Optional[bool] = None, custom_description: Optional[str] = None)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **icon** (int 64-bit) - Required - Verification icon
- **company** (str) - Required - The name of the organization that provides the verification
- **can_modify_custom_description** (bool, optional) - Indicates whether the bot is allowed to set a custom description field for individual verified peers, different from the `custom_description` provided here.
- **custom_description** (str, optional) - An optional default description for the verification

### Request Example
```json
{
  "icon": 1234567890123456789,
  "company": "Example Corp",
  "can_modify_custom_description": true,
  "custom_description": "Verified by Example Corp"
}
```

### Response
This is a type definition and does not have a direct response example in terms of API calls. It's used to construct objects within the Pyrogram library.
```

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

### Install Kurigram Development Version

Source: https://docs.kurigram.icu/intro/install

Install the latest development version of Kurigram directly from the 'dev' branch on GitHub. Use --force-reinstall if you encounter issues.

```bash
pip install https://github.com/KurimuzonAkuma/kurigram/archive/dev.zip --force-reinstall
```

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

### Get Payment Form from Link

Source: https://docs.kurigram.icu/api/methods/get_payment_form

This snippet demonstrates how to get a payment form using a direct link to the invoice. The link should be a valid Telegram invoice URL.

```python
await app.get_payment_form(
    types.InputInvoiceName(
        name="https://t.me/$xvbzUtt5sUlJCAAATqZrWRy9Yzk"
    )
)
```

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

### Manual Handler Registration Example

Source: https://docs.kurigram.icu/topics/smart-plugins

Illustrates manual registration of message handlers in separate files. Requires explicit imports and `add_handler` calls.

```python
myproject/
    handlers.py
    main.py
```

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


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

```python
from pyrogram import Client, filters
from pyrogram.handlers import MessageHandler

from handlers import echo, echo_reversed

app = Client("my_account")

app.add_handler(
    MessageHandler(
        echo,
        filters.text & filters.private))

app.add_handler(
    MessageHandler(
        echo_reversed,
        filters.text & filters.private),
    group=1)

app.run()
```

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

### Summarize Message Example

Source: https://docs.kurigram.icu/api/methods/summarize_message

This example demonstrates how to use the `summarize_message` method to summarize a message and translate it to Russian with a neutral tone. Ensure you have the `chat_id` and `message_id` of the target message.

```python
await app.summarize_message(
    chat_id,
    message_id,
    translate_to_language_code="ru",
    tone="neutral"
)
```

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

### Shortcut for client.answer_pre_checkout_query

Source: https://docs.kurigram.icu/api/bound-methods/PreCheckoutQuery.answer

This code demonstrates the direct method call to answer a pre-checkout query. It is used when the bot is ready to proceed with the order.

```python
await client.answer_pre_checkout_query(
    pre_checkout_query.id,
    ok=True
)
```

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

### Install Kurigram with uv

Source: https://docs.kurigram.icu/intro/install

Use this command to add Kurigram as a development dependency using uv.

```bash
uv add --dev kurigram
```

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

### Use File Storage with Client

Source: https://docs.kurigram.icu/topics/storage-engines

Use file storage by passing a name to the Client constructor. A session file will be created on disk.

```python
from pyrogram import Client

async with Client("my_account") as app:
    print(await app.get_me())

```

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

### stories.StartLive

Source: https://docs.kurigram.icu/telegram/types/updates

Start a live story, optionally using RTMP livestream mode.

```APIDOC
## stories.StartLive

### Description
Start a live story, optionally using RTMP livestream mode.

### Method
POST

### Endpoint
/stories/startLive

### Parameters
#### Query Parameters
- **rtmp_mode** (boolean) - Optional - Whether to use RTMP livestream mode.
```

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

### Get Bot Name

Source: https://docs.kurigram.icu/api/methods/get_bot_name

Use this method to get the current or owned bot name for the given user language. If the current account is a User, this can only be called if the `for_my_bot` has `can_be_edited` property set to True.

```python
bot_name = await app.get_bot_name()

```

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

### Get Bot Default Privileges

Source: https://docs.kurigram.icu/api/methods/get_bot_default_privileges

Call this method to retrieve the bot's default privileges. By default, it fetches privileges for groups and supergroups. Pass `for_channels=True` to get privileges specifically for channels.

```python
privileges = await app.get_bot_default_privileges()
```

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

### stories.StartLive

Source: https://docs.kurigram.icu/telegram/types/updates-combined

Start a live story, optionally using RTMP livestream mode.

```APIDOC
## stories.StartLive

### Description
Start a live story, optionally using RTMP livestream mode.

### Method
Not specified, assumed to be a method call.

### Endpoint
Not specified.

### Parameters
None specified.

### Request Example
None specified.

### Response
None specified.
```

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

### Instantiating a Pyrogram Client

Source: https://docs.kurigram.icu/start/invoking

Creates a new Client instance for Pyrogram. 'my_account' serves as a session name; choose one that suits your needs.

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

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

### Get Upgraded Gift Value Info by Link or Slug

Source: https://docs.kurigram.icu/api/methods/get_upgraded_gift_value_info

Use this method to get the value information of an upgraded gift. You can provide either the full gift link or just the gift slug. This method is asynchronous.

```python
# Get information about upgraded gift value by link
gift = await client.get_upgraded_gift_value_info("https://t.me/nft/SignetRing-903")

# Get information about upgraded gift value by slug
gift = await client.get_upgraded_gift_value_info("SignetRing-903")
```

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

### Join Chat Examples

Source: https://docs.kurigram.icu/api/methods/join_chat

Demonstrates how to join a chat using different identifiers: invite link, username, and linked chat ID. Ensure you have the necessary permissions and that the chat is not private or secret.

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

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

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

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

### bots.AddPreviewMedia

Source: https://docs.kurigram.icu/telegram/base/bot-preview-media

Adds a main mini app preview. This function allows you to set up a preview for a main mini application.

```APIDOC
## bots.AddPreviewMedia

### Description
Add a main mini app preview.

### Method
Not specified (assumed to be a function call within an SDK)

### Endpoint
Not applicable (SDK function)

### Parameters
- **preview_media** (BotPreviewMedia) - Required - The media object for the preview.

### Request Example
```python
# Example usage (assuming 'bots' is an initialized object)
bots.AddPreviewMedia(preview_media=BotPreviewMedia(...))
```

### Response
- **Success Response**: Details of the operation (specifics not provided in source).

### Response Example
```json
{
  "example": "response body"
}
```
```

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

### StartScheduledGroupCall

Source: https://docs.kurigram.icu/telegram/functions/phone

Starts a scheduled group call.

```APIDOC
## StartScheduledGroupCall

### Description
Starts a scheduled group call.

### Method
Not specified (assumed to be a function call in an SDK context).

### Endpoint
Not specified.

### Parameters
None explicitly documented.

### Request Example
```json
{
  "function": "phone.startScheduledGroupCall"
}
```

### Response
Success response details not specified.
```

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

### bots.PreviewInfo

Source: https://docs.kurigram.icu/telegram/types/bots/preview-info

Contains info about Main Mini App previews. This is the constructor for PreviewInfo.

```APIDOC
## bots.PreviewInfo

### Description
Contains info about Main Mini App previews. See here » for more info.

### Constructor
`PreviewInfo(media: List[BotPreviewMedia], lang_codes: List[str])`

### Parameters
* **media** (List of `BotPreviewMedia`) - Required - All preview medias for the language code passed to bots.getPreviewInfo.
* **lang_codes** (List of `str`) - Required - All available language codes for which preview medias were uploaded (regardless of the language code passed to bots.getPreviewInfo).

### Details
* Layer: `227`
* ID: `CA71D64`

### Returned By
* `bots.GetPreviewInfo`
```

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

### Instantiate and Use Pyrogram Client

Source: https://docs.kurigram.icu/api/client

Instantiate the Client class and use it within a context manager to send a message. Ensure Pyrogram is installed and configured.

```python
from pyrogram import Client

app = Client("my_account")

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

```

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

### StartHistoryImport

Source: https://docs.kurigram.icu/telegram/functions/messages

Starts importing message history.

```APIDOC
## StartHistoryImport

### Description
Starts importing message history.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC
```

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

### Use uvloop before Client instantiation

Source: https://docs.kurigram.icu/topics/speedups

Place uvloop.install() before creating a Pyrogram Client instance to ensure the faster event loop is used from the start. TgCrypto is automatically utilized if present.

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

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

### GetToneExample

Source: https://docs.kurigram.icu/telegram/functions/aicompose

Retrieves an example of a specific tone.

```APIDOC
## aicompose.GetToneExample

### Description
Retrieves an example of a specific tone.

### Method
GET

### Endpoint
/aicompose/getToneExample

### Parameters
#### Query Parameters
- **tone_id** (string) - Required - The ID of the tone for which to get an example.

### Response
#### Success Response (200)
- **example** (string) - An example text demonstrating the tone.

#### Response Example
```json
{
  "example": "This is an example of formal communication."
}
```
```

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

### help.GetConfig

Source: https://docs.kurigram.icu/telegram/base/config

Retrieves the current API configuration, including data center details.

```APIDOC
## help.GetConfig

### Description
Returns current configuration, including data center configuration.

### Method
Not specified (assumed to be a function call within the SDK)

### Endpoint
Not applicable (SDK function)

### Parameters
None

### Request Example
```
# Example usage within the Pyrogram SDK
config = client.invoke(help.GetConfig())
```

### Response
#### Success Response
- **config** (Config) - The current API configuration object.
```

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

### stories.GetAlbumStories

Source: https://docs.kurigram.icu/telegram/base/stories/stories

Get stories in a story album.

```APIDOC
## stories.GetAlbumStories

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

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **stories** (stories.Stories) - List of stories

#### Response Example
None
```

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

### search_global()

Source: https://docs.kurigram.icu/api/methods/search_global

Search messages globally from all of your chats. If you want to get the messages count only, see `search_global_count()`.

Note: Due to server-side limitations, you can only get up to around ~10,000 messages and each message retrieved will not have any _reply_to_message_ field.

Usable by: Users, Bots

```APIDOC
## search_global()

### Description
Search messages globally from all of your chats.

### Method
`Client.search_global()`

### Parameters
#### Query Parameters
- **query** (`str`, _optional_) – Text query string. Use “@” to search for mentions.
- **filter** (`MessagesFilter`, _optional_) – Pass a filter in order to search for specific kind of messages only. Defaults to any message (no filter).
- **limit** (`int`, _optional_) – Limits the number of messages to be retrieved. By default, no limit is applied and all messages are returned.
- **channels_only** (`bool`, _optional_) – Pass True to search only in channels.
- **groups_only** (`bool`, _optional_) – Pass True to search only in groups.
- **users_only** (`bool`, _optional_) – Pass True to search only in users.

### Returns
`Generator` – A generator yielding `Message` objects.

### Example
```python
from pyrogram import enums

# Search for "pyrogram". Get the first 50 results
async for message in app.search_global("pyrogram", limit=50):
    print(message.text)

# Search for recent photos from Global. Get the first 20 results
async for message in app.search_global(filter=enums.MessagesFilter.PHOTO, limit=20):
    print(message.photo)
```
```
Tokens:
Raw