Types⚓︎

Bases: BoundToBot, DataClassDictMixin

Event type: a new participant was added to a chat.

This object is received in the handler when a user is added to a personal chat, group chat, channel, or conference chat.

Attributes:

Examples:

from trueconf.types import AddedChatParticipant

@<router>.added_chat_participant()
async def on_added(event: AddedChatParticipant):
    print(event.user_id)

added_by = field(metadata={'alias': 'addedBy'})

chat_id = field(metadata={'alias': 'chatId'})

timestamp

user_id = field(metadata={'alias': 'userId'})

Bases: BoundToBot, DataClassDictMixin

Event type: a participant's role was changed in a chat.

This object is received in the handler when a participant's role is changed in a personal chat, group chat, channel, or conference chat.

Attributes:

from trueconf.types import ChangedParticipantRole

@router.changed_chat_participant_role()
async def on_role_changed(event: ChangedParticipantRole):
    print(f"User {event.user_id} now has role {event.role} in chat {event.chat_id}")

chat_id = field(metadata={'alias': 'chatId'})

role

timestamp

user_id = field(metadata={'alias': 'userId'})

Bases: BoundToBot, DataClassDictMixin

Event type: a new channel chat was created.

This object is received in the handler when a channel is created in TrueConf.

Attributes:

Examples:

from trueconf.types import CreatedChannel

@<router>.created_channel()
async def on_created(event: CreatedChannel):
    print(f"Channel {event.title} created with id {event.chat_id}")

chat_id = field(metadata={'alias': 'chatId'})

chat_type = field(metadata={'alias': 'chatType'})

last_message = field(metadata={'alias': 'lastMessage'})

title

unread_messages = field(metadata={'alias': 'unreadMessages'})

Bases: BoundToBot, DataClassDictMixin

Event type: a new group chat was created.

This object is received in the handler when a group chat is created in TrueConf.

Attributes:

Examples:

from trueconf.types import CreatedGroupChat

@<router>.created_group_chat()
async def on_created(event: CreatedGroupChat):
    print(f"Group chat {event.title} created with id {event.chat_id}")

chat_id = field(metadata={'alias': 'chatId'})

chat_type = field(metadata={'alias': 'chatType'})

last_message = field(metadata={'alias': 'lastMessage'})

title

unread_messages = field(metadata={'alias': 'unreadMessages'})

Bases: BoundToBot, DataClassDictMixin

Event type: a new personal chat was created.

This object is received in the handler when a personal chat is created in TrueConf.

Attributes:

Examples:

from trueconf.types import CreatedPersonalChat

@<router>.created_personal_chat()
async def on_created(event: CreatedPersonalChat):
    print(f"Personal chat created with id {event.chat_id}")

chat_id = field(metadata={'alias': 'chatId'})

chat_type = field(metadata={'alias': 'chatType'})

last_message = field(metadata={'alias': 'lastMessage'})

title

unread_messages = field(metadata={'alias': 'unreadMessages'})

Bases: BoundToBot, DataClassDictMixin

Event type: a message was edited.

This object is received in the handler when a previously sent message is edited in a chat.

Attributes:

Examples:

from trueconf.types import EditedMessage

@<router>.edited_message()
async def on_edited(event: EditedMessage):
    print(f"Message in chat {event.chat_id} was edited: {event.content.text}")

chat_id = field(metadata={'alias': 'chatId'})

content

timestamp

Bases: ABC

Base abstract class representing uploadable files.

This class defines a common interface for all file types that can be uploaded to the TrueConf Server. It should not be used directly. Instead, use one of its subclasses:

• BufferedInputFile — for in-memory byte data
• FSInputFile — for files from the local filesystem
• URLInputFile — for downloading files from a URL

Each subclass implements the read() and clone() methods required for asynchronous uploads and reusability of the same file object.

Parameters:

file = FSInputFile("example.pdf")
await bot.send_document(chat_id="...", file=file)

file_size = file_size

filename = filename

mimetype = mimetype

clone()

read()

Bases: InputFile

Represents a file uploaded from a bytes buffer.

This class is useful when the file is already available as a bytes object, for example, if it was retrieved from a database, memory, or downloaded from an external source. Automatically detects MIME type and file size if not provided.

file = BufferedInputFile(file=data_bytes, filename="example.txt")
await bot.send_document(chat_id="...", file=file)

Initializes a file from a bytes buffer.

Parameters:

data = file

file_size = file_size

filename = filename

mimetype = mimetype

clone()

from_file(path, filename=None, file_size=None, mimetype=None)

read()

Bases: InputFile

Represents a file uploaded from the local filesystem.

Used for uploading documents, images, or any other files directly from disk. Automatically detects the file name, size, and MIME type when not explicitly provided.

file = FSInputFile("path/to/file.zip")
await bot.send_document(chat_id="...", file=file)

