Для AI-агентов: markdown этой страницы — /docs-content/chats/management/join.md индекс документации — /llms.txt

Вступить в чат

POST /v1/chats/:dialogId/join

Текущий пользователь вступает в чат, куда можно войти без приглашения. Так можно вступить в открытый чат или канал, открытую линию, общий чат портала, чат комментариев, внешний чат или открытый коллаб. В чате появляется системное сообщение о вступлении.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID чата в виде chatN, например chat42. Найти ID чата — поиск чатов по тексту

Эндпоинт не принимает ни параметров строки запроса, ни тела запроса: любой параметр или поле тела отклоняется с 400 INVALID_PARAMS до обращения к Битрикс24.

Примеры

curl — личный ключ

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat42/join \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat42/join \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/join', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Вступили:', data.result) // true

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/join', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — пользователь в чате

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

Пример ответа при ошибке

422 — в чат этого типа нельзя вступить самостоятельно:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "WRONG_MESSAGE_TYPE",
    "b24Code": "WRONG_MESSAGE_TYPE"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр строки запроса или поле тела — эндпоинт их не принимает
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 отказал с кодом WRONG_MESSAGE_TYPE в error.b24Code — в чат этого типа нельзя вступить самостоятельно
422 BITRIX_ERROR Битрикс24 отказал с кодом CHAT_NOT_FOUND в error.b24Code — чата нет на портале
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя при использовании алиаса me
403 BITRIX_ACCESS_DENIED Битрикс24 отказал с кодом ACCESS_DENIED: пользователю нельзя вступать в чаты или у него нет доступа к этому чату
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

Полный список общих ошибок API — Ошибки.

Известные особенности

Закрытый групповой чат — только по приглашению. В обычный групповой чат без флага открытости добавляет участник с правом приглашать — добавление участников. Открытым чат делает поле searchable: "Y" при создании в режиме v2.

Повторное вступление. Если вы уже участник чата, куда можно войти без приглашения, ответ тот же — data.result: true. Проверка типа идёт раньше проверки участия: в закрытом чате WRONG_MESSAGE_TYPE получает и его участник.

Смотрите также