Skip to content

GetChat.md

Latest commit

 

History

History
76 lines (61 loc) · 4.58 KB

GetChat.md

File metadata and controls

76 lines (61 loc) · 4.58 KB

GetChat

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

Возвращает информацию о групповом чате по его ID

Запрос {#request}

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

Поле     Тип       Обязательный Описание                        
ChatID integer Да           ID запрашиваемого чата  

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

response, err := bot.Chats.GetChat(
    context.Background(), 
    &models.GetChatReq{
        ChatID: 123456789,
    }
)

Ответ {#response}

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

Объект Chat

Поле Тип Описание
chat_id integer ID чата
type string Для групп принимает значение chat
status string Статус чата. Возможные значения:
active — Бот является активным участником чата.
removed — Бот был удалён из чата.
left — Бот покинул чат.
closed — Чат был закрыт.
title string Обновленное название чата (если было изменено)
icon object Иконка чата
last_event_time integer Время последнего события в чате
participants_count integer Количество участников чата. Для диалогов всегда 2
owner_id integer ID владельца чата
participants object Участники чата с временем последней активности
is_public boolean Доступен ли чат публично
link string Ссылка на чат
description string Описание чата
dialog_with_user object Данные о пользователе в диалоге
chat_message_id string ID сообщения, содержащего кнопку, через которую был инициирован чат
pinned_message object Закреплённое сообщение в чате

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

Успех:

{
    "chat_id": -722703071564882,
    "type": "chat",
    "status": "active",
    "title": "Group chat",
    "last_event_time": 1774253213015,
    "participants_count": 3,
    "is_public": false,
    "owner_id": 12345789,
    "participants": {
        "123456789": 1774253340181,
        "987654321": 0,
        "0123456789": 1773988397845
    },
    "messages_count": 4
}