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

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

POST /v1/openlines/operator/pause

Включает паузу оператора Открытых линий для сотрудника, от имени которого идёт вызов.

Параметров нет, тело запроса не передаётся. Сотрудник определяется авторизацией — см. От чьего имени выполняется действие.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/operator/pause \
  -H "X-Api-Key: YOUR_API_KEY"

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

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 — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/operator/pause', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Пауза включена:', data.paused)

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

javascript 
const res = 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 { data } = await res.json()
console.log('Пауза включена:', data.paused)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном включении
Полеdata.paused Типboolean ОписаниеСостояние паузы, перечитанное после вызова. При успешном ответе true

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

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

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

401 — не передан заголовок X-Api-Key:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Ошибки

HTTP Код Описание
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил запрос. Текст отказа — в message
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ сотрудника, от имени которого идёт вызов, нет прав на действие
HTTP502 КодOPENLINE_OPERATOR_FAILED ОписаниеПосле вызова пауза осталась выключенной: перечитанное состояние false
HTTP502 КодOPENLINE_OPERATOR_FAILED ОписаниеБитрикс24 вернул вместо состояния паузы значение не логического типа
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа imopenlines
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан
HTTP401 КодTOKEN_MISSING ОписаниеУ личного ключа нет доступа к порталу Битрикс24, у ключа приложения не передан токен сессии в Authorization
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен или соединение с ним оборвалось до полного ответа

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

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

  • Повторное включение не возвращает ошибку. Если пауза уже включена, вызов отвечает 200 с paused: true, состояние не меняется.

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