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

Включить свою паузу

POST /v1/openlines/operator/pause

Включает паузу и возвращает перечитанное состояние.

Скоуп: imopenlines. Нужен ключ с разрешённой записью.

Для ключа на вебхуке это пауза сотрудника, выпустившего вебхук. Для OAuth — вызывающего сотрудника. Параметра пользователя нет.

Примеры

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/operator/pause" \
  -H "X-Api-Key: YOUR_API_KEY"
Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/operator/pause" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/openlines/operator/pause', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
});
const result = await response.json();
if (!response.ok) throw new Error(result.error.message);
console.log(result.data);
javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/openlines/operator/pause', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    Authorization: 'Bearer USER_SESSION_TOKEN',
  },
});
const result = await response.json();
if (!response.ok) throw new Error(result.error.message);
console.log(result.data);

Поля ответа

Поле Тип Описание
success boolean true
data object Результат операции
data.paused boolean Текущее состояние паузы

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

JSON 
{
  "success": true,
  "data": {
    "paused": true
  }
}

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

403: у вызывающего сотрудника нет доступа.

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied"
  }
}

Ошибки

HTTP Код Условие
403 SCOPE_DENIED Нет скоупа imopenlines
403 BITRIX_ACCESS_DENIED Нет прав в Битрикс24
403 WRITE_BLOCKED_READONLY_KEY Ключ запрещает запись
422 BITRIX_ERROR Бизнес-отказ, исходный текст сохранён
502 OPENLINE_OPERATOR_FAILED Неверный результат или пауза не переключилась

Системные ошибки.

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

Повторное включение или выключение паузы возвращает текущее состояние, даже если оно уже установлено.

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