> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Глоссарий: Привязка Telegram

> Справочник моделей, форматов и endpoint-ов привязки Telegram-чата к сотруднику компании.

Справочник понятий, моделей и полей, участвующих в привязке Telegram-чата к аккаунту сотрудника. Сопровождает страницу логики «Привязка Telegram».

## Понятия

| Понятие                    | Значение                                                                                                                                                                                                                                                                                                                                                                |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Пользователь Telegram      | Связка Telegram-чата с сотрудником и компанией, через которую доставляются уведомления в Telegram. Уникальность по паре (компания, пользователь); в привязке участвуют две записи — неподтверждённая (с кодом) и итоговая подтверждённая.                                                                                                                               |
| Формат привязки Telegram   | Проверяет одноразовый код против неподтверждённой записи и переносит чат на текущую компанию и сотрудника. Неоднозначный код (совпал у нескольких ожидающих чатов) отклоняется. При успехе удаляет неподтверждённую запись, освобождает прежнюю привязку сотрудника в этой компании, создаёт/обновляет подтверждённую и отправляет чату сообщение об успешной привязке. |
| Формат отвязки Telegram    | Находит привязку текущего сотрудника в текущей компании и удаляет её. Без входных полей; 404, если привязки нет.                                                                                                                                                                                                                                                        |
| Endpoint привязки Telegram | Создаёт привязку по коду и отдаёт текущую привязку сотрудника. Доступ только авторизованным; отправка кода ограничена 10 попытками в минуту на сотрудника, просмотр привязки — без лимита.                                                                                                                                                                              |
| Endpoint отвязки Telegram  | Удаляет привязку Telegram текущего сотрудника. Доступ только авторизованным.                                                                                                                                                                                                                                                                                            |

## Модели и поля

### Пользователь Telegram

*Связка Telegram-чата с сотрудником и компанией, через которую доставляются уведомления в Telegram. Уникальность по паре (компания, пользователь); в привязке участвуют две записи — неподтверждённая (с кодом) и итоговая подтверждённая.*

**Связи**

| Поле      | Тип   | Описание                                                              |
| --------- | ----- | --------------------------------------------------------------------- |
| Компания  | связь | Компания, к которой привязан чат; при привязке подставляется текущая. |
| Сотрудник | связь | Пользователь, к аккаунту которого привязан Telegram-чат.              |

**Идентификация**

| Поле    | Тип   | Описание                                                                            |
| ------- | ----- | ----------------------------------------------------------------------------------- |
| ID чата | число | Уникальный идентификатор чата в Telegram; ключ переноса при подтверждении привязки. |

**Профиль Telegram**

| Поле             | Тип   | Описание                     |
| ---------------- | ----- | ---------------------------- |
| Имя пользователя | текст | Telegram-логин (@username).  |
| Имя              | текст | Имя из профиля Telegram.     |
| Фамилия          | текст | Фамилия из профиля Telegram. |

**Верификация**

| Поле              | Тип   | Описание                                                                                                                                                                      |
| ----------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Подтверждён       | флаг  | Признак завершённой привязки; неподтверждённая запись создаётся ботом до ввода кода.                                                                                          |
| Код подтверждения | текст | Одноразовый код, который сотрудник вводит для привязки: бот выдаёт 8 цифр и не повторяет код другого ожидающего чата; после подтверждения обнуляется. Срока жизни у кода нет. |

### Формат привязки Telegram

*Проверяет одноразовый код против неподтверждённого пользователя Telegram и переносит чат на текущую компанию и сотрудника. При успехе удаляет неподтверждённую запись, освобождает прежнюю привязку сотрудника в этой компании, создаёт/обновляет подтверждённую и отправляет чату сообщение об успешной привязке. Код 404, если код не совпал или совпал сразу у нескольких ожидающих чатов.*

| Поле              | Тип   | Описание                                                                                                                                                             |
| ----------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Имя пользователя  | текст | Только для чтения; возвращается в ответе как имя привязанного чата.                                                                                                  |
| Код подтверждения | текст | Только для записи; от 6 до 10 символов, обязательное поле для привязки. Диапазон шире выдаваемых 8 цифр, чтобы ранее выданные шестизначные коды продолжали работать. |

### Формат отвязки Telegram

*Находит привязку текущего сотрудника в текущей компании и удаляет её. Без входных полей; 404, если привязки нет.*

Без полей ввода.

### Endpoint привязки Telegram

*Создаёт привязку по коду и отдаёт текущую привязку сотрудника. Доступ только авторизованным; поиск ведётся по записи текущей компании и сотрудника.*

Без собственных полей.

### Endpoint отвязки Telegram

*Удаляет привязку Telegram текущего сотрудника. Доступ только авторизованным.*

Без собственных полей.