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

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 — описание всех полей ответов list, get и search: каждое поле снабжено type, readonly, названием label и описанием description. Имена полей — в camelCase. Полный набор в get — 95 полей, в list/search — 91 (без 4 полей очереди операторов). Дополнительно data содержит aggregatable и batch.

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

/fields возвращает полный набор полей — каждое с type, readonly, label и description. Фильтрация (filter), сортировка (sort) и группировка (groupBy) работают по этим camelCase-именам. Ниже — основные поля, чаще всего используемые в sort и filter:

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

• aggregatable — поля, доступные для groupBy: ["active", "queueType"]
• batch — перечень пакетных операций, объявленных для этой сущности в ответе /fields: пустой массив []

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

В get объект data содержит 95 полей (все в camelCase), в list/search — 91 (без 4 полей с отметкой «только get»: queue, queueFull, queueUsersFields, queueOnline).

Основные

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

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

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

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

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

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

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

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

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

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

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

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

KPI

Служебные

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

Показаны несколько представительных полей. Полный набор больше — 95 полей в get, 91 в list/search.

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Идентификатор", "description": "Идентификатор конфигурации." },
      "name": { "type": "string", "readonly": false, "label": "Название линии", "description": "Название открытой линии." },
      "active": { "type": "boolean", "readonly": false, "label": "Линия активна", "description": "Линия активна (true/false)." },
      "queueType": { "type": "string", "readonly": false, "label": "Алгоритм распределения", "description": "Алгоритм распределения: all — всем одновременно, evenly — равномерно, strictly — строго по очереди." },
      "crmCreate": { "type": "string", "readonly": false, "label": "Создаваемая CRM-запись", "description": "Тип создаваемой CRM-записи при первом обращении: deal, lead, contact, company." },
      "welcomeMessage": { "type": "string", "readonly": false, "label": "Показывать приветствие", "description": "Показывать приветствие: Y/N." },
      "workTimeFrom": { "type": "string", "readonly": false, "label": "Начало рабочего дня", "description": "Начало рабочего дня (например 8, 9.30)." }
    },
    "aggregatable": ["active", "queueType"],
    "batch": []
  }
}

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

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

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

Ошибки

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

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

Единый набор имён — camelCase. Все поля ответов list/get/search приходят в camelCase. Эндпоинт /fields (data.fields) описывает каждое поле с type, readonly, label и description. По этим именам работают filter, sort, groupBy. Всего 91 поле в list/search, 95 в get (добавляются 4 поля очереди операторов). При записи (create/update) camelCase — канонический регистр. Имена в UPPER_SNAKE_CASE также принимаются для обратной совместимости. Булевы поля при записи принимают true/false (приводятся к "Y"/"N").

Числовые поля приходят строками. queueTime, noAnswerTime, autoCloseTime, maxChat, kpiFirstAnswerTime и другие — строки ("60", "180"). Исключение — id (number) и active (boolean): эти два поля трансформирует схема API Вайбкод.

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

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

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