# Types⚓︎

You can import all types at once:

```
from trueconf.types import *
```

## `` trueconf.types.AddedChatParticipant `dataclass` ⚓︎

```
AddedChatParticipant(timestamp, chat_id, user_id, added_by)
```

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 `@.added_chat_participant()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#addedChatParticipant

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` timestamp

`instance-attribute`
(`trueconf.types.AddedChatParticipant.timestamp`)' href=#trueconf.types.AddedChatParticipant.timestamp>timestamp | `int` | Unix timestamp (milliseconds) of when the event occurred. |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.AddedChatParticipant.chat_id`)' href=#trueconf.types.AddedChatParticipant.chat_id>chat_id | `str` | Unique identifier of the chat where the participant was added. |
| `` user_id

`class-attribute`
`instance-attribute`
(`trueconf.types.AddedChatParticipant.user_id`)' href=#trueconf.types.AddedChatParticipant.user_id>user_id | `str` | TrueConf ID of the participant who was added. |
| `` added_by

`class-attribute`
`instance-attribute`
(`trueconf.types.AddedChatParticipant.added_by`)' href=#trueconf.types.AddedChatParticipant.added_by>added_by | `EnvelopeAuthor` | Information about the user who added the participant. |

Examples:

```
from trueconf.types import AddedChatParticipant

@.added_chat_participant()
async def on_added(event: AddedChatParticipant):
print(event.user_id)
```

### `` added_by `class-attribute` `instance-attribute` ⚓︎

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` timestamp `instance-attribute` ⚓︎

```
timestamp
```

### `` user_id `class-attribute` `instance-attribute` ⚓︎

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

## `` trueconf.types.ChangedParticipantRole `dataclass` ⚓︎

```
ChangedParticipantRole(timestamp, role, chat_id, user_id)
```

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 `@.changed_chat_participant_role()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#changedParticipantRole

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` timestamp

`instance-attribute`
(`trueconf.types.ChangedParticipantRole.timestamp`)' href=#trueconf.types.ChangedParticipantRole.timestamp>timestamp | `int` | Unix timestamp (in milliseconds) when the role change occurred. |
| `` role

`instance-attribute`
(`trueconf.types.ChangedParticipantRole.role`)' href=#trueconf.types.ChangedParticipantRole.role>role | `str` | New role assigned to the participant. |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.ChangedParticipantRole.chat_id`)' href=#trueconf.types.ChangedParticipantRole.chat_id>chat_id | `str` | Identifier of the chat where the role change occurred. |
| `` user_id

`class-attribute`
`instance-attribute`
(`trueconf.types.ChangedParticipantRole.user_id`)' href=#trueconf.types.ChangedParticipantRole.user_id>user_id | `str` | TrueConf ID of the participant whose role was changed. |

### Example

```
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 `class-attribute` `instance-attribute` ⚓︎

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

### `` role `instance-attribute` ⚓︎

```
role
```

### `` timestamp `instance-attribute` ⚓︎

```
timestamp
```

### `` user_id `class-attribute` `instance-attribute` ⚓︎

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

## `` trueconf.types.CreatedChannel `dataclass` ⚓︎

```
CreatedChannel(
chat_id, title, chat_type, last_message, unread_messages
)
```

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 `@.created_channel()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#createdChannel

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedChannel.chat_id`)' href=#trueconf.types.CreatedChannel.chat_id>chat_id | `str` | Unique identifier of the created channel. |
| `` title

`instance-attribute`
(`trueconf.types.CreatedChannel.title`)' href=#trueconf.types.CreatedChannel.title>title | `str` | Title of the channel. |
| `` chat_type

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedChannel.chat_type`)' href=#trueconf.types.CreatedChannel.chat_type>chat_type | `` ChatType (`trueconf.enums.chat_type.ChatType`)' href=../Enums/#trueconf.enums.ChatType>ChatType | Type of the chat (should be `channel`). |
| `` last_message

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedChannel.last_message`)' href=#trueconf.types.CreatedChannel.last_message>last_message | `LastMessage | None` | The last message in the channel, if available. |
| `` unread_messages

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedChannel.unread_messages`)' href=#trueconf.types.CreatedChannel.unread_messages>unread_messages | `int` | Number of unread messages in the channel. |

Examples:

```
from trueconf.types import CreatedChannel

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` chat_type `class-attribute` `instance-attribute` ⚓︎

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

### `` last_message `class-attribute` `instance-attribute` ⚓︎

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

### `` title `instance-attribute` ⚓︎

```
title
```

### `` unread_messages `class-attribute` `instance-attribute` ⚓︎

```
unread_messages = field(
metadata={"alias": "unreadMessages"}
)
```

## `` trueconf.types.CreatedGroupChat `dataclass` ⚓︎

```
CreatedGroupChat(
chat_id, title, chat_type, last_message, unread_messages
)
```

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 `@.created_group_chat()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#createdGroupChat

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedGroupChat.chat_id`)' href=#trueconf.types.CreatedGroupChat.chat_id>chat_id | `str` | Unique identifier of the group chat. |
| `` title

