Telethon API

https://tl.telethon.dev/
Admin
Telethon API provides documentation and easy access to the Telegram API's methods, types, and...
Tokens:201,158
Snippets:1,508
Trust Score:7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Python example using client(functions.messages.SearchGlobalRequest(...))

Source: https://tl.telethon.dev/methods/messages/search_global.html

Example of calling SearchGlobalRequest with the Telethon client. Note that this method is only for users. The example sets all parameters, including optional flags. The result is printed with stringify().

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.SearchGlobalRequest(
        q=_'some string here'_,
        filter=types.InputMessagesFilterPhotos(),
        min_date=datetime.datetime(2018, 6, 25),
        max_date=datetime.datetime(2018, 6, 25),
        offset_rate=42,
        offset_peer=_'username'_,
        offset_id=42,
        limit=100,
        broadcasts_only=**True**,
        groups_only=**True**,
        users_only=**True**,
        folder_id=42,
        community=_'username'_
    ))
    print(result.stringify())
```

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

### Python example using DeletePreviewMediaRequest

Source: https://tl.telethon.dev/methods/bots/delete_preview_media.html

Example of calling the DeletePreviewMediaRequest with a TelegramClient, uploading a photo and passing it as media.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.bots.DeletePreviewMediaRequest(
        bot= _'username'_,
        lang_code=_'en'_,
        media=[types.InputMediaUploadedPhoto(
            file=client.upload_file(_'/path/to/file.jpg'_),
            spoiler=**True**,
            live_photo=**True**,
            stickers=[types.InputDocument(
                id=-12398745604826,
                access_hash=-12398745604826,
                file_reference=_b'arbitrary\x7f data \xfa here'_
            )],
            ttl_seconds=42,
            video=types.InputDocument(
                id=-12398745604826,
                access_hash=-12398745604826,
                file_reference=_b'arbitrary\x7f data \xfa here'_
            )
        )]
    ))
    print(result)
```

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

### Python example using telethon.sync

Source: https://tl.telethon.dev/methods/messages/search_stickers.html

Example of calling messages.SearchStickersRequest with the Telethon client, showing how to pass parameters and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.SearchStickersRequest(
        q= _'some string here'_,
        emoticon=_'some string here'_,
        lang_code=[_'en'_],
        offset=42,
        limit=100,
        hash=-12398745604826,
        emojis=**True**
    ))
    print(result.stringify())
```

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

### Python example using telethon.sync

Source: https://tl.telethon.dev/methods/channels/toggle_anti_spam.html

Example of calling channels.toggleAntiSpam with a TelegramClient, passing a channel and enabled flag, then printing the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.channels.ToggleAntiSpamRequest(
        channel= _'username'_,
        enabled=**False**
    ))
    print(result.stringify())
```

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

### Telethon example for CanPurchaseStoreRequest

Source: https://tl.telethon.dev/methods/payments/can_purchase_store.html

Python example using Telethon to call payments.canPurchaseStore with an InputStorePaymentPremiumSubscription. It prints the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.payments.CanPurchaseStoreRequest(
        purpose=types.InputStorePaymentPremiumSubscription(
            restore=**True**,
            upgrade=**True**
        )
    ))
    print(result)
```

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

### GetPasskeysRequest usage example

Source: https://tl.telethon.dev/methods/account/get_passkeys.html

Example showing how to invoke the GetPasskeysRequest using the Telethon client.

```python
from telethon.sync import TelegramClient
from telethon import functions, types

with TelegramClient(name, api_id, api_hash) as client:
    result = client(functions.account.GetPasskeysRequest())
    print(result.stringify())
```

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

### Python example using telethon.sync

Source: https://tl.telethon.dev/methods/phone/get_group_call_stars.html

Example of calling the GetGroupCallStarsRequest with Telethon, using the sync client and printing the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.phone.GetGroupCallStarsRequest(
        call=types.InputGroupCall(
            id=-12398745604826,
            access_hash=-12398745604826
        )
    ))
    print(result.stringify())
```

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

### Python example using Telethon

Source: https://tl.telethon.dev/methods/account/get_connected_bots.html

Example of calling account.getConnectedBots with Telethon. It prints the result using stringify().

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.account.GetConnectedBotsRequest())
    print(result.stringify())

