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

Получить конфигурацию открытой линии

GET /v1/openline-configs/:id

Возвращает конфигурацию открытой линии по ID со всеми полями, включая данные очереди операторов.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID конфигурации

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/openline-configs/1" \
  -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/1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Линия:', data.name, '— тип очереди:', data.queueType)

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

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

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

Поля ответа

Ответ содержит 95 полей, все в camelCase — /fields описывает каждое поле с label и description: Поля открытой линии.

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект конфигурации (все поля — см. Поля открытой линии)

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

Показаны ключевые поля. Полный список: Поля открытой линии.

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "active": true,
    "name": "Открытая линия",
    "queueType": "all",
    "workTimeFrom": "8",
    "workTimeTo": "17",
    "crm": "Y",
    "crmCreate": "deal",
    "queueTime": "60",
    "noAnswerTime": "180",
    "workTimeEnable": "Y",
    "workTimeTimezone": "Europe/Kaliningrad",
    "welcomeMessage": "Y",
    "voteMessage": "Y",
    "queue": ["139", "131", "99"],
    "queueFull": {
      "99": {
        "ID": "59",
        "SORT": "2",
        "USER_ID": "99",
        "DEPARTMENT_ID": "0",
        "USER_NAME": "Иван Петров",
        "USER_WORK_POSITION": "Менеджер поддержки",
        "USER_AVATAR": "/upload/main/avatars/99.jpg",
        "USER_AVATAR_ID": "12345"
      },
      "131": {
        "ID": "57",
        "SORT": "1",
        "USER_ID": "131",
        "DEPARTMENT_ID": "0",
        "USER_NAME": "Мария Смирнова",
        "USER_WORK_POSITION": "Старший оператор",
        "USER_AVATAR": "/upload/main/avatars/131.jpg",
        "USER_AVATAR_ID": "67890"
      }
    },
    "queueUsersFields": {
      "99": { "USER_NAME": "Иван Петров", "USER_WORK_POSITION": "Менеджер поддержки", "USER_AVATAR": "/upload/main/avatars/99.jpg" },
      "131": { "USER_NAME": "Мария Смирнова", "USER_WORK_POSITION": "Старший оператор", "USER_AVATAR": "/upload/main/avatars/131.jpg" }
    },
    "queueOnline": "N",
    "dateCreate": {},
    "dateModify": {}
  }
}

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

404 — конфигурация не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "openlineConfig 99999 not found"
  }
}

Ошибки

HTTP Код Описание
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа imopenlines
404 ENTITY_NOT_FOUND Конфигурация с таким ID не найдена

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

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

Поля очереди операторов доступны только здесь. queue, queueFull, queueUsersFields, queueOnline приходят в ответе одиночного запроса и недоступны в Списке и Поиске.

Полный реестр всех 95 полей (все в camelCase, с label и description) и пустые dateCreate/dateModify — Поля конфигурации.

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