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

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

### Параметры <a href="#parametry" id="parametry"></a>

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

### Результат <a href="#rezultat" id="rezultat"></a>

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

### Пример кода

```javascript
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();
```