```

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

### Python example using GetSavedMusicRequest

Source: https://tl.telethon.dev/methods/users/get_saved_music.html

Example of calling the GetSavedMusicRequest with Telethon, showing how to pass parameters and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.users.GetSavedMusicRequest(
        id= _'username'_,
        offset=42,
        limit=100,
        hash=-12398745604826
    ))
    print(result.stringify())
```

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

### Python example using Telethon

Source: https://tl.telethon.dev/methods/payments/get_suggested_star_ref_bots.html

Example of calling payments.getSuggestedStarRefBotsRequest with the Telethon client, showing how to set parameters and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.payments.GetSuggestedStarRefBotsRequest(
        peer= _'username'_,
        offset=_'some string here'_,
        limit=100,
        order_by_revenue=**True**,
        order_by_date=**True**
    ))
    print(result.stringify())
```

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

### Python example using GetJoinedCommunitiesRequest

Source: https://tl.telethon.dev/methods/communities/get_joined_communities.html

Example of calling the method with Telethon's synchronous client. It prints the stringified result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.communities.GetJoinedCommunitiesRequest())
    print(result.stringify())
```

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

### Get peer profile colors with GetPeerProfileColorsRequest

Source: https://tl.telethon.dev/methods/help/get_peer_profile_colors.html

Use this request to fetch the available peer profile colors. The TL schema defines the hash parameter, and the Python example uses the Telethon client with the GetPeerProfileColorsRequest method. Works for both users and bots.

```tl
---functions---
help.getPeerProfileColors#abcfa9fd hash:int = help.PeerColors
```

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.help.GetPeerProfileColorsRequest(
        hash=0
    ))
    print(result.stringify())
```

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

### ReportReadMetricsRequest usage example

Source: https://tl.telethon.dev/methods/messages/report_read_metrics.html

An example demonstrating how to use the ReportReadMetricsRequest with the Telethon client.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.ReportReadMetricsRequest(
        peer= _'username'_,
        metrics=[types.InputMessageReadMetric(
            msg_id=42,
            view_id=-12398745604826,
            time_in_view_ms=42,
            active_time_in_view_ms=42,
            height_to_viewport_ratio_permille=42,
            seen_range_ratio_permille=42
        )]
    ))
    print(result)
```

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

### Python example using ToggleAllPeerLinkRequestApprovalRequest

Source: https://tl.telethon.dev/methods/communities/toggle_all_peer_link_request_approval.html

Example usage of the ToggleAllPeerLinkRequestApprovalRequest with Telethon's synchronous client. It creates a client, calls the method with a community and reject flag, and prints the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.communities.ToggleAllPeerLinkRequestApprovalRequest(
        community= _'username'_,
        reject=**True**
    ))
    print(result)
```

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

### ToggleSlowModeRequest usage example

Source: https://tl.telethon.dev/methods/channels/toggle_slow_mode.html

An example showing how to use the ToggleSlowModeRequest within a TelegramClient session.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.channels.ToggleSlowModeRequest(
        channel= _'username'_,
        seconds=42
    ))
    print(result.stringify())
```

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

### Python example using GetStarGiftCollectionsRequest

Source: https://tl.telethon.dev/methods/payments/get_star_gift_collections.html

Example of using the Telethon client to call payments.getStarGiftCollections. It imports the necessary modules, creates a client, and prints the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.payments.GetStarGiftCollectionsRequest(
        peer= _'username'_,
        hash=-12398745604826
    ))
    print(result.stringify())
```

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

### Python example using UploadWallPaperRequest

Source: https://tl.telethon.dev/methods/account/upload_wall_paper.html

Example of uploading a wallpaper using Telethon's UploadWallPaperRequest, including file upload and WallPaperSettings.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.account.UploadWallPaperRequest(
        file=client.upload_file( _'/path/to/file.jpg'_),
        mime_type=_'some string here'_,
        settings=types.WallPaperSettings(
            blur=**True**,
            motion=**True**,
            background_color=42,
            second_background_color=42,
            third_background_color=42,
            fourth_background_color=42,
            intensity=42,
            rotation=42,
            emoticon=_'some string here'_
        ),
        for_chat=**True**
    ))
    print(result.stringify())
```

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

### Python example using GetFutureChatCreatorAfterLeaveRequest

Source: https://tl.telethon.dev/methods/messages/get_future_chat_creator_after_leave.html

