Client Reference

The Client class is the primary interface for connecting to Shad Messenger and managing events.

class aioshad.Client(session: str | Session = 'shad', phone_number: str | None = None, session_directory: str = '.', dispatcher: Dispatcher | None = None, messenger_host: str | None = None, proxy: str | None = None, timeout: float = 30.0)

Bases: object

High-performance asynchronous client for Shad Messenger. Supports both Telethon/Pyrogram-style decorator @client.on_message and Aiogram-style Dispatcher & Routers with FSM and Middlewares.

async add_group_members(group_guid: str, member_guids: List[str]) → Dict[str, Any]

async connect() → None

Connects to Shad servers and verifies or performs authentication.

conversation(chat_guid: str, timeout: float | None = None) → Any

Starts an interactive conversation session with a chat.

async create_group(title: str, member_guids: List[str] | None = None) → Dict[str, Any]

async create_voice_chat(chat_guid: str) → Dict[str, Any]

async delete_group_member(group_guid: str, member_guid: str) → Dict[str, Any]

async delete_message(object_guid: str, message_id: str | int, delete_type: str = 'Global') → Dict[str, Any]

async delete_messages(object_guid: str, message_ids: str | int | List[str | int], delete_type: str = 'Global') → Dict[str, Any]

async discard_voice_chat(chat_guid: str, voice_chat_id: str | None = None) → Dict[str, Any]

async download_file(file_inline_or_url: str | Dict[str, Any], destination: str | Path | None = None) → bytes

async edit_message(object_guid: str, message_id: str, text: str) → Message

async forward_messages(from_object_guid: str, to_object_guid: str, message_ids: str | int | List[str | int]) → Dict[str, Any]

async get_chat_history(object_guid: str, limit: int = 50, max_id: str | None = None, min_id: str | None = None, sort: str = 'FromMax') → List[Message]

async get_chat_info(object_guid: str) → Chat

async get_chat_info_by_username(username: str) → Chat

async get_chats(start_id: str | None = None) → Dict[str, Any]

async get_messages(object_guid: str, limit: int = 50, sort: str = 'FromMax', max_id: str | None = None, min_id: str | None = None) → Dict[str, Any]

async get_user_info(user_guid: str | None = None) → User

async get_voice_chat_participants(chat_guid: str, voice_chat_id: str | None = None) → Dict[str, Any]

async idle() → None

Waits asynchronously while client polling is active.

async join_chat_by_link(link: str) → Dict[str, Any]

async join_voice_chat(chat_guid: str, voice_chat_id: str | None = None, sdp_offer_data: str = '') → Dict[str, Any]

async leave_chat(object_guid: str) → Dict[str, Any]

async leave_voice_chat(chat_guid: str, voice_chat_id: str | None = None) → Dict[str, Any]

property me: str | None

Returns the user GUID of the logged in account.

property methods: Methods

on_message(*filters: Any) → Callable[[Any], Any]

Decorator to register a message handler.

on_message_edited(*filters: Any) → Callable[[Any], Any]

Decorator to register a message edited handler.

run() → None

Synchronously runs the client start coroutine.

async send_file(object_guid: str, file: str | bytes | Path, file_name: str | None = None, mime: str | None = None, caption: str | None = None, reply_to_message_id: str | None = None) → Message

async send_message(object_guid: str, text: str | None = None, reply_to_message_id: str | None = None, file_inline: Dict[str, Any] | None = None) → Message

async send_photo(object_guid: str, photo: str | bytes | Path, caption: str | None = None, reply_to_message_id: str | None = None, file_name: str | None = None) → Message

async send_voice(object_guid: str, voice: str | bytes | Path, caption: str | None = None, duration: int | None = None, reply_to_message_id: str | None = None) → Message

async set_voice_chat_state(chat_guid: str, voice_chat_id: str, activity: str = 'Speaking', participant_object_guid: str | None = None) → Dict[str, Any]

async start() → None

Connects and starts the long-polling event loop.

async stop() → None

Gracefully halts the client, stops polling, and closes connections.

property transport: Transport

async update_profile(first_name: str | None = None, last_name: str | None = None, bio: str | None = None) → bool

async upload_file(file: str | bytes | Path, file_name: str | None = None, mime: str | None = None, chunk_size: int = 131072) → Dict[str, Any]