Перейти к содержанию

GetMessages

GetMessages(bot, chat_id=None, message_ids=None, from_time=None, to_time=None, count=50)

Bases: BaseConnection

Класс для получения сообщений из чата через API.

https://dev.max.ru/docs-api/methods/GET/messages

Attributes:

Name Type Description
bot Bot

Экземпляр бота.
chat_id int

Идентификатор чата.
message_ids List[str] | None

Фильтр по идентификаторам сообщений.
from_time datetime | int | None

Начальная временная метка.
to_time datetime | int | None

Конечная временная метка.
count int

Максимальное число сообщений.
Source code in maxapi/methods/get_messages.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(
    self,
    bot: "Bot",
    chat_id: Optional[int] = None,
    message_ids: Optional[List[str]] = None,
    from_time: Optional[Union[datetime, int]] = None,
    to_time: Optional[Union[datetime, int]] = None,
    count: int = 50,
):
    if count is not None and not (1 <= count <= 100):
        raise ValueError("count не должен быть меньше 1 или больше 100")

    self.bot = bot
    self.chat_id = chat_id
    self.message_ids = message_ids
    self.from_time = from_time
    self.to_time = to_time
    self.count = count

fetch() async

Выполняет GET-запрос для получения сообщений с учётом параметров фильтрации.

Преобразует datetime в UNIX timestamp при необходимости.

Returns:

Name Type Description
Messages Messages

Объект с полученными сообщениями.
Source code in maxapi/methods/get_messages.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
async def fetch(self) -> Messages:
    """
    Выполняет GET-запрос для получения сообщений с учётом параметров фильтрации.

    Преобразует datetime в UNIX timestamp при необходимости.

    Returns:
        Messages: Объект с полученными сообщениями.
    """

    bot = self._ensure_bot()

    params = bot.params.copy()

    if self.chat_id:
        params["chat_id"] = self.chat_id

    if self.message_ids:
        params["message_ids"] = ",".join(self.message_ids)

    if self.from_time:
        if isinstance(self.from_time, datetime):
            params["from"] = to_ms(self.from_time)
        else:
            params["from"] = self.from_time

    if self.to_time:
        if isinstance(self.to_time, datetime):
            params["to"] = to_ms(self.to_time)
        else:
            params["to"] = self.to_time

    params["count"] = self.count

    response = await super().request(
        method=HTTPMethod.GET,
        path=ApiPath.MESSAGES,
        model=Messages,
        params=params,
    )

    return cast(Messages, response)