Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 2.62 KB

File metadata and controls

72 lines (57 loc) · 2.62 KB

GetChats

dev.max.ru/docs-api/methods/GET/chats

Метод предназначен для получения списка групповых чатов, в которых участвует бот, информации о каждом чате и маркера для перехода к следующей странице списка.

Запрос {#request}

Поля запроса {#request-parameters}

Поле     Тип       Обязательный Описание                                                      
count   integer Нет           Максимальное количество возвращаемых чатов (по умолчанию 50)
marker integer Нет           Маркер пагинации для получения следующей страницы списка чатов

Пример запроса {#request-example}

Синхронный запрос:

response = bot.chats.GetChats(GetChatsReq(
    count=50,
    marker=1679823456
))

Асинхронный запрос:

response = await bot.chats.GetChatsAsync(GetChatsReq(
    count=50,
    marker=1679823456
))

Ответ {#response}

Поля ответа {#response-parameters}

Поле     Тип       Описание                                              
chats   array Массив объектов с информацией о чатах
marker integer Маркер для получения следующей страницы (если есть)  

Пример тела ответа {#response-example-body}

{
    "chats": [
        {
            "chat_id": -72270307698082,
            "type": "chat",
            "status": "active",
            "title": "Green-API group",
            "last_event_time": 1773990351033,
            "participants_count": 4,
            "is_public": false,
            "messages_count": 4
        },
        {
            "chat_id": -72270307698082,
            "type": "chat",
            "status": "active",
            "title": "Public group",
            "last_event_time": 1773990351033,
            "participants_count": 4,
            "is_public": true,
            "messages_count": 4
        }
    ]
}