Схемы API

В этом разделе описаны основные схемы данных, используемые в API ImperiumGuardBot. Понимание этих схем поможет вам эффективно интегрировать ваши системы с ботом.

Схема пользователя (User)

Схема User представляет пользователя Telegram в контексте чата, где используется ImperiumGuardBot.

User

Пример данных пользователя

{
  "id": 123456789,
  "first_name": "Иван",
  "username": "ivan_petrov",
  "reputation": 42,
  "joined": "2023-01-15T10:30:00Z",
  "chat_id": -1001234567890
}

Описание полей

Поле	Тип	Описание
id	integer	Уникальный идентификатор пользователя в Telegram
first_name	string	Имя пользователя
username	string	Имя пользователя в Telegram (без символа @)
reputation	integer	Репутация пользователя в чате
joined	string (date-time)	Дата и время первого появления пользователя в чате
chat_id	integer	Идентификатор чата, к которому относится информация

Схема ограничения (Restriction)

Схема Restriction представляет ограничение, наложенное на пользователя в чате (бан, мут, предупреждение).

Restriction

Пример данных ограничения

{
  "id": 987654,
  "chat_id": -1001234567890,
  "user_id": 123456789,
  "moder_id": 987654321,
  "type": "mute",
  "reason": "Спам в чате",
  "time": "2023-05-15T14:30:00Z",
  "end_time": "2023-05-16T14:30:00Z",
  "message": {
    "message_id": 12345,
    "text": "Привет всем! Купите мой товар..."
  },
  "canceled": false,
  "reactions": 0
}

Описание полей

Поле	Тип	Описание
id	integer	Уникальный идентификатор ограничения
chat_id	integer	Идентификатор чата, в котором наложено ограничение
user_id	integer	Идентификатор пользователя, на которого наложено ограничение
moder_id	integer	Идентификатор модератора, наложившего ограничение (-993 для ограничений через API)
type	string	Тип ограничения: "ban" (бан), "mute" (мут), "warn" (предупреждение)
reason	string	Причина наложения ограничения
time	string (date-time)	Дата и время наложения ограничения
end_time	string (date-time)	Дата и время окончания ограничения (null для бессрочных ограничений)
message	object	Объект сообщения, связанного с нарушением (может быть null)
canceled	boolean	Флаг, указывающий, было ли ограничение отменено
reactions	integer	Количество реакций, оставленных пользователем во время действия ограничения (только для типа "mute")

Типы ограничений

ImperiumGuardBot поддерживает следующие типы ограничений:

Тип	Описание	Параметры
ban	Блокировка пользователя в чате	minutes (опционально) - продолжительность в минутах, если не указано - бессрочно
mute	Запрет отправки сообщений	minutes (обязательно) - продолжительность в минутах
warn	Предупреждение пользователю	Не требует дополнительных параметров

Использование схем в API

При работе с API ImperiumGuardBot вы будете получать и отправлять данные в соответствии с этими схемами. Например:

Получение информации о пользователе

GET /user?id=123456789
Authorization: Bearer your_token_here

Ответ будет соответствовать схеме User.

Создание нового ограничения

POST /restriction
Authorization: Bearer your_token_here
Content-Type: application/json

{
  "user": 123456789,
  "type": "mute",
  "reason": "Спам в чате",
  "minutes": 120,
  "virtual": false
}

Ответ будет соответствовать схеме Restriction.

Дополнительные ресурсы

Для получения более подробной информации о работе с API и примеров использования схем, обратитесь к разделу Примеры использования API.

04 сентября 2025