30.06.2026 11:02

Join

[POST] .../v1/chat/join

Добавляет текущего пользователя в канал (chat_type = Channel) как участника User/Member.

Входные параметры

Название Тип данных Обязательность Описание
id String Обязательный UUID канала

Ограничения и проверки

  • id должен быть корректным UUID существующего канала.
  • Метод применяется только к обычным каналам (chat_type = Channel) без связи с бизнес-сущностью.
  • Текущий пользователь добавляется только как User/Member; роль нельзя передать в запросе.
  • Для чатов типа Group и Individual вступление через этот метод запрещено.
  • Для entity-чатов (Task/Lead/Deal/Ticket) вступление через этот метод запрещено; состав таких чатов управляется связанной сущностью.
  • В канале должен быть минимум один активный User/Staff.
  • Если текущий пользователь уже является активным участником канала, метод возвращает row_affected = 0.
  • Если текущий пользователь ранее вышел из канала, повторное вступление реактивирует его участие с ролью Member.
  • При успешном вступлении создаётся системное сообщение ParticipantJoined и публикуется событие ChatParticipantsSet.

Пример запроса

{
  "id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef"
}

Выходные параметры

Название Тип данных Описание
result.row_affected Int64 Количество изменённых строк: 1, если пользователь вступил в канал; 0, если уже был активным участником
result.ids Array UUID канала, если участие было изменено; иначе null

Пример ответа

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": ["6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef"]
  }
}