Example of calling the method with Telethon's synchronous client. The peer parameter accepts entity-like values such as usernames. The result is a User or UserEmpty object, and the example prints it with stringify().

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.GetFutureChatCreatorAfterLeaveRequest(
        peer= _'username'_
    ))
    print(result.stringify())

```

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

### Python example using GetEmojiProfilePhotoGroupsRequest

Source: https://tl.telethon.dev/methods/messages/get_emoji_profile_photo_groups.html

Example of calling the method with Telethon's synchronous client. It passes hash=0 and prints the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.GetEmojiProfilePhotoGroupsRequest(
        hash=0
    ))
    print(result.stringify())
```

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

### Python example using GetSavedMusicByIDRequest

Source: https://tl.telethon.dev/methods/users/get_saved_music_by_id.html

Example of calling the method with a synchronous client. It passes a username as the id and a list containing one InputDocument. The result is printed using stringify().

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.users.GetSavedMusicByIDRequest(
        id= _'username'_,
        documents=[types.InputDocument(
            id=-12398745604826,
            access_hash=-12398745604826,
            file_reference=_b'arbitrary\x7f data \xfa here'_
        )]
    ))
    print(result.stringify())
```

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

### GetUsersRequest usage example

Source: https://tl.telethon.dev/methods/users/get_users.html

Example showing how to use GetUsersRequest with the TelegramClient to fetch user details.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.users.GetUsersRequest(
        id=[_'username'_]
    ))
    **for** x **in** result:
        print(x)
```

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

### UpdateEmojiStatusRequest example

Source: https://tl.telethon.dev/methods/channels/update_emoji_status.html

Example usage of the UpdateEmojiStatusRequest in Telethon, showing how to call it with a channel and an EmojiStatus object.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.channels.UpdateEmojiStatusRequest(
        channel= _'username'_,
        emoji_status=types.EmojiStatus(
            document_id=-12398745604826,
            until=datetime.datetime(2018, 6, 25)
        )
    ))
    print(result.stringify())
```

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

### Python example using GetFullUserRequest

Source: https://tl.telethon.dev/methods/users/get_full_user.html

Example of calling GetFullUserRequest with a username, printing the result. Requires a TelegramClient with name, api_id, and api_hash.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.users.GetFullUserRequest(
        id= _'username'_
    ))
    print(result.stringify())
```

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

### Telethon example for GetStarsTransactionsRequest

Source: https://tl.telethon.dev/methods/payments/get_stars_transactions.html

Example usage of the Telethon client to call payments.getStarsTransactions with all parameters and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.payments.GetStarsTransactionsRequest(
        peer= _'username'_,
        offset=_'some string here'_,
        limit=100,
        inbound=**True**,
        outbound=**True**,
        ascending=**True**,
        ton=**True**,
        subscription_id=_'some string here'_
    ))
    print(result.stringify())
```

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

### Python example using Telethon

Source: https://tl.telethon.dev/methods/channels/create_channel.html

Example of calling channels.createChannel with the Telethon client, including setting optional flags and geo_point. The result is printed using stringify().

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.channels.CreateChannelRequest(
        title= _'My awesome title'_,
        about=_'some string here'_,
        megagroup=**True**,
        for_import=**True**,
        forum=**True**,
        geo_point=types.InputGeoPoint(
            lat=7.13,
            long=7.13,
            accuracy_radius=42
        ),
        address=_'some string here'_,
        ttl_period=42
    ))
    print(result.stringify())
```

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

### Python example using ToggleUserEmojiStatusPermissionRequest

Source: https://tl.telethon.dev/methods/bots/toggle_user_emoji_status_permission.html

Example usage of the ToggleUserEmojiStatusPermissionRequest in a Telethon client, toggling the permission for a user.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.bots.ToggleUserEmojiStatusPermissionRequest(
        bot= _'username'_,
        enabled=**False**
    ))
    print(result)
```

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

### Python example using GetRecentLocationsRequest

Source: https://tl.telethon.dev/methods/messages/get_recent_locations.html

Example of calling the GetRecentLocationsRequest with a peer, limit, and hash, then printing the result. Only users can use this request.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.GetRecentLocationsRequest(
        peer= _'username'_,
        limit=100,
        hash=-12398745604826
    ))
    print(result.stringify())
```

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

### Telethon example for ResetLoginEmailRequest

Source: https://tl.telethon.dev/methods/auth/reset_login_email.html

