## Вступить в чат по коду

`POST /v1/chats/join-by-code`

Добавляет вас в чат, куда ведёт ссылка с этим кодом, и возвращает ID диалога. Код берут из основной ссылки на чат или из личной ссылки участника.

## Поля запроса (body)

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `code` | string | да | Код ссылки — поле `code` объекта ссылки или параметр `IM_CODE` её адреса. От 1 до 64 печатных символов без пробелов |

Другие поля тела и параметры запроса отклоняются с `400 INVALID_PARAMS`.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/join-by-code" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code": "Xk9pQ2mZ7rT4vB1c"}'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/join-by-code" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code": "Xk9pQ2mZ7rT4vB1c"}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/join-by-code', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ code: 'Xk9pQ2mZ7rT4vB1c' }),
})

const { data } = await res.json()
console.log('Диалог:', data.dialogId)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/join-by-code', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ code: 'Xk9pQ2mZ7rT4vB1c' }),
})

const { data } = await res.json()
console.log('Диалог:', data.dialogId)
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.dialogId` | string | ID диалога чата вида `chatXXX` — для [чтения сообщений](/docs/chats/messages/list) и [отправки](/docs/chats/messages/send) |

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

```json
{
  "success": true,
  "data": {
    "dialogId": "chat42"
  }
}
```

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

422 — ссылка отозвана:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "SHARING_LINK_REVOKED",
    "b24Code": "SHARING_LINK_REVOKED"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Нет `code`, `code` не похож на код ссылки, тело не объект, передано другое поле тела или параметр запроса. Проверяется до обращения к Битрикс24 |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`. `SHARING_LINK_REVOKED` — ссылка отозвана, `SHARING_LINK_EXPIRED` — срок истёк, `SHARING_LINK_USES_LIMIT_REACHED` — лимит вступлений исчерпан, `SHARING_LINK_NOT_FOUND` — ссылки с таким кодом нет |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 ответил кодом «не найдено» без уточнения, код портала — в `error.b24Code` |
| 403 | `BITRIX_ACCESS_DENIED` | Нет права вступать в чаты — Битрикс24 отказал с кодом `ACCESS_DENIED` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения — см. [права доступа](/docs/access-rights) |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

**Повторное вступление ничего не меняет.** Если вы уже участник чата, вызов отвечает тем же `dialogId` и состав чата не меняет.

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

- [Получить личную ссылку на чат](/docs/chats/sharing/individual-link)
- [Получить ссылку по коду](/docs/chats/sharing/link-get)
- [Список участников](/docs/chats/members/list)
- [Ссылки и гости](/docs/chats/sharing)