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

Быстрые ответы открытой линии

Шаблоны ответов, которые оператор открытой линии вставляет в диалог с клиентом. Подраздел читает ответы и разделы линии, создаёт, правит и удаляет ответы.

Битрикс24 API: imopenlines.v2.QuickReply.* Скоуп: imopenlines

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

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

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

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрlineId (path) Типinteger Обяз.да По умолч.— ОписаниеID открытой линии. Список: GET /v1/openline-configs
Параметр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 — личный ключ

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

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

Terminal 
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 Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеlineId не положительное целое число
HTTP400 КодINVALID_PARAMS Описаниеoffset или limit отрицательные либо не целые, search не строка
HTTP400 КодINVALID_PARAMS ОписаниеsectionId не целое неотрицательное число
HTTP400 КодINVALID_PARAMS ОписаниеПараметр строки запроса передан дважды или в форме объекта, например search=a&search=b или search[x]=a
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет действующей авторизации в Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа imopenlines
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 отказал пользователю ключа в доступе
HTTP404 КодENTITY_NOT_FOUND ОписаниеОткрытой линии с таким lineId нет
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 вернул ошибку. Текст — в message
HTTP429 КодRATE_LIMITED ОписаниеПревышен собственный лимит метода. Общий потолок платформы — 120 запросов в минуту на портал, он делится между репликами платформы, поэтому код может прийти раньше 120-го запроса. Действующее значение — в заголовке x-ratelimit-limit
HTTP502 КодOPENLINE_OPERATOR_FAILED ОписаниеБитрикс24 вернул ответ неожиданной формы
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил вовремя. Чтение безопасно повторить

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

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

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

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