Example usage of the ResetLoginEmailRequest with Telethon, showing how to call the method and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.auth.ResetLoginEmailRequest(
        phone_number= _'some string here'_,
        phone_code_hash=_'some string here'_ 
    ))
    print(result.stringify())

```

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

### SendMultiMediaRequest example with full parameters

Source: https://tl.telethon.dev/methods/messages/send_multi_media.html

Use this low-level example when you need more control over the parameters than client.send_file() provides. It constructs a SendMultiMediaRequest with a single InputSingleMedia, including an uploaded photo with stickers, video, reply-to, scheduling, and other options. The example imports telethon.sync, functions, and types, and prints the result with result.stringify().

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.messages.SendMultiMediaRequest(
        peer=_'username'_,
        multi_media=[types.InputSingleMedia(
            media=types.InputMediaUploadedPhoto(
                file=client.upload_file(_'/path/to/file.jpg'_),
                spoiler=**True**,
                live_photo=**True**,
                stickers=[types.InputDocument(
                    id=-12398745604826,
                    access_hash=-12398745604826,
                    file_reference=_b'arbitrary\x7f data \xfa here'_
                )],
                ttl_seconds=42,
                video=types.InputDocument(
                    id=-12398745604826,
                    access_hash=-12398745604826,
                    file_reference=_b'arbitrary\x7f data \xfa here'_
                )
            ),
            message=_'Hello there!_'_
        )],
        noforwards=**True**,
        update_stickersets_order=**True**,
        invert_media=**True**,
        allow_paid_floodskip=**True**,
        reply_to=types.InputReplyToMessage(
            reply_to_msg_id=42,
            top_msg_id=42,
            reply_to_peer_id=_'username'_,
            quote_text=_'some string here'_,
            quote_entities=[types.MessageEntityUnknown(
                offset=42,
                length=42
            )],
            quote_offset=42,
            monoforum_peer_id=_'username'_,
            todo_item_id=42,
            poll_option=_b'arbitrary\x7f data \xfa here'_
        ),
        schedule_date=datetime.datetime(2018, 6, 25),
        send_as=_'username'_,
        quick_reply_shortcut=types.InputQuickReplyShortcut(
            shortcut=_'some string here'_
        ),
        effect=-12398745604826,
        allow_paid_stars=-12398745604826
    ))
    print(result.stringify())
```

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

### Telethon example for account.resetPassword

Source: https://tl.telethon.dev/methods/account/reset_password.html

Python example using Telethon to call the account.resetPassword method and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.account.ResetPasswordRequest())
    print(result.stringify())
```

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

### ChannelFull Constructor

Source: https://tl.telethon.dev/constructors/channel_full.html

Initializes a ChannelFull object with optional parameters. All parameters are optional and default to None unless specified otherwise.

```APIDOC
## ChannelFull Constructor

### Description
Initializes a ChannelFull object with optional parameters. All parameters are optional and default to None unless specified otherwise.

### Parameters
All parameters are optional and default to `None` unless otherwise noted.

