#Обновить конфигурацию открытой линии

PATCH /v1/openline-configs/:id

Обновляет поля существующей конфигурации открытой линии. Передайте только изменяемые поля — остальные не затрагиваются. Полный список полей — Поля конфигурации.

#Параметры

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

#Поля запроса (body)

Поля передаются в UPPER_SNAKE_CASE. Тело запроса не должно быть пустым — обязательно наличие хотя бы одного поля.

Поле Тип Описание
LINE_NAME string Название открытой линии
ACTIVE boolean Включена ли линия
QUEUE_TIME number Время ожидания ответа оператора (секунды)
NO_ANSWER_TIME number Время до сработывания правила «Нет ответа» (секунды)
WELCOME_MESSAGE_TEXT string Текст приветственного сообщения
WORKTIME_FROM string Начало рабочего времени, например "9" или "9.30"
WORKTIME_TO string Конец рабочего времени, например "18" или "17.30"
WORKTIME_TIMEZONE string Часовой пояс рабочего времени

Полный список доступных полей — Поля конфигурации.

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/openline-configs/29" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "QUEUE_TIME": 120,
    "WELCOME_MESSAGE_TEXT": "Здравствуйте! Чем можем помочь?"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/openline-configs/29" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "QUEUE_TIME": 120,
    "WELCOME_MESSAGE_TEXT": "Здравствуйте! Чем можем помочь?"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    QUEUE_TIME: 120,
    WELCOME_MESSAGE_TEXT: 'Здравствуйте! Чем можем помочь?',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    QUEUE_TIME: 120,
    WELCOME_MESSAGE_TEXT: 'Здравствуйте! Чем можем помочь?',
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Результат операции
data.id number Идентификатор обновлённой конфигурации
data.updated boolean true — обновление применено

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

JSON 
{
  "success": true,
  "data": {
    "id": 29,
    "updated": true
  }
}

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

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

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

#Ошибки

HTTP Код Описание
400 INVALID_ID Параметр id не является положительным целым числом
400 VALIDATION_ERROR Тело запроса пустое — необходимо передать хотя бы одно поле
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа imopenlines
404 ENTITY_NOT_FOUND Конфигурация с указанным id не существует

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

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

Ответ содержит только id и data.updated: true — полей конфигурации в ответе нет. Чтобы получить актуальные значения всех полей после обновления, выполните GET /v1/openline-configs/:id.

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