## Список быстрых ответов

`GET /v1/openline-configs/:lineId/quick-replies`

Возвращает быстрые ответы открытой линии вместе с её разделами и правами пользователя ключа на просмотр и создание ответов. Используйте метод, чтобы найти ответ по тексту, получить ID ответа для правки или ID раздела для создания.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|----------|-----|:-----:|-----------|----------|
| `lineId` (path) | integer | да | — | ID открытой линии. Список: [`GET /v1/openline-configs`](/docs/openlines/config/list) |
| `search` (query) | string | нет | — | Строка поиска по названию и тексту ответа |
| `sectionId` (query) | integer | нет | — | ID раздела этой линии из `data.sections`. Возвращает только ответы этого раздела |
| `offset` (query) | integer | нет | `0` | Сколько записей пропустить от начала выборки |
| `limit` (query) | integer | нет | `50` | Сколько записей вернуть, от `0` до `50`. Значение больше `50` уменьшается до `50`. При `0` массив `replies` пустой, а `totalCount`, `sections` и `permissions` приходят |

**Пагинация.** За один вызов приходит не больше 50 ответов. Чтобы прочитать все, увеличивайте `offset` на число полученных записей, пока сумма `offset` и длины `replies` не достигнет `totalCount`.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies?limit=20" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies?limit=20" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies?limit=20',
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const { data } = await res.json()
console.log(`Ответов: ${data.totalCount}`, data.replies)
```

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

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies?limit=20',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const { data } = await res.json()
console.log(`Ответов: ${data.totalCount}`, data.replies)
```

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

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успехе |
| `data.replies` | array | Быстрые ответы текущей страницы выборки |
| `data.replies[].id` | integer | ID быстрого ответа |
| `data.replies[].name` | string | Название ответа |
| `data.replies[].text` | string | Текст ответа |
| `data.replies[].sectionId` | integer | ID раздела. `0` — ответ без раздела |
| `data.replies[].canEdit` | boolean | Может ли пользователь ключа изменить ответ |
| `data.replies[].rating` | number \| string | Рейтинг ответа |
| `data.sections` | array | Все разделы быстрых ответов этой линии |
| `data.sections[].id` | integer | ID раздела. Передаётся в `sectionId` |
| `data.sections[].name` | string | Название раздела |
| `data.sections[].code` | string | Символьный код раздела |
| `data.totalCount` | integer | Сколько ответов подходит под `search` и `sectionId` без учёта `offset` и `limit` |
| `data.permissions.canView` | boolean | Может ли пользователь ключа просматривать быстрые ответы линии. При `false` пустой `replies` не означает, что ответов нет |
| `data.permissions.canCreate` | boolean | Может ли пользователь ключа создавать быстрые ответы в линии |

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

```json
{
  "success": true,
  "data": {
    "replies": [
      {
        "id": 7277,
        "name": "Здравствуйте, оператор ответит в течение минуты",
        "text": "Здравствуйте, оператор ответит в течение минуты",
        "sectionId": 123,
        "canEdit": true,
        "rating": 1
      },
      {
        "id": 7279,
        "name": "Доставка по городу занимает один-два рабочих дня",
        "text": "Доставка по городу занимает один-два рабочих дня",
        "sectionId": 0,
        "canEdit": true,
        "rating": 1
      }
    ],
    "sections": [
      { "id": 123, "name": "Приветствие", "code": "GREETING" },
      { "id": 125, "name": "Оплата", "code": "PAYMENT" },
      { "id": 127, "name": "Доставка", "code": "DELIVERY" },
      { "id": 129, "name": "Общее", "code": "COMMON" }
    ],
    "totalCount": 2,
    "permissions": {
      "canView": true,
      "canCreate": true
    }
  }
}
```

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

404 — открытой линии с таким `lineId` нет:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Record not found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `lineId` не положительное целое число |
| 400 | `INVALID_PARAMS` | `offset` или `limit` отрицательные либо не целые, `search` не строка |
| 400 | `INVALID_PARAMS` | `sectionId` не целое неотрицательное число |
| 400 | `INVALID_PARAMS` | Параметр строки запроса передан дважды или в форме объекта, например `search=a&search=b` или `search[x]=a` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа нет действующей авторизации в Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `imopenlines` |
| 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал пользователю ключа в доступе |
| 404 | `ENTITY_NOT_FOUND` | Открытой линии с таким `lineId` нет |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку. Текст — в `message` |
| 429 | `RATE_LIMITED` | Превышен собственный лимит метода. Общий потолок платформы — 120 запросов в минуту на портал, он делится между репликами платформы, поэтому код может прийти раньше 120-го запроса. Действующее значение — в заголовке `x-ratelimit-limit` |
| 502 | `OPENLINE_OPERATOR_FAILED` | Битрикс24 вернул ответ неожиданной формы |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя. Чтение безопасно повторить |

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

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

**Разделы и ответы у каждой линии свои.** `data.sections` перечисляет разделы только линии из пути, и ID раздела другой линии в `sectionId` здесь не найдёт ни одного ответа. Фильтр по несуществующему разделу возвращает пустой `replies` с `totalCount: 0`, а не ошибку.

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

- [Создать быстрый ответ](/docs/openlines/quick-replies/create)
- [Изменить быстрый ответ](/docs/openlines/quick-replies/update)
- [Удалить быстрый ответ](/docs/openlines/quick-replies/delete)
- [Быстрые ответы открытой линии](/docs/openlines/quick-replies)
- [Список конфигураций открытых линий](/docs/openlines/config/list)