Initializes an FSInputFile instance from a local file.

If not provided, filename, file_size, and mimetype are automatically detected:

• filename is extracted from the file path.
• file_size is determined via os.path.getsize().
• mimetype is detected from the first 2048 bytes of the file content (using python-magic if available).

Parameters:

file_size = file_size

filename = filename

mimetype = mimetype

path = path

clone()

read()

Bases: InputFile

Represents a file to be downloaded and uploaded from a remote URL.

Used for uploading files from external sources (e.g., public file links, APIs). Automatically handles MIME type detection and file size parsing from HTTP headers.

file = URLInputFile("https://example.com/file.pdf")
await bot.send_document(chat_id="...", file=file)

Initializes a URLInputFile instance from a remote URL.

Parameters:

file_size = file_size

filename = filename

headers = headers

mimetype = mimetype

timeout = timeout

url = url

clone()

prepare()

read()

Bases: BoundToBot, DataClassDictMixin

Represents a single chat message within TrueConf Chatbot Connector.

The Message object is automatically created for each incoming update and contains metadata (author, chat, timestamp, type) along with the actual message content. It also provides helper properties and shortcut methods to interact with the message (e.g., replying, forwarding, deleting, sending media files).

Attributes:

Methods:

author

box

chat_id = field(metadata={'alias': 'chatId'})

content

content_type

document

from_user

is_edited = field(metadata={'alias': 'isEdited'})

message_id = field(metadata={'alias': 'messageId'})

photo

reply_message_id = field(default=None, metadata={'alias': 'replyMessageId'})

sticker

text

timestamp

type

video

answer(text, parse_mode=HTML)

>>> @<router>.message()
>>> async def on_message(message:Message):
>>>     await message.answer("Hi, there!")

>>> @<router>.message()
>>> async def on_message(message:Message):
>>>     await message.answer("Hi, **there!**", parse_mode=ParseMode.MARKDOWN)

answer_document(file_path)

>>> @<router>.message()
>>> async def on_message(message:Message):
>>>     await message.answer_sticker(file_path='/path/to/file.webp')

answer_photo(file_path, preview_path)

>>> @<router>.message()
>>> async def on_message(message:Message):
>>>     await message.answer_photo(file_path='/path/to/file.jpg', preview_path='/path/to/preview.jpg')

answer_sticker(file_path)

>>> @<router>.message()
>>> async def on_message(message:Message):
>>>     await message.answer_sticker(file_path='/path/to/file.webp')

copy_to(chat_id)

delete(for_all=False)

forward(chat_id)

reply(text, parse_mode=HTML)

save_to_favorites(copy=False)

@router.message()
async def on_message(msg: Message):
    await msg.save_to_favorites()           # forwards message
    await msg.save_to_favorites(copy=True)  # copies if possible

Bases: BoundToBot, DataClassDictMixin

Event type: a chat was removed.

This object is received in the handler when a private, group, channel, or conference chat is deleted.

Attributes:

Examples:

from trueconf.types import RemovedChat

@<router>.removed_chat()
async def on_removed(event: RemovedChat):
    print(f"Chat removed: {event.chat_id}")

chat_id = field(metadata={'alias': 'chatId'})

Bases: BoundToBot, DataClassDictMixin

Event type: a participant was removed from a chat.

This object is received in the handler when a user is removed from a group, channel, or conference chat.

Attributes:

Examples:

from trueconf.types import RemovedChatParticipant

@<router>.removed_chat_participant()
async def on_removed(event: RemovedChatParticipant):
    print(event.user_id)

chat_id = field(metadata={'alias': 'chatId'})

removed_by = field(metadata={'alias': 'removedBy'})

timestamp

user_id = field(metadata={'alias': 'userId'})

Bases: BoundToBot, DataClassDictMixin

Event type: a message was removed.

This object is received in the handler when a message is deleted from a chat.

Attributes:

Examples:

from trueconf.types import RemovedMessage

@<router>.removed_message()
async def on_removed(event: RemovedMessage):
    print(f"Message {event.message_id} removed from chat {event.chat_id}")

chat_id = field(metadata={'alias': 'chatId'})

message_id = field(metadata={'alias': 'messageId'})

removed_by = field(metadata={'alias': 'removedBy'})

Bases: BoundToBot, DataClassDictMixin

id

method

payload

type

Bases: BoundToBot, DataClassDictMixin

Event type: file upload progress.

This object is received in the handler when a file is being uploaded and the upload progress is updated.

Attributes:

Examples:

from trueconf.types import UploadingProgress

@<router>.uploading_progress()
async def on_progress(event: UploadingProgress):
    print(f"File {event.file_id}: uploaded {event.progress} bytes")

file_id = field(metadata={'alias': 'fileId'})

progress