## Открыть чат клиента

`POST /v1/openlines/sessions/open`

Находит чат Открытой линии по коду клиента в коннекторе. Идентификатор найденного чата нужен, чтобы взять диалог в работу и выполнять действия оператора.

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|----------|
| `userCode` | string | да | Код клиента в коннекторе вида `connector\|lineId\|externalChatId\|userId`. Передаётся без изменений. Источник: поле `userCode` в ответе [`POST /v1/openlines/sessions/search`](/docs/openlines/sessions/search) |

## Примеры

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/sessions/open \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userCode": "doccheck|59|cloud-chat-2|1575"}'
```

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/sessions/open \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userCode": "doccheck|59|cloud-chat-2|1575"}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/sessions/open', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userCode: 'doccheck|59|cloud-chat-2|1575' }),
})

const { data } = await res.json()
console.log('ID чата:', data.chatId)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/sessions/open', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userCode: 'doccheck|59|cloud-chat-2|1575' }),
})

const { data } = await res.json()
```

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

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успешном ответе |
| `data.chatId` | number | Идентификатор чата Открытой линии. См. [Идентификатор чата](/docs/openlines/operator#идентификатор-чата) |

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

```json
{
  "success": true,
  "data": {
    "chatId": 5255
  }
}
```

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

400 — не передан код клиента:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "userCode is required and must be a non-empty string"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `MISSING_REQUIRED_FIELDS` | Поле `userCode` не передано, не строка, пустое или состоит из пробелов |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил запрос. Текст отказа — в `message` |
| 403 | `BITRIX_ACCESS_DENIED` | У сотрудника, от имени которого идёт вызов, нет прав на действие, или клиента с таким `userCode` нет. Обе причины дают одинаковый ответ |
| 502 | `OPENLINE_OPERATOR_FAILED` | Битрикс24 не вернул идентификатор чата |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `imopenlines` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает только на чтение. Поиск чата по коду клиента требует ключа с разрешённой записью |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Ключ не опознан |
| 401 | `TOKEN_MISSING` | У личного ключа нет доступа к порталу Битрикс24, у ключа приложения не передан токен сессии в `Authorization` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или соединение с ним оборвалось до полного ответа |

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

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

- **Вызов не начинает сессию.** Для диалога с закрытой сессией метод возвращает `chatId`, а сессия остаётся закрытой. Взять диалог в работу — [`POST /v1/openlines/sessions/start`](/docs/openlines/sessions/start).

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

- [Поиск сессий](/docs/openlines/sessions/search)
- [Действия оператора и своя пауза](/docs/openlines/operator)
- [Открытые линии](/docs/openlines)