- **exported_invite** (ExportedChatInvite) - Optional - This argument defaults to `None` and can be omitted.
- **migrated_from_chat_id** (long) - Optional - This argument defaults to `None` and can be omitted.
- **migrated_from_max_id** (int) - Optional - This argument defaults to `None` and can be omitted.
- **pinned_msg_id** (int) - Optional - This argument defaults to `None` and can be omitted.
- **stickerset** (StickerSet) - Optional - This argument defaults to `None` and can be omitted.
- **available_min_id** (int) - Optional - This argument defaults to `None` and can be omitted.
- **folder_id** (int) - Optional - This argument defaults to `None` and can be omitted.
- **linked_chat_id** (long) - Optional - This argument defaults to `None` and can be omitted.
- **location** (ChannelLocation) - Optional - This argument defaults to `None` and can be omitted.
- **slowmode_seconds** (int) - Optional - This argument defaults to `None` and can be omitted.
- **slowmode_next_send_date** (date) - Optional - This argument defaults to `None` and can be omitted.
- **stats_dc** (int) - Optional - This argument defaults to `None` and can be omitted.
- **call** (InputGroupCall) - Optional - This argument defaults to `None` and can be omitted.
- **ttl_period** (int) - Optional - This argument defaults to `None` and can be omitted.
- **pending_suggestions** (string) - Optional - This argument defaults to `None` and can be omitted. Otherwise, a list must be supplied.
- **groupcall_default_join_as** (Peer) - Optional - This argument defaults to `None` and can be omitted.
- **theme_emoticon** (string) - Optional - This argument defaults to `None` and can be omitted.
- **requests_pending** (int) - Optional - This argument defaults to `None` and can be omitted.
- **recent_requesters** (long) - Optional - This argument defaults to `None` and can be omitted. Otherwise, a list must be supplied.
- **default_send_as** (Peer) - Optional - This argument defaults to `None` and can be omitted.
- **available_reactions** (ChatReactions) - Optional - This argument defaults to `None` and can be omitted.
- **reactions_limit** (int) - Optional - This argument defaults to `None` and can be omitted.
- **stories** (PeerStories) - Optional - This argument defaults to `None` and can be omitted.
- **wallpaper** (WallPaper) - Optional - This argument defaults to `None` and can be omitted.
- **boosts_applied** (int) - Optional - This argument defaults to `None` and can be omitted.
- **boosts_unrestrict** (int) - Optional - This argument defaults to `None` and can be omitted.
- **emojiset** (StickerSet) - Optional - This argument defaults to `None` and can be omitted.
- **bot_verification** (BotVerification) - Optional - This argument defaults to `None` and can be omitted.
- **stargifts_count** (int) - Optional - This argument defaults to `None` and can be omitted.
- **send_paid_messages_stars** (long) - Optional - This argument defaults to `None` and can be omitted.
- **main_tab** (ProfileTab) - Optional - This argument defaults to `None` and can be omitted.
- **guard_bot_id** (long) - Optional - This argument defaults to `None` and can be omitted.

### Usage
This constructor is used to create a ChannelFull object. All parameters are optional and can be omitted.
```

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

### Python example using GetDefaultEmojiStatusesRequest

Source: https://tl.telethon.dev/methods/account/get_default_emoji_statuses.html

Example of calling the account.getDefaultEmojiStatuses method using the Telethon sync client. It imports the necessary modules, creates a client, and prints the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.account.GetDefaultEmojiStatusesRequest(
        hash=-12398745604826
    ))
    print(result.stringify())

```

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

### Telethon example for GetDifferenceRequest

Source: https://tl.telethon.dev/methods/updates/get_difference.html

Example usage of the GetDifferenceRequest in Telethon, showing how to call the method with all parameters and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.updates.GetDifferenceRequest(
        pts=42,
        date=datetime.datetime(2018, 6, 25),
        qts=42,
        pts_limit=42,
        pts_total_limit=42,
        qts_limit=42
    ))
    print(result.stringify())
```

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

### account.createTheme

Source: https://tl.telethon.dev/methods/account/create_theme.html

Creates a new theme with the specified slug, title, optional document, and settings. Returns a Theme object.

```APIDOC
## account.createTheme

### Description
Creates a new theme with the specified slug, title, optional document, and settings. Returns a Theme object.

### Method
createTheme

### Endpoint
account.createTheme

### Parameters
- **slug** (string) - Required - The slug for the theme.
- **title** (string) - Required - The title of the theme.
- **document** (InputDocument) - Optional - The document to use as the theme. Defaults to `None`.
- **settings** (InputThemeSettings) - Optional - A list of theme settings. Defaults to `None`.

### Request Example
```python
from telethon.sync import TelegramClient
from telethon import functions, types

with TelegramClient(name, api_id, api_hash) as client:
    result = client(functions.account.CreateThemeRequest(
        slug='some string here',
        title='My awesome title',
        document=types.InputDocument(
            id=-12398745604826,
            access_hash=-12398745604826,
            file_reference=b'arbitrary\x7f data \xfa here'
        ),
        settings=[types.InputThemeSettings(
            base_theme=types.BaseThemeClassic(),
            accent_color=42,
            message_colors_animated=True,
            outbox_accent_color=42,
            message_colors=[42],
            wallpaper=types.InputWallPaper(
                id=-12398745604826,
                access_hash=-12398745604826
            ),
            wallpaper_settings=types.WallPaperSettings(
                blur=True,
                motion=True,
                background_color=42,
                second_background_color=42,
                third_background_color=42,
                fourth_background_color=42,
                intensity=42,
                rotation=42,
                emoticon='some string here'
            )
        )]
    ))
    print(result.stringify())
```

### Response
#### Success Response
Returns a `Theme` object.

#### Response Example
```
Theme
```

