## Поиск сессий

> **Метод выходит в обновлении `imopenlines 26.700.0` и доступен пока не на всех порталах Битрикс24.** Если обновление на ваш портал ещё не пришло, API вернёт `422 METHOD_NOT_YET_AVAILABLE` — это признак того, что метод на портале ещё не выпущен, а не ошибка интеграции.

`POST /v1/openlines/sessions/search`

Список сессий Открытых линий с фильтрами и пагинацией — основной метод для детализированных отчётов и выгрузки во внешние системы аналитики. Пустое тело `{}` вернёт первую страницу всех видимых сессий.

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `configId` | number | нет | Идентификатор линии. Источник: [`GET /v1/openline-configs`](/docs/openlines/config/list) |
| `configIdList` | number[] | нет | Список идентификаторов линий. Источник: [`GET /v1/openline-configs`](/docs/openlines/config/list) |
| `operatorId` | number | нет | Идентификатор оператора. Источник: [`GET /v1/users`](/docs/entities/users) |
| `operatorIdList` | number[] | нет | Список идентификаторов операторов. Источник: [`GET /v1/users`](/docs/entities/users) |
| `source` | string | нет | Код коннектора, например `livechat`. Значения — поле `sessions[].source` в ответе этого метода или `sessionsBySource[].source` в ответе [`POST /v1/openlines/stats`](/docs/openlines/stats) |
| `sourceList` | string[] | нет | Список кодов коннекторов |
| `status` | string | нет | Статус сессии: `new` / `answered` / `closed` / `spam` / `paused` |
| `closeReason` | string | нет | Причина закрытия: `operator` / `auto` / `spam` / `client` / `replyLimit` |
| `dateCreateFrom` | string | нет | Начало периода создания, ISO 8601. Период `dateCreateFrom`..`dateCreateTo` — не больше 1 года |
| `dateCreateTo` | string | нет | Конец периода создания, ISO 8601 |
| `dateCloseFrom` | string | нет | Начало периода закрытия, ISO 8601 |
| `dateCloseTo` | string | нет | Конец периода закрытия, ISO 8601 |
| `vote` | string | нет | Клиентская оценка: `like` / `dislike` / `none` / `any` |
| `hasVoteHead` | string | нет | Есть ли оценка руководителя: `Y` / `N` |
| `kpiFirstAnswer` | string | нет | Уложились ли в норматив времени первого ответа (SLA): `Y` / `N`. Требует ограниченного периода (`dateCreateFrom`+`dateCreateTo` либо `dateCloseFrom`+`dateCloseTo`) |
| `hasCrm` | string | нет | Есть ли привязка к CRM: `Y` / `N` |
| `waitAnswerFrom` | number | нет | Мин. время до первого ответа, секунды |
| `waitAnswerTo` | number | нет | Макс. время до первого ответа, секунды |
| `waitCloseFrom` | number | нет | Мин. время до закрытия, секунды |
| `waitCloseTo` | number | нет | Макс. время до закрытия, секунды |
| `order` | string | нет | Поле сортировки: `dateCreate` / `dateClose` / `waitAnswer` / `waitClose` (по умолчанию `dateCreate`) |
| `orderDirection` | string | нет | Направление: `asc` / `desc` (по умолчанию `desc`) |
| `limit` | number | нет | Размер страницы, 1..200 (по умолчанию 50). Значение вне диапазона не даёт ошибки — возвращается страница из 50 записей |
| `offset` | number | нет | Смещение для пагинации (по умолчанию 0) |

Фильтры `status` и `closeReason` взаимоисключающи: `closeReason` уже подразумевает закрытую сессию. Фильтр `hasVoteHead` применяется только к линиям, где у пользователя есть право на оценку руководителя.

Фильтра по типу CRM-сущности нет — по CRM доступен только флаг `hasCrm` (есть привязка или нет). Если нужен отбор по конкретному типу, фильтруйте на своей стороне по полям `crmEntityType` / `crmEntityId` из ответа.

