#Поля конфигурации открытой линии

GET /v1/openline-configs/fields

Возвращает схему полей, доступных для фильтрации и сортировки, а также полный реестр полей в ответах list, get и search.

#Примеры

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

curl "https://vibecode.bitrix24.tech/v1/openline-configs/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl "https://vibecode.bitrix24.tech/v1/openline-configs/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Поля схемы:', Object.keys(data.fields))

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

#Поля ответа

Эндпоинт /fields содержит два блока: схема (data.fields) — 8 полей, по которым работают сортировка и фильтрация; реестр полей ответа — все поля, приходящие в ответах list, get, search. Полный набор в get — 95 полей; в list/search — 91 (без 4 полей очереди операторов).

#Схема полей (data.fields)

Только эти 8 полей поддерживаются в sort, filter и groupBy агрегации.

Дополнительно в data.fields указаны:

• aggregatable — поля, доступные для groupBy: ["active", "queueType", "agentId", "lineId"]
• batch — доступные операции: ["create", "update", "delete"]

#Полный реестр полей ответа (list / get / search)

В get объект data содержит 95 полей в смешанном регистре, в list/search — 91 (без 4 полей с отметкой «только get»: QUEUE, QUEUE_FULL, QUEUE_USERS_FIELDS, QUEUE_ONLINE).

#Основные

#Очередь и операторы

#Интеграция с CRM

#Приветственное сообщение

#Приветственный бот

#Рабочее время

#Сценарии нерабочего времени, нет ответа, закрытие

Три группы по четыре поля — сценарий, форма, бот, текст:

#Автозакрытие по неактивности

#Оценка качества

#Соглашения и категории

#Форма ожидания

#Оператор и сессия

#KPI

#Служебные

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

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "name": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "lineId": { "type": "number", "readonly": true },
      "queueType": { "type": "string", "readonly": false },
      "agentId": { "type": "number", "readonly": false },
      "workTimeFrom": { "type": "string", "readonly": false },
      "workTimeTo": { "type": "string", "readonly": false }
    },
    "aggregatable": ["active", "queueType", "agentId", "lineId"],
    "batch": ["create", "update", "delete"]
  }
}

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

403 — нет скоупа:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "Access denied. Required scope: imopenlines"
  }
}

#Ошибки

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

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

Два независимых набора имён. Схема data.fields — 8 полей camelCase, по ним работают filter, sort, groupBy. Ответы содержат: 6 camelCase-полей (трансформированы схемой Вайбкода) + UPPER_SNAKE_CASE-поля (приходят как есть из Битрикс24). Всего 91 поле в list/search, 95 в get (добавляются 4 поля очереди операторов). Имена для запроса — camelCase; имена для чтения значений — оба регистра.

Числовые поля приходят строками. QUEUE_TIME, NO_ANSWER_TIME, AUTO_CLOSE_TIME, MAX_CHAT, KPI_FIRST_ANSWER_TIME и другие — строки ("60", "180"). Исключение — id (number) и active (boolean): эти два поля трансформирует схема Вайбкода.

Зарезервированные поля схемы. lineId и agentId объявлены в data.fields, но в ответах list/get/search не приходят.

DATE_CREATE и DATE_MODIFY всегда пустые объекты {}. Битрикс24 не передаёт значения дат через эти поля.

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

• Список конфигураций
• Получить конфигурацию
• Entity API
• Синтаксис фильтрации