### Known RPC Errors
- `ThemeMimeInvalidError` - You cannot create this theme, the mime-type is invalid.
```

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

### Python example using SaveAutoSaveSettingsRequest

Source: https://tl.telethon.dev/methods/account/save_auto_save_settings.html

Example of calling the account.saveAutoSaveSettings method with Telethon. It imports the necessary modules, creates a client, and sends the request with auto-save settings for photos, videos, and a maximum video size. The result is printed.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.account.SaveAutoSaveSettingsRequest(
        settings=types.AutoSaveSettings(
            photos=**True**,
            videos=**True**,
            video_max_size=-12398745604826
        ),
        users=**True**,
        chats=**True**,
        broadcasts=**True**,
        peer= _'username'_
    ))
    print(result)
```

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

### Python example using AnswerWebhookJSONQueryRequest

Source: https://tl.telethon.dev/methods/bots/answer_webhook_json_query.html

Example of using the AnswerWebhookJSONQueryRequest with Telethon. It creates a client, calls the method with a query_id and DataJSON data, and prints the result. Only bots can use this request.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.bots.AnswerWebhookJSONQueryRequest(
        query_id=-12398745604826,
        data=types.DataJSON(
            data= _'some string here'_
        )
    ))
    print(result)
```

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

### AiComposeToneExample

Source: https://tl.telethon.dev/constructors/ai_compose_tone_example.html

Documentation for the AiComposeToneExample type, part of the AiComposeToneExample API.

```APIDOC
## AiComposeToneExample

### Description
Represents an example of a tone conversion in AI compose, containing the original text and the converted text.

### Members
- **from_** (TextWithEntities) - The source text with entities.
- **to** (TextWithEntities) - The resulting text with entities.

```

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

### Telethon example for GetGroupCallJoinAsRequest

Source: https://tl.telethon.dev/methods/phone/get_group_call_join_as.html

Python example using Telethon to call GetGroupCallJoinAsRequest with a peer parameter and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.phone.GetGroupCallJoinAsRequest(
        peer= _'username'_
    ))
    print(result.stringify())
```

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

### Python example using TelegramClient and GetDefaultBackgroundEmojisRequest

Source: https://tl.telethon.dev/methods/account/get_default_background_emojis.html

Example of calling the account.getDefaultBackgroundEmojis method with Telethon, passing a hash value and printing the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.account.GetDefaultBackgroundEmojisRequest(
        hash=-12398745604826
    ))
    print(result.stringify())
```

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

### Python example using GetUniqueStarGiftRequest

Source: https://tl.telethon.dev/methods/payments/get_unique_star_gift.html

Example usage of the GetUniqueStarGiftRequest in Telethon, demonstrating how to call the method and print the result.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.payments.GetUniqueStarGiftRequest(
        slug= _'some string here'_
    ))
    print(result.stringify())
```

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

### Python example using GetFutureSaltsRequest

Source: https://tl.telethon.dev/methods/get_future_salts.html

Example of calling GetFutureSaltsRequest with num=42 using Telethon's synchronous client.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.GetFutureSaltsRequest(
        num=42
    ))
    print(result.stringify())
```

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

### InitConnectionRequest

Source: https://tl.telethon.dev/methods/index.html

Request to initialize a connection.

```APIDOC
## InitConnectionRequest

### Description
Request to initialize a connection.

### Method
Not specified

### Endpoint
Not specified

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Python example using ToggleViewForumAsMessagesRequest

Source: https://tl.telethon.dev/methods/channels/toggle_view_forum_as_messages.html

Example of calling the ToggleViewForumAsMessagesRequest method with Telethon, toggling the forum-as-messages view for a channel.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.channels.ToggleViewForumAsMessagesRequest(
        channel= _'username'_,
        enabled=**False**
    ))
    print(result.stringify())
```

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

### Python example using SuggestBirthdayRequest

Source: https://tl.telethon.dev/methods/users/suggest_birthday.html

Example of calling the SuggestBirthdayRequest with Telethon. It imports the necessary modules, creates a client, and sends the request with an id and a Birthday object.

```python
**from** telethon.sync **import** TelegramClient
**from** telethon **import** functions, types

**with** TelegramClient(name, api_id, api_hash) **as** client:
    result = client(functions.users.SuggestBirthdayRequest(
        id= _'username'_,
        birthday=types.Birthday(
            day=42,
            month=42,
            year=42
        )
    ))
    print(result.stringify())
```
Tokens:
Raw