Получение чата по ссылке

Возвращает информацию о чате или канале по его публичной ссылке, либо информацию о диалоге с пользователем по его username.

Параметры

Поле	Описание
chatLink string @?[a-zA-Z]+[a-zA-Z0-9-_]*	Публичная ссылка на чат или username пользователя. Должна соответствовать регулярному выражению

Результат

Поле	Описание
chat_id integer <int64>	Идентификатор чата
type enum ChatType	Enum: "dialog" "chat" "channel" Тип чата: "dialog" — Диалог. "chat" — Групповой чат. "channel" — Канал.
status enum ChatStatus	Enum: "active" "removed" "left" "closed" "suspended" Статус чата: "active" — Бот является активным участником чата. "removed" — Бот был удалён из чата. "left" — Бот покинул чат. "closed" — Чат был закрыт. "suspended" — Бот был остановлен пользователем. Только для диалогов.
title string Nullable	Отображаемое название чата. Может быть null для диалогов
icon object Image Nullable	Иконка чата
last_event_time integer <int64>	Время последнего события в чате
participants_count integer <int32>	Количество участников чата. Для диалогов всегда 2
owner_id? integer <int64> Nullable	Идентификатор владельца чата (виден только администраторам чата)
participants? object Nullable	Участники чата с временем последней активности. Может быть null, если запрашивается список чатов (видно только администраторам)
is_public boolean	Доступен ли чат публично (для диалогов всегда false)
link? string Nullable	Ссылка на чат
description string Nullable	Описание чата
dialog_with_user object UserWithPhoto Nullable	Данные о пользователе в диалоге (только для чатов типа "dialog")
messages_count? integer Nullable	Количество сообщений в чате (доступно только для групповых чатов и каналов, недоступно для диалогов)
chat_message_id? string Nullable	Идентификатор сообщения, содержащего кнопку, через которую был инициирован чат
pinned_message object Message Nullable	Закреплённое сообщение в чате или канале (возвращается только при запросе конкретного чата)

Пример кода

const MaxBot = require("./src/core/MaxBot");

// Создаём экземпляр клиента с токеном
const client = new MaxBot({
    token: "test",
});

async function getChatByLink() {
    const chat = await client.chats.getChatByLink("@userchat");

    console.log(chat);
}

getChatByLink();