#Список конфигураций открытых линий

GET /v1/openline-configs

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

#Параметры

Параметр Тип По умолч. Допустимые значения Описание
limit number 50 1–200 Количество записей на запрос
offset number 0 0 и больше Пропустить N записей
sort string — id, name, active, lineId, queueType, agentId, workTimeFrom, workTimeTo Поле сортировки
order string asc asc, desc Направление сортировки
filter object — ключи — те же 8 полей, что и в sort; значения — по типу поля Фильтрация по полям схемы.
Синтаксис фильтрации. Пример: ?filter[active]=false, ?filter[queueType]=evenly

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/openline-configs?limit=10&sort=id&order=asc&filter[active]=true" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/openline-configs?limit=10&sort=id&order=asc&filter[active]=true" \
  -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?limit=10&sort=id&order=asc&filter[active]=true', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, total, hasMore } = await res.json()
console.log(`Получено ${data.length} конфигураций, всего в окне: ${total}`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs?limit=10&sort=id&order=asc&filter[active]=true', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

#Поля ответа

Ответ содержит поля метаданных на верхнем уровне (не вложены в meta):

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив конфигураций (все поля — см. Поля конфигурации)
total number Количество записей в текущем окне (не общий счётчик портала)
limit number Размер страницы
offset number Смещение
hasMore boolean Есть ли ещё записи за пределами limit

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

Показаны основные поля. Полный список: Поля конфигурации.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "Открытая линия",
      "queueType": "all",
      "workTimeFrom": "8",
      "workTimeTo": "17",
      "CRM": "Y",
      "CRM_CREATE": "deal",
      "QUEUE_TIME": "60",
      "NO_ANSWER_TIME": "180",
      "WELCOME_MESSAGE": "Y",
      "WORKTIME_ENABLE": "Y",
      "WORKTIME_TIMEZONE": "Europe/Kaliningrad",
      "DATE_CREATE": {},
      "DATE_MODIFY": {}
    },
    {
      "id": 3,
      "active": true,
      "name": "Wix",
      "queueType": "all",
      "workTimeFrom": "9",
      "workTimeTo": "18.30",
      "CRM": "Y",
      "CRM_CREATE": "deal",
      "QUEUE_TIME": "60",
      "NO_ANSWER_TIME": "180",
      "WELCOME_MESSAGE": "Y",
      "WORKTIME_ENABLE": "N",
      "WORKTIME_TIMEZONE": "Europe/Moscow",
      "DATE_CREATE": {},
      "DATE_MODIFY": {}
    }
  ],
  "total": 10,
  "limit": 10,
  "offset": 0,
  "hasMore": false
}

В примере показаны 2 записи из 10 — остальные 8 опущены для краткости. Каждый элемент содержит ещё около 75 полей помимо показанных.

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

400 — неизвестное поле сортировки:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_SORT_FIELD",
    "message": "Unknown sort field: 'createdAt'. Available: id, name, active, lineId, queueType, agentId, workTimeFrom, workTimeTo"
  }
}

#Ошибки

HTTP Код Описание
400 UNKNOWN_SORT_FIELD Передано неизвестное поле в sort. Сообщение содержит список допустимых значений
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа imopenlines

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

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

total — счётчик текущего окна, а не общий. Битрикс24 не возвращает общее количество конфигураций для метода списка, поэтому total содержит число записей только в текущей странице. Для проверки наличия следующей страницы используйте поле hasMore.

Фильтрация и сортировка работают по camelCase-полям схемы. Параметры filter и sort принимают только 8 имён из схемы: id, name, active, lineId, queueType, agentId, workTimeFrom, workTimeTo. Поля в UPPER_SNAKE_CASE (например CRM_CREATE, WORKTIME_TIMEZONE) для фильтра и сортировки недоступны.

Поля QUEUE, QUEUE_FULL, QUEUE_USERS_FIELDS, QUEUE_ONLINE в списке не возвращаются — они доступны только в Получить конфигурацию.

Смешанный регистр и пустые даты. Каждая запись содержит ~91 поле в двух регистрах (6 camelCase + ~85 UPPER_SNAKE_CASE); DATE_CREATE и DATE_MODIFY приходят пустыми объектами {}. Полный реестр полей и пояснения — Поля конфигурации.

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