`instance-attribute`
(`trueconf.types.CreatedGroupChat.title`)' href=#trueconf.types.CreatedGroupChat.title>title | `str` | Title of the group chat. |
| `` chat_type

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedGroupChat.chat_type`)' href=#trueconf.types.CreatedGroupChat.chat_type>chat_type | `` ChatType (`trueconf.enums.chat_type.ChatType`)' href=../Enums/#trueconf.enums.ChatType>ChatType | Type of the chat (should be `group`). |
| `` last_message

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedGroupChat.last_message`)' href=#trueconf.types.CreatedGroupChat.last_message>last_message | `LastMessage | None` | The last message in the chat, if available. |
| `` unread_messages

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedGroupChat.unread_messages`)' href=#trueconf.types.CreatedGroupChat.unread_messages>unread_messages | `int` | Number of unread messages in the group chat. |

Examples:

```
from trueconf.types import CreatedGroupChat

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` chat_type `class-attribute` `instance-attribute` ⚓︎

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

### `` last_message `class-attribute` `instance-attribute` ⚓︎

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

### `` title `instance-attribute` ⚓︎

```
title
```

### `` unread_messages `class-attribute` `instance-attribute` ⚓︎

```
unread_messages = field(
metadata={"alias": "unreadMessages"}
)
```

## `` trueconf.types.CreatedPersonalChat `dataclass` ⚓︎

```
CreatedPersonalChat(
chat_id, title, chat_type, last_message, unread_messages
)
```

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 `@.created_personal_chat()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#createdP2PChat

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedPersonalChat.chat_id`)' href=#trueconf.types.CreatedPersonalChat.chat_id>chat_id | `str` | Unique identifier of the personal chat. |
| `` title

`instance-attribute`
(`trueconf.types.CreatedPersonalChat.title`)' href=#trueconf.types.CreatedPersonalChat.title>title | `str` | Title of the chat (usually the participant’s name). |
| `` chat_type

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedPersonalChat.chat_type`)' href=#trueconf.types.CreatedPersonalChat.chat_type>chat_type | `` ChatType (`trueconf.enums.chat_type.ChatType`)' href=../Enums/#trueconf.enums.ChatType>ChatType | Type of the chat (should be `p2p`). |
| `` last_message

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedPersonalChat.last_message`)' href=#trueconf.types.CreatedPersonalChat.last_message>last_message | `LastMessage | None` | The last message in the chat, if available. |
| `` unread_messages

`class-attribute`
`instance-attribute`
(`trueconf.types.CreatedPersonalChat.unread_messages`)' href=#trueconf.types.CreatedPersonalChat.unread_messages>unread_messages | `int` | Number of unread messages in the personal chat. |

Examples:

```
from trueconf.types import CreatedPersonalChat

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` chat_type `class-attribute` `instance-attribute` ⚓︎

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

### `` last_message `class-attribute` `instance-attribute` ⚓︎

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

### `` title `instance-attribute` ⚓︎

```
title
```

### `` unread_messages `class-attribute` `instance-attribute` ⚓︎

```
unread_messages = field(
metadata={"alias": "unreadMessages"}
)
```

## `` trueconf.types.EditedMessage `dataclass` ⚓︎

```
EditedMessage(timestamp, content, chat_id)
```

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 `@.edited_message()`.

### Source

trueconf.com/docs/chatbot-connector/en/messages/#editMessage

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` timestamp

`instance-attribute`
(`trueconf.types.EditedMessage.timestamp`)' href=#trueconf.types.EditedMessage.timestamp>timestamp | `int` | Unix timestamp (milliseconds) of when the edit occurred. |
| `` content

`instance-attribute`
(`trueconf.types.EditedMessage.content`)' href=#trueconf.types.EditedMessage.content>content | `TextContent` | The updated content of the edited message. |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.EditedMessage.chat_id`)' href=#trueconf.types.EditedMessage.chat_id>chat_id | `str` | Unique identifier of the chat where the message was edited. |

Examples:

```
from trueconf.types import EditedMessage

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` content `instance-attribute` ⚓︎

```
content
```

### `` timestamp `instance-attribute` ⚓︎

```
timestamp
```

## `` trueconf.types.InputFile ⚓︎

```
InputFile(file_name=None, file_size=None, mime_type=None)
```

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.

### Source

trueconf.com/docs/chatbot-connector/en/files/#upload-file-to-server-storage

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).

### Example

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

### `` extension `instance-attribute` ⚓︎

```
extension = (
Path(file_name).suffix.lower()[1:] if file_name else ""
)
```

### `` file_name `instance-attribute` ⚓︎

```
file_name = file_name
```

### `` file_size `instance-attribute` ⚓︎

```
file_size = file_size
```

### `` mime_type `instance-attribute` ⚓︎

```
mime_type = mime_type
```

### `` clone `abstractmethod` ⚓︎

```
clone()
```

### `` read `abstractmethod` `async` ⚓︎

```
read()
```

## `` trueconf.types.BufferedInputFile ⚓︎

```
BufferedInputFile(
file,
file_name=None,
file_size=None,
mime_type=None,
**kwargs,
)
```

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

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

### 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` |

### `` data `instance-attribute` ⚓︎

```
data = file
```

### `` extension `instance-attribute` ⚓︎

```
extension = (
Path(file_name).suffix.lower()[1:] if file_name else ""
)
```

### `` file_name `instance-attribute` ⚓︎

```
file_name = file_name
```

### `` file_size `instance-attribute` ⚓︎

```
file_size = file_size
```

### `` mime_type `instance-attribute` ⚓︎

```
mime_type = mime_type
```

### `` clone ⚓︎

```
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` | `` trueconf.types.BufferedInputFile (`trueconf.types.input_file.BufferedInputFile`)' href=#trueconf.types.BufferedInputFile>BufferedInputFile | A new instance with identical content. |

### `` from_file `classmethod` ⚓︎

```
from_file(
path,
file_name=None,
file_size=None,
mime_type=None,
**kwargs,
)
```

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` | `` trueconf.types.BufferedInputFile (`trueconf.types.input_file.BufferedInputFile`)' href=#trueconf.types.BufferedInputFile>BufferedInputFile | A new instance ready for upload. |

### `` read `async` ⚓︎

```
read()
```

Asynchronously returns the file content as a `BytesIO` stream.

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `BytesIO` | | A stream containing the file content. |

## `` trueconf.types.FSInputFile ⚓︎

```
FSInputFile(
path,
file_name=None,
file_size=None,
mime_type=None,
**kwargs,
)
```

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.

### Example

```
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, `file_name`, `file_size`, and `mime_type` are automatically detected:

- `file_name` is extracted from the file path.

- `file_size` is determined via `os.path.getsize()`.