**Пагинация.** Следующая страница — тот же запрос с `offset`, увеличенным на `limit`, пока `data.hasNextPage` равно `true`. При постраничной выгрузке фиксируйте верхнюю границу периода — `dateCreateTo` равным моменту начала выгрузки. Без фиксированной границы новые сессии, пришедшие во время выгрузки, сдвигают страницы, и записи на стыках могут повториться или пропасть.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/sessions/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "configId": 1,
    "status": "closed",
    "dateCreateFrom": "2024-05-01T00:00:00+03:00",
    "dateCreateTo": "2024-05-31T23:59:59+03:00",
    "limit": 2
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/sessions/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "configId": 1,
    "status": "closed",
    "dateCreateFrom": "2024-05-01T00:00:00+03:00",
    "dateCreateTo": "2024-05-31T23:59:59+03:00",
    "limit": 2
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/sessions/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    configId: 1,
    status: 'closed',
    dateCreateFrom: '2024-05-01T00:00:00+03:00',
    dateCreateTo: '2024-05-31T23:59:59+03:00',
    limit: 2,
  }),
})
const { data } = await res.json()
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/sessions/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    configId: 1,
    status: 'closed',
    dateCreateFrom: '2024-05-01T00:00:00+03:00',
    dateCreateTo: '2024-05-31T23:59:59+03:00',
    limit: 2,
  }),
})
const { data } = await res.json()
```

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

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успешном ответе |
| `data.sessions` | array | Сессии текущей страницы. Пустой массив, если под фильтры ничего не попало |
| `data.sessions[].id` | number | Идентификатор сессии |
| `data.sessions[].configId` | number | Идентификатор линии. Описание линии — [`GET /v1/openline-configs/:id`](/docs/openlines/config/get) |
| `data.sessions[].source` | string | Код коннектора |
| `data.sessions[].operatorId` | number \| null | Идентификатор оператора, завершившего сессию. Сотрудник — [`GET /v1/users`](/docs/entities/users) |
| `data.sessions[].userId` | number | Внутренний идентификатор клиента |
| `data.sessions[].userCode` | string | Внешний код клиента в коннекторе |
| `data.sessions[].chatId` | number | Идентификатор чата Открытой линии. Один чат проходит через несколько сессий |
| `data.sessions[].dateCreate` | string | Дата создания сессии, ISO 8601 |
| `data.sessions[].dateClose` | string \| null | Дата закрытия сессии, ISO 8601 |
| `data.sessions[].dateFirstAnswer` | string \| null | Дата первого ответа, ISO 8601 |
| `data.sessions[].dateOperatorAnswer` | string \| null | Дата, когда оператор начал работу с сессией, ISO 8601. Это другой момент, чем `dateFirstAnswer` |
| `data.sessions[].status` | string | Статус: `new` / `answered` / `closed` / `spam` / `paused` |
| `data.sessions[].closeReason` | string \| null | Причина закрытия: `operator` / `auto` / `spam` / `client` / `replyLimit` |
| `data.sessions[].vote` | string | Клиентская оценка: `like` / `dislike` / `none` |
| `data.sessions[].voteHead` | number \| null | Оценка руководителя. `null`, если оценки нет или у пользователя нет права на оценку руководителя |
| `data.sessions[].commentHead` | string \| null | Комментарий руководителя. `null` в тех же случаях, что `voteHead` |
| `data.sessions[].crmEntityType` | string \| null | Тип привязанной CRM-сущности, например `lead` или `deal`. `null`, если привязки нет или нет права чтения связанной сущности |
| `data.sessions[].crmEntityId` | number \| null | Идентификатор привязанной CRM-сущности. Карточка — по типу из `crmEntityType`: лид [`GET /v1/leads/:id`](/docs/entities/leads/get), сделка [`GET /v1/deals/:id`](/docs/entities/deals/get), контакт [`GET /v1/contacts/:id`](/docs/entities/contacts/get), компания [`GET /v1/companies/:id`](/docs/entities/companies/get) |
| `data.sessions[].queueTransfers` | number | Число переназначений в очереди. Сами переназначения — [История переназначений](/docs/openlines/sessions/transfers) |
| `data.sessions[].waitAnswer` | number \| null | Время до первого ответа, секунды. Хранимая метрика — не вычисляйте её из дат выше, значения могут не совпасть |
| `data.sessions[].waitClose` | number \| null | Время до закрытия, секунды. Хранимая метрика, как `waitAnswer` |
| `data.sessions[].kpiFirstAnswer` | boolean \| null | Уложились ли в норматив времени первого ответа |
| `data.sessions[].messageCount` | number | Число сообщений в сессии |
| `data.hasNextPage` | boolean | Есть ли следующая страница |

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

```json
{
  "success": true,
  "data": {
    "sessions": [
      {
        "id": 781,
        "configId": 1,
        "source": "livechat",
        "operatorId": 29,
        "userId": 1211,
        "userCode": "livechat|1|2073|1211",
        "chatId": 2075,
        "dateCreate": "2024-05-13T15:08:33+03:00",
        "dateClose": "2024-06-13T15:46:31+03:00",
        "dateFirstAnswer": "2024-05-13T15:12:05+03:00",
        "dateOperatorAnswer": "2024-05-13T15:09:14+03:00",
        "status": "closed",
        "closeReason": "operator",
        "vote": "like",
        "voteHead": null,
        "commentHead": null,
        "crmEntityType": "contact",
        "crmEntityId": 2399,
        "queueTransfers": 0,
        "waitAnswer": 212,
        "waitClose": 116,
        "kpiFirstAnswer": false,
        "messageCount": 5
      },
      {
        "id": 779,
        "configId": 1,
        "source": "livechat",
        "operatorId": 29,
        "userId": 1209,
        "userCode": "livechat|1|2069|1209",
        "chatId": 2071,
        "dateCreate": "2024-05-13T15:05:52+03:00",
        "dateClose": "2024-05-13T16:11:52+03:00",
        "dateFirstAnswer": "2024-05-13T15:06:50+03:00",
        "dateOperatorAnswer": "2024-05-13T15:06:41+03:00",
        "status": "closed",
        "closeReason": "operator",
        "vote": "none",
        "voteHead": null,
        "commentHead": null,
        "crmEntityType": "deal",
        "crmEntityId": 5317,
        "queueTransfers": 0,
        "waitAnswer": 58,
        "waitClose": 144,
        "kpiFirstAnswer": true,
        "messageCount": 2
      }
    ],
    "hasNextPage": false
  }
}
```

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

`422` — период превышает 1 год:

```json
{
  "success": false,
  "error": { "code": "BITRIX_ERROR", "message": "Запрошенный период превышает максимум в 1 год", "b24Code": "PERIOD_TOO_LARGE" }
}
```

Текст `error.message` локализован. Для обработки ошибки сверяйте `error.b24Code`.

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_JSON_BODY` | Тело запроса не разобралось как JSON. JSON разбирается до проверки полей, поэтому про отсутствующие параметры ответ ничего не говорит |
| 400 | `INVALID_PARAMS` | Тело запроса не объект |
| 422 | `BITRIX_ERROR` (`error.b24Code: PERIOD_TOO_LARGE`) | Период создания или закрытия превышает 1 год |
| 422 | `BITRIX_ERROR` (`error.b24Code: OFFSET_TOO_LARGE`) | `offset` превышает максимум — сузьте период или фильтры |
| 422 | `BITRIX_ERROR` (`error.b24Code: INVALID_FILTER`) | Недопустимое значение фильтра, одновременно переданы `status` и `closeReason`, либо `kpiFirstAnswer` без ограниченного периода |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Обновление `imopenlines 26.700.0` ещё не пришло на портал. Ответ содержит поле `error.release` со значением `imopenlines 26.700.0` |
| 403 | `B24_TARIFF_RESTRICTION` | Тариф не включает статистику Открытых линий (`report_open_lines`) |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `imopenlines` |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |

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

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

- [Метрики по сессиям](/docs/openlines/sessions/stats)
- [История переназначений](/docs/openlines/sessions/transfers)
- [Открыть чат клиента](/docs/openlines/sessions/open)
- [Начать сессию](/docs/openlines/sessions/start)
- [Сессии открытых линий](/docs/openlines/sessions)
- [Открытые линии](/docs/openlines)
