Types⚓︎
You can import all types at once:
trueconf.types.AddedChatParticipant dataclass ⚓︎
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.
Notes
This class is used as the event type in handler functions decorated with @<router>.added_chat_participant().
Attributes:
| Name | Type | Description |
|---|---|---|
timestamp | int | Unix timestamp (milliseconds) of when the event occurred. |
chat_id | str | Unique identifier of the chat where the participant was added. |
user_id | str | TrueConf ID of the participant who was added. |
added_by | EnvelopeAuthor | Information about the user who added the participant. |
Examples:
from trueconf.types import AddedChatParticipant
@<router>.added_chat_participant()
async def on_added(event: AddedChatParticipant):
print(event.user_id)
trueconf.types.ChangedParticipantRole dataclass ⚓︎
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.
Notes
This class is used as the event type in handler functions decorated with @<router>.changed_chat_participant_role().
Attributes:
| Name | Type | Description |
|---|---|---|
timestamp | int | Unix timestamp (in milliseconds) when the role change occurred. |
role | str | New role assigned to the participant. |
chat_id | str | Identifier of the chat where the role change occurred. |
user_id | str | TrueConf ID of the participant whose role was changed. |
Example
trueconf.types.CreatedChannel dataclass ⚓︎
Event type: a new channel chat was created.
This object is received in the handler when a channel is created in TrueConf.
Notes
This class is used as the event type in handler functions decorated with @<router>.created_channel().
Attributes:
| Name | Type | Description |
|---|---|---|
chat_id | str | Unique identifier of the created channel. |
title | str | Title of the channel. |
chat_type | ChatType | Type of the chat (should be |
last_message | LastMessage | None | The last message in the channel, if available. |
unread_messages | int | Number of unread messages in the channel. |
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}")
trueconf.types.CreatedGroupChat dataclass ⚓︎
Event type: a new group chat was created.
This object is received in the handler when a group chat is created in TrueConf.
Notes
This class is used as the event type in handler functions decorated with @<router>.created_group_chat().
Attributes:
| Name | Type | Description |
|---|---|---|
chat_id | str | Unique identifier of the group chat. |
title | str | Title of the group chat. |
chat_type | ChatType | Type of the chat (should be |
last_message | LastMessage | None | The last message in the chat, if available. |
unread_messages | int | Number of unread messages in the group chat. |
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}")
trueconf.types.CreatedPersonalChat dataclass ⚓︎
Event type: a new personal chat was created.
This object is received in the handler when a personal chat is created in TrueConf.
Notes
This class is used as the event type in handler functions decorated with @<router>.created_personal_chat().
Attributes:
| Name | Type | Description |
|---|---|---|
chat_id | str | Unique identifier of the personal chat. |
title | str | Title of the chat (usually the participant’s name). |
chat_type | ChatType | Type of the chat (should be |
last_message | LastMessage | None | The last message in the chat, if available. |
unread_messages | int | Number of unread messages in the personal chat. |
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}")
trueconf.types.EditedMessage dataclass ⚓︎
Event type: a message was edited.
This object is received in the handler when a previously sent message is edited in a chat.
Notes
This class is used as the event type in handler functions decorated with @<router>.edited_message().
Attributes:
| Name | Type | Description |
|---|---|---|
timestamp | int | Unix timestamp (milliseconds) of when the edit occurred. |
content | TextContent | The updated content of the edited message. |
chat_id | str | Unique identifier of the chat where the message was edited. |
Examples:
trueconf.types.InputFile ⚓︎
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 dataFSInputFile— for files from the local filesystemURLInputFile— 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:
| Name | Type | Description | Default |
|---|---|---|---|
file_name | str | Name of the file to display when sending. | None |
file_size | int | None | File size in bytes (optional). | None |
mime_type | str | None | MIME type of the file. Can be detected automatically. | None |
Abstract Methods
read(): Asynchronously reads the file content. clone(): Creates a new copy of the file object. Useful for reuse (e.g., preview uploads).
extension instance-attribute ⚓︎
trueconf.types.BufferedInputFile ⚓︎
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.
Example
Note
Use BufferedInputFile.from_file(...) for convenient file loading from disk.
Initializes a file from a bytes buffer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | bytes | Raw file content in bytes. | required |
file_name | str | The name of the file. | None |
file_size | int | Size of the file in bytes. Auto-detected if not specified. | None |
mime_type | str | MIME type of the file. Auto-detected if not specified. | None |
extension instance-attribute ⚓︎
clone ⚓︎
Creates a clone of the current file object.
This method is useful when the same file needs to be reused (e.g., as a preview), while keeping the original instance intact.
Returns:
| Name | Type | Description |
|---|---|---|
BufferedInputFile | BufferedInputFile | A new instance with identical content. |
from_file classmethod ⚓︎
Creates a BufferedInputFile from a file on disk.
This is a convenient way to load a file into memory if it needs to be reused or processed before sending.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path | str | Path | Path to the local file. | required |
file_name | str | File name to propagate. Defaults to the name extracted from path. | None |
file_size | int | File size in bytes. Auto-detected if not specified. | None |
mime_type | str | MIME type of the file. Auto-detected if not specified. | None |
Returns:
| Name | Type | Description |
|---|---|---|
BufferedInputFile | BufferedInputFile | A new instance ready for upload. |
read async ⚓︎
Asynchronously returns the file content as a BytesIO stream.
Returns:
| Name | Type | Description |
|---|---|---|
BytesIO | A stream containing the file content. |
trueconf.types.FSInputFile ⚓︎
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.
Initializes an FSInputFile instance from a local file.
If not provided, file_name, file_size, and mime_type are automatically detected:
file_nameis extracted from the file path.file_sizeis determined viaos.path.getsize().mime_typeis detected from the first 2048 bytes of the file content (usingpython-magicif available).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path | str | Path | Path to the local file. | required |
file_name | str | File name to be propagated in the upload. | None |
file_size | int | File size in bytes. | None |
mime_type | str | File MIME type. | None |
extension instance-attribute ⚓︎
clone ⚓︎
Creates a clone of the current FSInputFile instance.
Useful when the same file needs to be reused, for example, when sending preview images. The cloned object retains the same path, name, size, and MIME type but is a separate instance in memory.
Returns:
| Name | Type | Description |
|---|---|---|
FSInputFile | FSInputFile | A new instance of |
read async ⚓︎
Asynchronously reads the file content from the local filesystem.
Returns:
| Name | Type | Description |
|---|---|---|
bytes | The file content as raw bytes. |
trueconf.types.URLInputFile ⚓︎
URLInputFile(
url,
headers=None,
file_name=None,
file_size=None,
mime_type=None,
timeout=30,
verify_ssl=True,
**kwargs,
)
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.
Example
Initializes a URLInputFile instance from a remote URL.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url | str | URL of the file to download. | required |
headers | Optional[Dict[str, Any]] | Optional HTTP headers for the request. | None |
file_name | str | Optional file name to propagate in the upload. | None |
file_size | int | Optional file size in bytes. | None |
mime_type | str | Optional MIME type of the file. | None |
timeout | int | Timeout (in seconds) for the HTTP request. | 30 |
extension instance-attribute ⚓︎
clone ⚓︎
Creates a clone of the current URLInputFile instance.
Useful when the same file needs to be reused (e.g., sending a preview). The cloned object retains the same URL, headers, and metadata, and shares the already downloaded content: no second download is performed.
Returns:
| Name | Type | Description |
|---|---|---|
URLInputFile | URLInputFile | A new instance with identical parameters. |
prepare async ⚓︎
Prepares file metadata from HTTP response headers without downloading the body.
Sends a streaming GET request and reads only the response headers:
- MIME type from the
Content-Typeheader. - File name from the
Content-Dispositionheader or URL path. - File size from the
Content-Lengthheader.
Note
Content-Length is only an estimate for dynamic sources (e.g. a camera snapshot endpoint returns a new image per request). The authoritative file_size is set by read() from the actual downloaded bytes.
Raises:
| Type | Description |
|---|---|
HTTPStatusError | If the server responds with an error status code. |
FileUploadError | If the file name cannot be resolved from the |
read async ⚓︎
Downloads the file content from the remote URL.
The content is downloaded once and cached: repeated calls (and calls on clones) return the same bytes. After a successful download file_size is set to the actual size of the downloaded body, so the size declared to the server always matches the uploaded content — even for sources that return a new file per request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
max_size | int | None | Optional download limit in bytes. If the accumulated content exceeds it, the download is aborted and | None |
Returns:
| Name | Type | Description |
|---|---|---|
bytes | File content. |
Raises:
| Type | Description |
|---|---|
HTTPStatusError | If the server responds with an error status code. |
FileSizeTooLargeError | If the content exceeds |
trueconf.types.Message dataclass ⚓︎
Message(
*,
chat,
timestamp,
type,
author,
box=None,
content,
message_id,
is_edited,
reply_message_id=None,
reply_message=None,
)
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:
| Name | Type | Description |
|---|---|---|
timestamp | int | Unix timestamp of the message. |
type | MessageType | Type of the message (e.g., TEXT, ATTACHMENT). |
author | EnvelopeAuthor | Information about the user who sent the message. |
box | EnvelopeBox | Information about the chat (box) where the message was sent. |
content | UserMessageContent | The message content, selected from the user-message models according to |
chat | Chat | The chat this message belongs to. |
message_id | str | Unique identifier of the message. |
chat_id | str | .. deprecated:: Use :attr: |
is_edited | bool | Indicates whether the message was edited. |
reply_message_id | Optional[str] | Identifier of the message this one replies to. |
reply_message | Optional[Message] | Full message this one replies to. The server expands only the directly referenced message: if that message is also a reply, its |
from_user | EnvelopeAuthor | Shortcut for accessing the message author. |
content_type | MessageType | Returns the type of the message. |
text | Optional[str] | Returns the message text if it contains text, else None. |
quote | Optional[str] | Returns the quoted part of the replied message extracted from the |
mention | Optional[bool] | Returns True if the message mentions the bot, else None. |
document | Optional[Document] | Returns a document attachment if the message contains a non-media file (not photo, video, sticker). |
photo | Optional[Photo] | Returns a photo attachment if available. |
video | Optional[Video] | Returns a video attachment if available. |
sticker | Optional[Sticker] | Returns a sticker attachment if available. |
location | Optional[Location] | Returns the location content if the message contains a geolocation, else None. |
Methods:
| Name | Description |
|---|---|
answer | Sends a text message in the same chat. |
reply | Sends a reply message referencing the current one. |
forward | Forwards the current message to another chat. |
copy_to | Sends a copy of the current message (text-only). |
answer_photo | Sends a photo to the current chat. |
answer_document | Sends a document to the current chat. |
answer_sticker | Sends a sticker to the current chat. |
delete | Deletes the current message from the chat. |
content class-attribute instance-attribute ⚓︎
content = field(
metadata={
"deserialize": pass_through,
"serialize": lambda value: value.to_dict(),
}
)
content_type property ⚓︎
Returns the type of the current message content.
Returns:
| Name | Type | Description |
|---|---|---|
MessageType | MessageType | Message content type (e.g., TEXT, ATTACHMENT). |
document property ⚓︎
Returns the attached document if the message contains a non-media file.
Use this property only for documents that are not photos, videos, or stickers. For media attachments, use the corresponding properties: photo, video, or sticker. If you need to handle any attached file (including media), use message.content directly.
Returns:
| Type | Description |
|---|---|
Document | None | Optional[Document]: Document attachment bound to the bot, or None if not applicable. |
forwarded_message property ⚓︎
Returns the forwarded original message if this message is a forward.
The server sends a forward as an Envelope of type 201 whose content is the Envelope of the forwarded original (without its box). That inner envelope is parsed into a ForwardMessage, which is a full Message, so all regular shortcuts (text, voice, reply_message, ...) work on it.
Returns:
| Type | Description |
|---|---|
Message | None | Optional[Message]: The forwarded original message, or None if the |
Message | None | message is not a forward. |
from_user property ⚓︎
Returns the author of the current message.
Returns:
| Name | Type | Description |
|---|---|---|
EnvelopeAuthor | EnvelopeAuthor | Shortcut for accessing the message author. |
location property ⚓︎
Returns the location content if the current message contains a geolocation.
Returns:
| Type | Description |
|---|---|
Location | None | Optional[Location]: The location object with latitude, longitude and title, or None if the message is not a location message. |
mention property ⚓︎
Returns whether the current text message mentions the bot.
The shortcut checks two supported mention formats:
@all— treated as a mention because it targets all chat participants.- TrueConf user mentions rendered as HTML links, for example
<a href="trueconf:john_doe@video.example.com">John Doe</a>.
For user mentions, the extracted TrueConf ID is compared with bot.me_id.
Returns:
| Type | Description |
|---|---|
bool | None | bool | None: |
message_id class-attribute instance-attribute ⚓︎
photo property ⚓︎
Returns the attached photo object if the current message contains an image.
This is a shortcut for accessing photo metadata from image attachments.
Returns:
| Type | Description |
|---|---|
Photo | None | Optional[Photo]: A |
quote property ⚓︎
Returns the quoted part of the replied message, if present.
Extracts the content of the first <quote class="reply">...</quote> block from the message HTML text and unescapes HTML entities, so the returned value can be reused as the quote argument of Message.reply() or Bot.send_message().
Returns:
| Type | Description |
|---|---|
str | None | Optional[str]: Quoted text, or None if the message has no quote block. |
reply_message class-attribute instance-attribute ⚓︎
reply_message_id class-attribute instance-attribute ⚓︎
sticker property ⚓︎
Returns the attached sticker object if the current message contains a sticker.
Returns:
| Type | Description |
|---|---|
Sticker | None | Optional[Sticker]: A |
text property ⚓︎
Returns the text of the current message if present.
For a reply with a quote, the leading <quote class="reply">...</quote> block (and the following <br> breaks) is stripped from the returned value; use :attr:quote to get the quoted fragment itself.
Returns:
| Type | Description |
|---|---|
str | None | Optional[str]: Message text, or None if the message has no text content. |
video property ⚓︎
Returns the attached video object if the current message contains a video.
This is a shortcut for accessing video metadata from video attachments.
Returns:
| Type | Description |
|---|---|
Video | None | Optional[Video]: A |
voice property ⚓︎
Returns the attached voice object if the current message contains a voice message.
This is a shortcut for accessing video metadata from voice attachments.
Returns:
| Type | Description |
|---|---|
Voice | None | Optional[Voice]: A |
answer async ⚓︎
answer(text, parse_mode=HTML, *, buttons=None)
Shortcut for the send_message method of the bot instance. Use this method to send a text message to the current chat.
Automatically fills the following attributes
chat_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text | str | Text of the message to be sent. | required |
parse_mode | ParseMode | str | Text formatting mode. Defaults to HTML. | HTML |
Returns:
| Name | Type | Description |
|---|---|---|
SendMessageResponse | SendMessageResponse | Object containing the result of the message delivery. |
Examples:
answer_document async ⚓︎
answer_document(file, caption=None, parse_mode=TEXT)
Shortcut for the send_document method of the bot instance. Use this method to send a document in response to the current message.
Automatically fills the following attributes
chat_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | InputFile | The file to be uploaded. Must be a subclass of | required |
caption | str | None | Optional caption text to be sent with the file. | None |
parse_mode | ParseMode | str | Text formatting mode (e.g., Markdown, HTML, or plain text). | TEXT |
Returns:
| Name | Type | Description |
|---|---|---|
SendFileResponse | SendFileResponse | Object containing the result of the document upload. If the file was sent with a caption, |
Examples:
answer_photo async ⚓︎
answer_photo(file, preview, caption=None, parse_mode=TEXT)
Shortcut for the send_photo method of the bot instance. Use this method to send a photo in response to the current message.
Automatically fills the following attributes
chat_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | InputFile | The photo file to upload. Must be a subclass of | required |
preview | InputFile | None | Optional preview image. Must also be an | required |
caption | str | None | Optional caption to be sent along with the image. | None |
parse_mode | ParseMode | str | Formatting mode for the caption (e.g., Markdown, HTML, plain text). | TEXT |
Returns:
| Name | Type | Description |
|---|---|---|
SendFileResponse | SendFileResponse | Object containing the result of the photo upload. If the photo was sent with a caption, |
Examples:
answer_sticker async ⚓︎
Shortcut for the send_sticker method of the bot instance. Use this method to send a sticker in response to the current message.
Automatically fills the following attributes
chat_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | InputFile | The sticker file in WebP format. Must be a subclass of | required |
Returns:
| Name | Type | Description |
|---|---|---|
SendFileResponse | SendFileResponse | Object containing the result of the sticker delivery. |
Examples:
contact async ⚓︎
Returns the contact of the current message, if any.
The result is cached on the message, so a vCard file is downloaded from the server only once.
Two formats are recognized:
- A vCard attachment (
mimeType: text/vcard). The file is downloaded from the server and parsed into a contact with the structured name (N), phone number (TEL) and the raw vCard text. - A TrueConf contact link, i.e. a text message whose entire content is exactly one
<a href="trueconf:login&do=profile">Name</a>link (the same markupMessage.mentionuses for user mentions). The display name is fetched from the server viaget_user_display_name; if that fails (e.g. the user was deleted) the link text is used instead.first_nameholds the whole display name andlast_name/phone_numberstayNone.
Returns:
| Type | Description |
|---|---|
Contact | None | Contact | None: The parsed contact, or None if the message is not |
Contact | None | a vCard attachment or a TrueConf contact link. |
Examples:
copy_to async ⚓︎
Shortcut for the send_message method of the bot instance. Use this method to send a copy of the current message (without metadata or reply context) to another chat.
Automatically fills the following attributes
textparse_mode
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chat_id | str | Identifier of the target chat to send the copied message to. | required |
Returns:
| Name | Type | Description |
|---|---|---|
SendMessageResponse | SendMessageResponse | None | Object containing the result of the message delivery. |
delete async ⚓︎
Shortcut for the remove_message method of the bot instance. Use this method to delete the current message from the chat.
Automatically fills the following attributes
message_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
for_all | bool | If True, delete the message for all participants. Defaults to False (deletes only for the bot). | False |
Returns:
| Name | Type | Description |
|---|---|---|
RemoveMessageResponse | RemoveMessageResponse | Object containing the result of the message deletion. |
forward async ⚓︎
Shortcut for the forward_message method of the bot instance. Use this method to forward the current message to another chat.
Automatically fills the following attributes
message_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chat_id | str | Identifier of the target chat to forward the message to. | required |
Returns:
| Name | Type | Description |
|---|---|---|
ForwardMessageResponse | ForwardMessageResponse | Object containing the result of the message forwarding. |
reply async ⚓︎
reply(text, parse_mode=HTML, *, buttons=None, quote=None)
Shortcut for the send_message method. Sends a reply to this message in the current chat.
Automatically fills the following attributes
chat_id: Current chat identifier.reply_message_id: ID of the current message.
Source: trueconf.com/docs/chatbot-connector/en/messages/#replyMessage
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text | str | Text of the reply message. | required |
parse_mode | ParseMode | str | Text formatting mode. Defaults to HTML. | HTML |
quote | str | Part of this message to highlight in the reply preview. Must be a substring of the message text; raises | None |
Returns:
| Name | Type | Description |
|---|---|---|
SendMessageResponse | SendMessageResponse | Object containing the result of the message delivery. |
reply_document async ⚓︎
reply_document(file, caption=None, parse_mode=TEXT)
Shortcut for the send_document method of the bot instance. Sends a document as a reply to the current message in this chat.
Automatically fills the following attributes
chat_id: Current chat identifier.reply_message_id: ID of the current message.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | InputFile | The file to be uploaded. Must be a subclass of | required |
caption | str | None | Optional caption text to be sent with the file. | None |
parse_mode | ParseMode | str | Text formatting mode (e.g., Markdown, HTML, or plain text). | TEXT |
Returns:
| Name | Type | Description |
|---|---|---|
SendFileResponse | SendFileResponse | Object containing the result of the document upload. If the file was sent with a caption, |
Examples:
reply_photo async ⚓︎
reply_photo(file, preview, caption=None, parse_mode=TEXT)
Shortcut for the send_photo method of the bot instance. Sends a photo as a reply to the current message in this chat.
Automatically fills the following attributes
chat_id: Current chat identifier.reply_message_id: ID of the current message.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | InputFile | The photo file to upload. Must be a subclass of | required |
preview | InputFile | None | Optional preview image. Must also be an | required |
caption | str | None | Optional caption to be sent along with the image. | None |
parse_mode | ParseMode | str | Formatting mode for the caption (e.g., Markdown, HTML, plain text). | TEXT |
reply_message_id | str | None | Optional identifier of the message to which this message is a reply. | required |
Returns:
| Name | Type | Description |
|---|---|---|
SendFileResponse | SendFileResponse | Object containing the result of the photo upload. If the photo was sent with a caption, |
Examples:
reply_sticker async ⚓︎
Shortcut for the send_sticker method of the bot instance. Sends a sticker as a reply to the current message in this chat.
Automatically fills the following attributes
chat_id: Current chat identifier.reply_message_id: ID of the current message.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file | InputFile | The sticker file in WebP format. Must be a subclass of | required |
Returns:
| Name | Type | Description |
|---|---|---|
SendFileResponse | SendFileResponse | Object containing the result of the sticker delivery. |
Examples:
save_to_favorites async ⚓︎
Saves the current message to the bot's "Favorites" chat.
By default, the message is forwarded to the bot's personal Favorites chat. If copy=True, the message will be copied instead — only for text messages.
Use this method to store important messages, logs, or media content in the bot’s private space.
Notes
- The Favorites chat is created automatically on first use.
copy=Trueonly works for text messages and does not preserve metadata (like replies or sender info).- Non-text messages with
copy=Truewill be ignored with a warning.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
copy | bool | If True, copies the message instead of forwarding it. Defaults to False. | False |
Returns:
| Type | Description |
|---|---|
SendMessageResponse | ForwardMessageResponse | None | SendMessageResponse | ForwardMessageResponse | None: |
SendMessageResponse | ForwardMessageResponse | None | Result of sending or forwarding the message. Returns |
trueconf.types.SystemMessage dataclass ⚓︎
trueconf.types.RemovedChat dataclass ⚓︎
Event type: a chat was removed.
This object is received in the handler when a private, group, channel, or conference chat is deleted.
Notes
This class is used as the event type in handler functions decorated with @<router>.removed_chat().
Attributes:
| Name | Type | Description |
|---|---|---|
chat_id | str | Unique identifier of the chat that was removed. |
Examples:
from trueconf.types import RemovedChat
@<router>.removed_chat()
async def on_removed(event: RemovedChat):
print(f"Chat removed: {event.chat_id}")
trueconf.types.RemovedChatParticipant dataclass ⚓︎
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.
Notes
This class is used as the event type in handler functions decorated with @<router>.removed_chat_participant().
Attributes:
| Name | Type | Description |
|---|---|---|
timestamp | int | Unix timestamp (milliseconds) of when the event occurred. |
chat_id | str | Unique identifier of the chat where the participant was removed. |
user_id | str | TrueConf ID of the participant who was removed. |
removed_by | EnvelopeAuthor | Information about the user who removed the participant. |
Examples:
from trueconf.types import RemovedChatParticipant
@<router>.removed_chat_participant()
async def on_removed(event: RemovedChatParticipant):
print(event.user_id)
removed_by class-attribute instance-attribute ⚓︎
trueconf.types.RemovedMessage dataclass ⚓︎
Event type: a message was removed.
This object is received in the handler when a message is deleted from a chat.
Notes
This class is used as the event type in handler functions decorated with @<router>.removed_message().
Attributes:
| Name | Type | Description |
|---|---|---|
chat_id | str | Unique identifier of the chat from which the message was removed. |
message_id | str | Unique identifier of the removed message. |
removed_by | EnvelopeAuthor | Information about the user who removed the message. |
Examples:
trueconf.types.Update dataclass ⚓︎
trueconf.types.UploadingProgress dataclass ⚓︎
Event type: file upload progress.
This object is received in the handler when a file is being uploaded and the upload progress is updated.
Notes
This class is used as the event type in handler functions decorated with @<router>.uploading_progress().
Attributes:
| Name | Type | Description |
|---|---|---|
file_id | str | Unique identifier of the file being uploaded. |
progress | int | Number of bytes uploaded to the server. |
Examples:
trueconf.types.contact.Contact dataclass ⚓︎
Represents a contact parsed from a vCard file or a TrueConf contact link.
Mirrors the Telegram/aiogram Contact shape. A vCard attachment provides a structured name (N), a phone number (TEL) and the raw vCard text; a TrueConf contact link (<a href="trueconf:login&do=profile">) provides a user id and a display name.
Attributes:
| Name | Type | Description |
|---|---|---|
phone_number | str | None | Phone number parsed from the vCard |
first_name | str | Given name for vCards (from |
last_name | str | None | Family name parsed from the structured vCard |
user_id | str | None | TrueConf user id (e.g. |
vcard | str | None | Raw vCard text for vCard files; |
trueconf.types.CallbackQuery dataclass ⚓︎
command_id class-attribute instance-attribute ⚓︎
command_payload class-attribute instance-attribute ⚓︎
command_source class-attribute instance-attribute ⚓︎
edit_message async ⚓︎
Shortcut for bot.edit_message that edits the bot's own message this callback came from.
The server treats editMessage as a full content overwrite (PUT): every edit carries the full text, formatting and buttons. Text and parse_mode are already present in the click event (commandSource.message.content), so only buttons are missing — when buttons is not given explicitly, the current buttons are fetched via getMessageById:
edit_message(text="new")— changes text, keeps buttons and formattingedit_message(buttons=kb)— changes buttons, keeps text (no extra request)edit_message(text="new", buttons=kb)— changes both (no extra request)edit_message(buttons=None)— removes buttons, keeps text (no extra request)edit_message(text="new", buttons=None)— changes text, removes buttons (no extra request)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text | str | UNSET | New text. | UNSET |
parse_mode | ParseMode | str | UNSET | Formatting mode. | UNSET |
buttons | InlineKeyboardMarkup | None | UNSET | New inline keyboard. | UNSET |
Returns:
| Name | Type | Description |
|---|---|---|
EditMessageResponse | EditMessageResponse | Result of the message update. |
trueconf.types.Chat dataclass ⚓︎
trueconf.types.InlineKeyboardButton dataclass ⚓︎
InlineKeyboardButton(
text=None,
command=None,
url=None,
message=None,
copy_data=None,
custom_data=None,
wait_reply=False,
to=None,
draft=False,
button_id=None,
style=None,
)
trueconf.types.InlineKeyboardMarkup dataclass ⚓︎
trueconf.types.content.location.Location dataclass ⚓︎
trueconf.types.content.voice.Voice dataclass ⚓︎
Represents a voice attached to a message.
This class provides access to file metadata and utility methods such as downloading and preview access.
Attributes:
| Name | Type | Description |
|---|---|---|
file_id | str | Unique identifier of the voice file. |
file_size | int | Size of the file in bytes. |
mime_type | str | MIME type of the voice file. |
duration | int | |
preview_url async property ⚓︎
Returns the preview URL of the voice file, if available.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | A URL pointing to the preview version of the voice file. |
url async property ⚓︎
Returns the direct download URL of the voice file.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | A URL pointing to the original voice file. |
download async ⚓︎
Shortcut for the download_file_by_id method of the bot instance.
Automatically fills the following attributes
file_id
Use this method to download the current file by its ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dest_path | str | Path | Deprecated destination directory. | None |
file_path | str | Path | Exact path where the file should be saved. If neither path is specified, the file content is returned as bytes. | None |
Returns:
| Type | Description |
|---|---|
bytes | Path | None | bytes | Path | None: File content, saved path, or None if the download failed. |