- `mime_type` is detected from the first 2048 bytes of the file content (using `python-magic` if 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` ⚓︎

```
extension = (
Path(file_name).suffix.lower()[1:] if file_name else ""
)
```

### `` file_name `instance-attribute` ⚓︎

```
file_name = file_name
```

### `` file_size `instance-attribute` ⚓︎

```
file_size = file_size
```

### `` mime_type `instance-attribute` ⚓︎

```
mime_type = mime_type
```

### `` path `instance-attribute` ⚓︎

```
path = path
```

### `` clone ⚓︎

```
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` | `` trueconf.types.FSInputFile (`trueconf.types.input_file.FSInputFile`)' href=#trueconf.types.FSInputFile>FSInputFile | A new instance of `FSInputFile` with identical properties. |

### `` read `async` ⚓︎

```
read()
```

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

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

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` ⚓︎

```
extension = (
Path(file_name).suffix.lower()[1:] if file_name else ""
)
```

### `` file_name `instance-attribute` ⚓︎

```
file_name = file_name
```

### `` file_size `instance-attribute` ⚓︎

```
file_size = file_size
```

### `` headers `instance-attribute` ⚓︎

```
headers = headers
```

### `` mime_type `instance-attribute` ⚓︎

```
mime_type = mime_type
```

### `` timeout `instance-attribute` ⚓︎

```
timeout = timeout
```

### `` url `instance-attribute` ⚓︎

```
url = url
```

### `` verify_ssl `instance-attribute` ⚓︎

```
verify_ssl = verify_ssl
```

### `` clone ⚓︎

```
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` | `` trueconf.types.URLInputFile (`trueconf.types.input_file.URLInputFile`)' href=#trueconf.types.URLInputFile>URLInputFile | A new instance with identical parameters. |

### `` prepare `async` ⚓︎

```
prepare()
```

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-Type` header.

- File name from the `Content-Disposition` header or URL path.

- File size from the `Content-Length` header.

### 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 (`trueconf.exceptions.FileUploadError`)' href=../Exceptions/#trueconf.exceptions.FileUploadError>FileUploadError | If the file name cannot be resolved from the `Content-Disposition` header or the URL path. |

### `` read `async` ⚓︎

```
read(max_size=None)
```

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 `FileSizeTooLargeError` is raised. | `None` |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `bytes` | | File content. |

Raises:

| Type | Description |
| --- | --- |
| `HTTPStatusError` | If the server responds with an error status code. |
| `` FileSizeTooLargeError (`trueconf.exceptions.FileSizeTooLargeError`)' href=../Exceptions/#trueconf.exceptions.FileSizeTooLargeError>FileSizeTooLargeError | If the content exceeds `max_size`. |

## `` 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).

### Source

trueconf.com/docs/chatbot-connector/en/messages/#sendMessage

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` timestamp

`instance-attribute`
(`trueconf.types.Message.timestamp`)' href=#trueconf.types.Message.timestamp>timestamp | `int` | Unix timestamp of the message. |
| `` type

`instance-attribute`
(`trueconf.types.Message.type`)' href=#trueconf.types.Message.type>type | `` MessageType (`trueconf.enums.message_type.MessageType`)' href=../Enums/#trueconf.enums.MessageType>MessageType | Type of the message (e.g., TEXT, ATTACHMENT). |
| `` author

`instance-attribute`
(`trueconf.types.Message.author`)' href=#trueconf.types.Message.author>author | `EnvelopeAuthor` | Information about the user who sent the message. |
| `` box

`class-attribute`
`instance-attribute`
(`trueconf.types.Message.box`)' href=#trueconf.types.Message.box>box | `EnvelopeBox` | Information about the chat (box) where the message was sent. |
| `` content

`class-attribute`
`instance-attribute`
(`trueconf.types.Message.content`)' href=#trueconf.types.Message.content>content | `UserMessageContent` | The message content, selected from the user-message models according to `type`. |
| `` chat

`instance-attribute`
(`trueconf.types.Message.chat`)' href=#trueconf.types.Message.chat>chat | `` trueconf.types.Chat

`dataclass`
(`trueconf.types.chat.Chat`)' href=#trueconf.types.Chat>Chat | The chat this message belongs to. |
| `` message_id

`class-attribute`
`instance-attribute`
(`trueconf.types.Message.message_id`)' href=#trueconf.types.Message.message_id>message_id | `str` | Unique identifier of the message. |
| `` chat_id

`property`
(`trueconf.types.Message.chat_id`)' href=#trueconf.types.Message.chat_id>chat_id | `str` | .. deprecated:: Use :attr:`chat.chat_id` instead. |
| `` is_edited

`class-attribute`
`instance-attribute`
(`trueconf.types.Message.is_edited`)' href=#trueconf.types.Message.is_edited>is_edited | `bool` | Indicates whether the message was edited. |
| `` reply_message_id

`class-attribute`
`instance-attribute`
(`trueconf.types.Message.reply_message_id`)' href=#trueconf.types.Message.reply_message_id>reply_message_id | `Optional[str]` | Identifier of the message this one replies to. |
| `` reply_message

`class-attribute`
`instance-attribute`
(`trueconf.types.Message.reply_message`)' href=#trueconf.types.Message.reply_message>reply_message | `Optional[` trueconf.types.Message

`dataclass`
(`trueconf.types.message.Message`)' href=#trueconf.types.Message>Message] | Full message this one replies to. The server expands only the directly referenced message: if that message is also a reply, its `reply_message_id` is available but its `reply_message` remains `None`. Use `Bot.get_message_by_id()` to load the next message in the reply chain. |
| `` from_user

`property`
(`trueconf.types.Message.from_user`)' href=#trueconf.types.Message.from_user>from_user | `EnvelopeAuthor` | Shortcut for accessing the message author. |
| `` content_type

`property`
(`trueconf.types.Message.content_type`)' href=#trueconf.types.Message.content_type>content_type | `` MessageType (`trueconf.enums.message_type.MessageType`)' href=../Enums/#trueconf.enums.MessageType>MessageType | Returns the type of the message. |
| `` text

`property`
(`trueconf.types.Message.text`)' href=#trueconf.types.Message.text>text | `Optional[str]` | Returns the message text if it contains text, else None. |
| `` quote

`property`
(`trueconf.types.Message.quote`)' href=#trueconf.types.Message.quote>quote | `Optional[str]` | Returns the quoted part of the replied message extracted from the `` block, else None. |
| `` mention

`property`
(`trueconf.types.Message.mention`)' href=#trueconf.types.Message.mention>mention | `Optional[bool]` | Returns True if the message mentions the bot, else None. |
| `` document

`property`
(`trueconf.types.Message.document`)' href=#trueconf.types.Message.document>document | `Optional[Document]` | Returns a document attachment if the message contains a non-media file (not photo, video, sticker). |
| `` photo

`property`
(`trueconf.types.Message.photo`)' href=#trueconf.types.Message.photo>photo | `Optional[Photo]` | Returns a photo attachment if available. |
| `` video

`property`
(`trueconf.types.Message.video`)' href=#trueconf.types.Message.video>video | `Optional[Video]` | Returns a video attachment if available. |
| `` sticker

`property`
(`trueconf.types.Message.sticker`)' href=#trueconf.types.Message.sticker>sticker | `Optional[Sticker]` | Returns a sticker attachment if available. |
| `` location

`property`
(`trueconf.types.Message.location`)' href=#trueconf.types.Message.location>location | `Optional[` trueconf.types.content.location.Location

`dataclass`
' href=#trueconf.types.content.location.Location>Location] | Returns the location content if the message contains a geolocation, else None. |

Methods:

| Name | Description |
| --- | --- |
| `` answer

`async`
(`trueconf.types.Message.answer`)' href=#trueconf.types.Message.answer>answer | Sends a text message in the same chat. |
| `` reply

`async`
(`trueconf.types.Message.reply`)' href=#trueconf.types.Message.reply>reply | Sends a reply message referencing the current one. |
| `` forward

`async`
(`trueconf.types.Message.forward`)' href=#trueconf.types.Message.forward>forward | Forwards the current message to another chat. |
| `` copy_to

`async`
(`trueconf.types.Message.copy_to`)' href=#trueconf.types.Message.copy_to>copy_to | Sends a copy of the current message (text-only). |
| `` answer_photo

`async`
(`trueconf.types.Message.answer_photo`)' href=#trueconf.types.Message.answer_photo>answer_photo | Sends a photo to the current chat. |
| `` answer_document

`async`
(`trueconf.types.Message.answer_document`)' href=#trueconf.types.Message.answer_document>answer_document | Sends a document to the current chat. |
| `` answer_sticker

`async`
(`trueconf.types.Message.answer_sticker`)' href=#trueconf.types.Message.answer_sticker>answer_sticker | Sends a sticker to the current chat. |
| `` delete

`async`
(`trueconf.types.Message.delete`)' href=#trueconf.types.Message.delete>delete | Deletes the current message from the chat. |

### `` author `instance-attribute` ⚓︎

```
author
```

### `` box `class-attribute` `instance-attribute` ⚓︎

```
box = None
```

### `` chat `instance-attribute` ⚓︎

```
chat
```

### `` chat_id `property` ⚓︎

```
chat_id
```

### `` content `class-attribute` `instance-attribute` ⚓︎

```
content = field(
metadata={
"deserialize": pass_through,
"serialize": lambda value: value.to_dict(),
}
)
```

### `` content_type `property` ⚓︎

```
content_type
```

Returns the type of the current message content.

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `MessageType` | `` MessageType (`trueconf.enums.message_type.MessageType`)' href=../Enums/#trueconf.enums.MessageType>MessageType | Message content type (e.g., TEXT, ATTACHMENT). |

### `` document `property` ⚓︎

```
document
```

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` ⚓︎

```
forwarded_message
```

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 |
| --- | --- |
| `` trueconf.types.Message

`dataclass`
(`trueconf.types.message.Message`)' href=#trueconf.types.Message>Message | None | Optional[Message]: The forwarded original message, or None if the |
| `` trueconf.types.Message

`dataclass`
(`trueconf.types.message.Message`)' href=#trueconf.types.Message>Message | None | message is not a forward. |

### `` from_user `property` ⚓︎

```
from_user
```

Returns the author of the current message.

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `EnvelopeAuthor` | `EnvelopeAuthor` | Shortcut for accessing the message author. |

### `` is_edited `class-attribute` `instance-attribute` ⚓︎

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

### `` location `property` ⚓︎

```
location
```

Returns the location content if the current message contains a geolocation.

Returns:

| Type | Description |
| --- | --- |
| `` trueconf.types.content.location.Location

`dataclass`
' href=#trueconf.types.content.location.Location>Location | None | Optional[Location]: The location object with latitude, longitude and title, or None if the message is not a location message. |

### `` mention `property` ⚓︎

```
mention
```

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 `[John Doe](trueconf:john_doe@video.example.com)`.

For user mentions, the extracted TrueConf ID is compared with `bot.me_id`.

Returns:

| Type | Description |
| --- | --- |
| `bool | None` | bool | None: `True` if the message mentions the bot, otherwise `None`. |

### `` message_id `class-attribute` `instance-attribute` ⚓︎

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

### `` photo `property` ⚓︎

```
photo
```

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 `Photo` object bound to the bot, or None if the message does not contain an image. |

### `` quote `property` ⚓︎

```
quote
```

Returns the quoted part of the replied message, if present.

Extracts the content of the first `...` block from the message HTML text and unescapes HTML entities, so the returned value can be reused as the `quote` argument of `async` ' href=#trueconf.types.Message.reply>`Message.reply()` or `async` ' href=../Bot/#trueconf.Bot.send_message>`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 = field(
default=None, metadata={"alias": "replyMessage"}
)
```

### `` reply_message_id `class-attribute` `instance-attribute` ⚓︎

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

### `` sticker `property` ⚓︎

```
sticker
```

Returns the attached sticker object if the current message contains a sticker.

Returns:

| Type | Description |
| --- | --- |
| `Sticker | None` | Optional[Sticker]: A `Sticker` object bound to the bot, or None if the message does not contain a sticker. |

### `` text `property` ⚓︎

```
text
```

Returns the text of the current message if present.

For a reply with a quote, the leading `...` block (and the following `
` 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. |

### `` timestamp `instance-attribute` ⚓︎

```
timestamp
```

### `` type `instance-attribute` ⚓︎

```
type
```

### `` video `property` ⚓︎

```
video
```

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 `Video` object bound to the bot, or None if the message does not contain a video. |

### `` voice `property` ⚓︎

```
voice
```

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 |
| --- | --- |
| `` trueconf.types.content.voice.Voice

`dataclass`
' href=#trueconf.types.content.voice.Voice>Voice | None | Optional[Voice]: A `Voice` object bound to the bot, or None if the message does not contain a voice. |

### `` answer `async` ⚓︎

```
answer(text, parse_mode= HTML

class-attribute
instance-attribute
(trueconf.enums.parse_mode.ParseMode.HTML)' href=../Enums/#trueconf.enums.ParseMode.HTML>HTML, *, buttons=None)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_message>`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`

### Source

trueconf.com/docs/chatbot-connector/en/messages/#sendMessage

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `text` | `str` | Text of the message to be sent. | required |
| `parse_mode` | `` ParseMode (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | Text formatting mode. Defaults to HTML. | `` HTML

`class-attribute`
`instance-attribute`
(`trueconf.enums.parse_mode.ParseMode.HTML`)' href=../Enums/#trueconf.enums.ParseMode.HTML>HTML |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendMessageResponse` | `` SendMessageResponse (`trueconf.types.responses.send_message_response.SendMessageResponse`)' href=../Responses/#trueconf.types.responses.SendMessageResponse>SendMessageResponse | Object containing the result of the message delivery. |

Examples:

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

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

### `` answer_document `async` ⚓︎

```
answer_document(file, caption=None, parse_mode= TEXT

class-attribute
instance-attribute
(trueconf.enums.parse_mode.ParseMode.TEXT)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_document>`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`

### Source

trueconf.com/docs/chatbot-connector/en/files/#working-with-files

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | The file to be uploaded. Must be a subclass of `InputFile`. | required |
| `caption` | `str | None` | Optional caption text to be sent with the file. | `None` |
| `parse_mode` | `` ParseMode (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | Text formatting mode (e.g., Markdown, HTML, or plain text). | `` TEXT

`class-attribute`
`instance-attribute`
(`trueconf.enums.parse_mode.ParseMode.TEXT`)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendFileResponse` | `` SendFileResponse (`trueconf.types.responses.send_file_response.SendFileResponse`)' href=../Responses/#trueconf.types.responses.SendFileResponse>SendFileResponse | Object containing the result of the document upload. If the file was sent with a caption, `caption_message_id` contains the ID of the caption message. |

Examples:

```
>>> @.message()
>>> async def on_message(message:Message):
>>> await message.answer_document(file=FSInputFile("sticker.webp"))
```

### `` answer_photo `async` ⚓︎

```
answer_photo(file, preview, caption=None, parse_mode= TEXT

class-attribute
instance-attribute
(trueconf.enums.parse_mode.ParseMode.TEXT)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_photo>`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`

### Source

trueconf.com/docs/chatbot-connector/en/files/#sending-an-image

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | The photo file to upload. Must be a subclass of `InputFile`. | required |
| `preview` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | None | Optional preview image. Must also be an `InputFile` if provided. | required |
| `caption` | `str | None` | Optional caption to be sent along with the image. | `None` |
| `parse_mode` | `` ParseMode (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | Formatting mode for the caption (e.g., Markdown, HTML, plain text). | `` TEXT

`class-attribute`
`instance-attribute`
(`trueconf.enums.parse_mode.ParseMode.TEXT`)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendFileResponse` | `` SendFileResponse (`trueconf.types.responses.send_file_response.SendFileResponse`)' href=../Responses/#trueconf.types.responses.SendFileResponse>SendFileResponse | Object containing the result of the photo upload. If the photo was sent with a caption, `caption_message_id` contains the ID of the caption message. |

Examples:

```
>>> @.message()
>>> async def on_message(message:Message):
>>> await message.answer_photo(file=FSInputFile("sticker.webp"), preview=FSInputFile("sticker.webp"))
```

### `` answer_sticker `async` ⚓︎

```
answer_sticker(file)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_sticker>`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`

### Source

trueconf.com/docs/chatbot-connector/en/files/#upload-file-to-server-storage

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | The sticker file in WebP format. Must be a subclass of `InputFile`. | required |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendFileResponse` | `` SendFileResponse (`trueconf.types.responses.send_file_response.SendFileResponse`)' href=../Responses/#trueconf.types.responses.SendFileResponse>SendFileResponse | Object containing the result of the sticker delivery. |

Examples:

```
>>> @.message()
>>> async def on_message(message:Message):
>>> await message.answer_sticker(file=FSInputFile("sticker.webp"))
```

### `` contact `async` ⚓︎

```
contact()
```

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 `[Name](trueconf:login&do=profile)` link (the same markup `Message.mention` uses for user mentions). The display name is fetched from the server via `get_user_display_name`; if that fails (e.g. the user was deleted) the link text is used instead. `first_name` holds the whole display name and `last_name`/`phone_number` stay `None`.

Returns:

| Type | Description |
| --- | --- |
| `` trueconf.types.contact.Contact

`dataclass`
' href=#trueconf.types.contact.Contact>Contact | None | Contact | None: The parsed contact, or None if the message is not |
| `` trueconf.types.contact.Contact

`dataclass`
' href=#trueconf.types.contact.Contact>Contact | None | a vCard attachment or a TrueConf contact link. |

Examples:

```
>>> @.message()
>>> async def on_message(message: Message):
>>> contact = await message.contact
>>> if contact is not None:
>>> await message.answer(f"Phone: {contact.phone_number}")
```

### `` copy_to `async` ⚓︎

```
copy_to(chat_id)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_message>`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

- `text`

- `parse_mode`

### Source

trueconf.com/docs/chatbot-connector/en/messages/#sendMessage

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 (`trueconf.types.responses.send_message_response.SendMessageResponse`)' href=../Responses/#trueconf.types.responses.SendMessageResponse>SendMessageResponse | None | Object containing the result of the message delivery. |

### `` delete `async` ⚓︎

```
delete(for_all=False)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.remove_message>`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`

### Source

trueconf.com/docs/chatbot-connector/en/messages/#removeMessage

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 (`trueconf.types.responses.remove_message_response.RemoveMessageResponse`)' href=../Responses/#trueconf.types.responses.RemoveMessageResponse>RemoveMessageResponse | Object containing the result of the message deletion. |

### `` forward `async` ⚓︎

```
forward(chat_id)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.forward_message>`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`

### Source

trueconf.com/docs/chatbot-connector/en/messages/#forwardMessage

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 (`trueconf.types.responses.forward_message_response.ForwardMessageResponse`)' href=../Responses/#trueconf.types.responses.ForwardMessageResponse>ForwardMessageResponse | Object containing the result of the message forwarding. |

### `` reply `async` ⚓︎

```
reply(text, parse_mode= HTML

class-attribute
instance-attribute
(trueconf.enums.parse_mode.ParseMode.HTML)' href=../Enums/#trueconf.enums.ParseMode.HTML>HTML, *, buttons=None, quote=None)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_message>`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 (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | Text formatting mode. Defaults to HTML. | `` HTML

`class-attribute`
`instance-attribute`
(`trueconf.enums.parse_mode.ParseMode.HTML`)' href=../Enums/#trueconf.enums.ParseMode.HTML>HTML |
| `quote` | `str` | Part of this message to highlight in the reply preview. Must be a substring of the message text; raises `ValueError` otherwise. The quote body follows the message `parse_mode`: HTML and plain text are wrapped into an HTML quote block (plain text is escaped, parse mode becomes HTML), while Markdown uses a `>quote` blockquote. | `None` |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendMessageResponse` | `` SendMessageResponse (`trueconf.types.responses.send_message_response.SendMessageResponse`)' href=../Responses/#trueconf.types.responses.SendMessageResponse>SendMessageResponse | Object containing the result of the message delivery. |

### `` reply_document `async` ⚓︎

```
reply_document(file, caption=None, parse_mode= TEXT

class-attribute
instance-attribute
(trueconf.enums.parse_mode.ParseMode.TEXT)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_document>`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.

### Source

trueconf.com/docs/chatbot-connector/en/files/#working-with-files

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | The file to be uploaded. Must be a subclass of `InputFile`. | required |
| `caption` | `str | None` | Optional caption text to be sent with the file. | `None` |
| `parse_mode` | `` ParseMode (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | Text formatting mode (e.g., Markdown, HTML, or plain text). | `` TEXT

`class-attribute`
`instance-attribute`
(`trueconf.enums.parse_mode.ParseMode.TEXT`)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendFileResponse` | `` SendFileResponse (`trueconf.types.responses.send_file_response.SendFileResponse`)' href=../Responses/#trueconf.types.responses.SendFileResponse>SendFileResponse | Object containing the result of the document upload. If the file was sent with a caption, `caption_message_id` contains the ID of the caption message. |

Examples:

```
>>> @.message()
>>> async def on_message(message:Message):
>>> await message.answer_document(file=FSInputFile("sticker.webp"))
```

### `` reply_photo `async` ⚓︎

```
reply_photo(file, preview, caption=None, parse_mode= TEXT

class-attribute
instance-attribute
(trueconf.enums.parse_mode.ParseMode.TEXT)' href=../Enums/#trueconf.enums.ParseMode.TEXT>TEXT)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_photo>`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.

### Source

trueconf.com/docs/chatbot-connector/en/files/#sending-an-image

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | The photo file to upload. Must be a subclass of `InputFile`. | required |
| `preview` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | None | Optional preview image. Must also be an `InputFile` if provided. | required |
| `caption` | `str | None` | Optional caption to be sent along with the image. | `None` |
| `parse_mode` | `` ParseMode (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | Formatting mode for the caption (e.g., Markdown, HTML, plain text). | `` TEXT

`class-attribute`
`instance-attribute`
(`trueconf.enums.parse_mode.ParseMode.TEXT`)' href=../Enums/#trueconf.enums.ParseMode.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 (`trueconf.types.responses.send_file_response.SendFileResponse`)' href=../Responses/#trueconf.types.responses.SendFileResponse>SendFileResponse | Object containing the result of the photo upload. If the photo was sent with a caption, `caption_message_id` contains the ID of the caption message. |

Examples:

```
>>> @.message()
>>> async def on_message(message:Message):
>>> await message.answer_photo(file=FSInputFile("sticker.webp"), preview=FSInputFile("sticker.webp"))
```

### `` reply_sticker `async` ⚓︎

```
reply_sticker(file)
```

Shortcut for the `async` ' href=../Bot/#trueconf.Bot.send_sticker>`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.

### Source

trueconf.com/docs/chatbot-connector/en/files/#upload-file-to-server-storage

Parameters:

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `` trueconf.types.InputFile (`trueconf.types.input_file.InputFile`)' href=#trueconf.types.InputFile>InputFile | The sticker file in WebP format. Must be a subclass of `InputFile`. | required |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `SendFileResponse` | `` SendFileResponse (`trueconf.types.responses.send_file_response.SendFileResponse`)' href=../Responses/#trueconf.types.responses.SendFileResponse>SendFileResponse | Object containing the result of the sticker delivery. |

Examples:

```
>>> @.message()
>>> async def on_message(message:Message):
>>> await message.answer_sticker(file=FSInputFile("sticker.webp"))
```

### `` save_to_favorites `async` ⚓︎

```
save_to_favorites(copy=False)
```

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=True` only works for text messages and does not preserve metadata (like replies or sender info).

- Non-text messages with `copy=True` will 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 (`trueconf.types.responses.send_message_response.SendMessageResponse`)' href=../Responses/#trueconf.types.responses.SendMessageResponse>SendMessageResponse | ForwardMessageResponse | None | SendMessageResponse | ForwardMessageResponse | None: |
| `` SendMessageResponse (`trueconf.types.responses.send_message_response.SendMessageResponse`)' href=../Responses/#trueconf.types.responses.SendMessageResponse>SendMessageResponse | ForwardMessageResponse | None | Result of sending or forwarding the message. Returns `None` if copying is not supported for the message type. |

### Example

```
@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
```

## `` trueconf.types.SystemMessage `dataclass` ⚓︎

```
SystemMessage(
chat, timestamp, type, author, box, content, message_id
)
```

A system Envelope recorded in chat history or received as a live message.

### `` author `instance-attribute` ⚓︎

```
author
```

### `` box `instance-attribute` ⚓︎

```
box
```

### `` chat `instance-attribute` ⚓︎

```
chat
```

### `` content `class-attribute` `instance-attribute` ⚓︎

```
content = field(metadata={'deserialize': pass_through})
```

### `` message_id `class-attribute` `instance-attribute` ⚓︎

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

### `` timestamp `instance-attribute` ⚓︎

```
timestamp
```

### `` type `instance-attribute` ⚓︎

```
type
```

## `` trueconf.types.RemovedChat `dataclass` ⚓︎

```
RemovedChat(chat_id)
```

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 `@.removed_chat()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#removedChat

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedChat.chat_id`)' href=#trueconf.types.RemovedChat.chat_id>chat_id | `str` | Unique identifier of the chat that was removed. |

Examples:

```
from trueconf.types import RemovedChat

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

## `` trueconf.types.RemovedChatParticipant `dataclass` ⚓︎

```
RemovedChatParticipant(
timestamp, chat_id, user_id, removed_by
)
```

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 `@.removed_chat_participant()`.

### Source

trueconf.com/docs/chatbot-connector/en/chats/#removedChatParticipant

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` timestamp

`instance-attribute`
(`trueconf.types.RemovedChatParticipant.timestamp`)' href=#trueconf.types.RemovedChatParticipant.timestamp>timestamp | `int` | Unix timestamp (milliseconds) of when the event occurred. |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedChatParticipant.chat_id`)' href=#trueconf.types.RemovedChatParticipant.chat_id>chat_id | `str` | Unique identifier of the chat where the participant was removed. |
| `` user_id

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedChatParticipant.user_id`)' href=#trueconf.types.RemovedChatParticipant.user_id>user_id | `str` | TrueConf ID of the participant who was removed. |
| `` removed_by

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedChatParticipant.removed_by`)' href=#trueconf.types.RemovedChatParticipant.removed_by>removed_by | `EnvelopeAuthor` | Information about the user who removed the participant. |

Examples:

```
from trueconf.types import RemovedChatParticipant

@.removed_chat_participant()
async def on_removed(event: RemovedChatParticipant):
print(event.user_id)
```

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` removed_by `class-attribute` `instance-attribute` ⚓︎

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

### `` timestamp `instance-attribute` ⚓︎

```
timestamp
```

### `` user_id `class-attribute` `instance-attribute` ⚓︎

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

## `` trueconf.types.RemovedMessage `dataclass` ⚓︎

```
RemovedMessage(chat_id, message_id, removed_by)
```

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 `@.removed_message()`.

### Source

trueconf.com/docs/chatbot-connector/en/messages/#removedMessage

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` chat_id

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedMessage.chat_id`)' href=#trueconf.types.RemovedMessage.chat_id>chat_id | `str` | Unique identifier of the chat from which the message was removed. |
| `` message_id

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedMessage.message_id`)' href=#trueconf.types.RemovedMessage.message_id>message_id | `str` | Unique identifier of the removed message. |
| `` removed_by

`class-attribute`
`instance-attribute`
(`trueconf.types.RemovedMessage.removed_by`)' href=#trueconf.types.RemovedMessage.removed_by>removed_by | `EnvelopeAuthor` | Information about the user who removed the message. |

Examples:

```
from trueconf.types import RemovedMessage

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

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` message_id `class-attribute` `instance-attribute` ⚓︎

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

### `` removed_by `class-attribute` `instance-attribute` ⚓︎

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

## `` trueconf.types.Update `dataclass` ⚓︎

```
Update(method, type, id, payload)
```

### `` id `instance-attribute` ⚓︎

```
id
```

### `` method `instance-attribute` ⚓︎

```
method
```

### `` payload `instance-attribute` ⚓︎

```
payload
```

### `` type `instance-attribute` ⚓︎

```
type
```

## `` trueconf.types.UploadingProgress `dataclass` ⚓︎

```
UploadingProgress(file_id, progress)
```

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 `@.uploading_progress()`.

### Source

trueconf.com/docs/chatbot-connector/en/files/#uploadingProgress

Attributes:

| Name | Type | Description |
| --- | --- | --- |
| `` file_id

`class-attribute`
`instance-attribute`
(`trueconf.types.UploadingProgress.file_id`)' href=#trueconf.types.UploadingProgress.file_id>file_id | `str` | Unique identifier of the file being uploaded. |
| `` progress

`instance-attribute`
(`trueconf.types.UploadingProgress.progress`)' href=#trueconf.types.UploadingProgress.progress>progress | `int` | Number of bytes uploaded to the server. |

Examples:

```
from trueconf.types import UploadingProgress

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

### `` file_id `class-attribute` `instance-attribute` ⚓︎

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

### `` progress `instance-attribute` ⚓︎

```
progress
```

## `` trueconf.types.contact.Contact `dataclass` ⚓︎

```
Contact(
phone_number=None,
first_name="",
last_name=None,
user_id=None,
vcard=None,
)
```

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 (`[`) provides a user id and a display name. Attributes: | Name | Type | Description | | --- | --- | --- | | `` phone_number `class-attribute` `instance-attribute` (`trueconf.types.contact.Contact.phone_number`)' href=#trueconf.types.contact.Contact.phone_number>phone_number | `str | None` | Phone number parsed from the vCard `TEL` field. Always `None` for TrueConf contacts (no phone in the API). | | `` first_name `class-attribute` `instance-attribute` (`trueconf.types.contact.Contact.first_name`)' href=#trueconf.types.contact.Contact.first_name>first_name | `str` | Given name for vCards (from `N`/`FN`). For TrueConf contacts it holds the whole display name: the server-side name convention (ФИ/ИФ/ФИО) varies, so it is never split. | | `` last_name `class-attribute` `instance-attribute` (`trueconf.types.contact.Contact.last_name`)' href=#trueconf.types.contact.Contact.last_name>last_name | `str | None` | Family name parsed from the structured vCard `N` field. Always `None` for TrueConf contacts and for vCards that lack `N`. | | `` user_id `class-attribute` `instance-attribute` (`trueconf.types.contact.Contact.user_id`)' href=#trueconf.types.contact.Contact.user_id>user_id | `str | None` | TrueConf user id (e.g. `ai-bot@domain`) for TrueConf contacts; `None` for vCards. | | `` vcard `class-attribute` `instance-attribute` (`trueconf.types.contact.Contact.vcard`)' href=#trueconf.types.contact.Contact.vcard>vcard | `str | None` | Raw vCard text for vCard files; `None` otherwise. | `` first_name `class-attribute` `instance-attribute` ⚓︎](trueconf:login&do=profile)

```
first_name = ''
```

### `` last_name `class-attribute` `instance-attribute` ⚓︎

```
last_name = None
```

### `` phone_number `class-attribute` `instance-attribute` ⚓︎

```
phone_number = None
```

### `` user_id `class-attribute` `instance-attribute` ⚓︎

```
user_id = None
```

### `` vcard `class-attribute` `instance-attribute` ⚓︎

```
vcard = None
```

## `` trueconf.types.CallbackQuery `dataclass` ⚓︎

```
CallbackQuery(
command_source, command_payload, command_id=None
)
```

### `` chat `property` ⚓︎

```
chat
```

### `` command `property` ⚓︎

```
command
```

### `` command_id `class-attribute` `instance-attribute` ⚓︎

```
command_id = field(
default=None, metadata={"alias": "commandId"}
)
```

### `` command_payload `class-attribute` `instance-attribute` ⚓︎

```
command_payload = field(
metadata={"alias": "commandPayload"}
)
```

### `` command_source `class-attribute` `instance-attribute` ⚓︎

```
command_source = field(metadata={'alias': 'commandSource'})
```

### `` custom_data `property` ⚓︎

```
custom_data
```

### `` message `property` ⚓︎

```
message
```

### `` answer `async` ⚓︎

```
answer(
text,
*,
answer_type,
status=None,
visibility=None,
level=None,
)
```

### `` edit_message `async` ⚓︎

```
edit_message(
text=UNSET, parse_mode=UNSET, *, buttons=UNSET
)
```

Shortcut for `async` ' href=../Bot/#trueconf.Bot.edit_message>`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 formatting

- `edit_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` keeps the current. | `UNSET` |
| `parse_mode` | `` ParseMode (`trueconf.enums.parse_mode.ParseMode`)' href=../Enums/#trueconf.enums.ParseMode>ParseMode | str | UNSET | Formatting mode. `UNSET` keeps the current `content.parseMode`. | `UNSET` |
| `buttons` | `` trueconf.types.InlineKeyboardMarkup

`dataclass`
(`trueconf.types.keyboard.InlineKeyboardMarkup`)' href=#trueconf.types.InlineKeyboardMarkup>InlineKeyboardMarkup | None | UNSET | New inline keyboard. `UNSET` keeps the current buttons (fetched via `getMessageById`); `None` removes them. | `UNSET` |

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `EditMessageResponse` | `` EditMessageResponse (`trueconf.types.responses.edit_message_response.EditMessageResponse`)' href=../Responses/#trueconf.types.responses.EditMessageResponse>EditMessageResponse | Result of the message update. |

## `` trueconf.types.Chat `dataclass` ⚓︎

```
Chat(chat_id, chat_title, chat_type)
```

### `` chat_id `class-attribute` `instance-attribute` ⚓︎

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

### `` chat_title `class-attribute` `instance-attribute` ⚓︎

```
chat_title = field(metadata={'alias': 'chatTitle'})
```

### `` chat_type `class-attribute` `instance-attribute` ⚓︎

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

## `` 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,
)
```

### `` button_id `class-attribute` `instance-attribute` ⚓︎

```
button_id = field(default=None, metadata={'alias': 'id'})
```

### `` command `class-attribute` `instance-attribute` ⚓︎

```
command = None
```

### `` copy_data `class-attribute` `instance-attribute` ⚓︎

```
copy_data = field(default=None, metadata={'alias': 'data'})
```

### `` custom_data `class-attribute` `instance-attribute` ⚓︎

```
custom_data = field(
default=None, metadata={"alias": "customData"}
)
```

### `` draft `class-attribute` `instance-attribute` ⚓︎

```
draft = False
```

### `` message `class-attribute` `instance-attribute` ⚓︎

```
message = None
```

### `` style `class-attribute` `instance-attribute` ⚓︎

```
style = None
```

### `` text `class-attribute` `instance-attribute` ⚓︎

```
text = field(default=None, metadata={'alias': 'label'})
```

### `` to `class-attribute` `instance-attribute` ⚓︎

```
to = None
```

### `` type `class-attribute` `instance-attribute` ⚓︎

```
type = field(init=False)
```

### `` url `class-attribute` `instance-attribute` ⚓︎

```
url = None
```

### `` wait_reply `class-attribute` `instance-attribute` ⚓︎

```
wait_reply = field(
default=False, metadata={"alias": "waitReply"}
)
```

### `` Config ⚓︎

#### `` omit_default `class-attribute` `instance-attribute` ⚓︎

```
omit_default = True
```

#### `` omit_none `class-attribute` `instance-attribute` ⚓︎

```
omit_none = True
```

#### `` serialize_by_alias `class-attribute` `instance-attribute` ⚓︎

```
serialize_by_alias = True
```

## `` trueconf.types.InlineKeyboardMarkup `dataclass` ⚓︎

```
InlineKeyboardMarkup(buttons)
```

### `` buttons `class-attribute` `instance-attribute` ⚓︎

```
buttons = field(metadata={'alias': 'buttons'})
```

### `` Config ⚓︎

#### `` serialize_by_alias `class-attribute` `instance-attribute` ⚓︎

```
serialize_by_alias = True
```

## `` trueconf.types.content.location.Location `dataclass` ⚓︎

```
Location(latitude, longitude, title)
```

### `` latitude `instance-attribute` ⚓︎

```
latitude
```

### `` longitude `instance-attribute` ⚓︎

```
longitude
```

### `` title `instance-attribute` ⚓︎

```
title
```

## `` trueconf.types.content.voice.Voice `dataclass` ⚓︎

```
Voice(file_id, file_size, mime_type, duration)
```

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

`class-attribute`
`instance-attribute`
(`trueconf.types.content.voice.Voice.file_id`)' href=#trueconf.types.content.voice.Voice.file_id>file_id | `str` | Unique identifier of the voice file. |
| `` file_size

`class-attribute`
`instance-attribute`
(`trueconf.types.content.voice.Voice.file_size`)' href=#trueconf.types.content.voice.Voice.file_size>file_size | `int` | Size of the file in bytes. |
| `` mime_type

`class-attribute`
`instance-attribute`
(`trueconf.types.content.voice.Voice.mime_type`)' href=#trueconf.types.content.voice.Voice.mime_type>mime_type | `str` | MIME type of the voice file. |
| `` duration

`instance-attribute`
(`trueconf.types.content.voice.Voice.duration`)' href=#trueconf.types.content.voice.Voice.duration>duration | `int` | |

### `` bot `property` ⚓︎

```
bot
```

### `` duration `instance-attribute` ⚓︎

```
duration
```

### `` file_id `class-attribute` `instance-attribute` ⚓︎

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

### `` file_size `class-attribute` `instance-attribute` ⚓︎

```
file_size = field(metadata={'alias': 'size'})
```

### `` mime_type `class-attribute` `instance-attribute` ⚓︎

```
mime_type = field(metadata={'alias': 'mimeType'})
```

### `` preview_url `async` `property` ⚓︎

```
preview_url
```

Returns the preview URL of the voice file, if available.

### Source

trueconf.com/docs/chatbot-connector/en/files/#getFileInfo

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `str` | `str` | A URL pointing to the preview version of the voice file. |

### `` url `async` `property` ⚓︎

```
url
```

Returns the direct download URL of the voice file.

### Source

trueconf.com/docs/chatbot-connector/en/files/#getFileInfo

Returns:

| Name | Type | Description |
| --- | --- | --- |
| `str` | `str` | A URL pointing to the original voice file. |

### `` bind ⚓︎

```
bind(bot)
```

### `` download `async` ⚓︎

```
download(dest_path=None, *, file_path=None)
```

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. |

October 1, 2026

September 3, 2025