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

Режим CRM

GET /v1/crm-settings/mode

Показывает режим CRM портала, чтобы до работы с лидами узнать, включены ли они.

Примеры

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/crm-settings/mode" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/crm-settings/mode" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-settings/mode', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data } = await res.json()
const leadsEnabled = data.mode === 1
console.log(data.name, leadsEnabled ? 'лиды включены' : 'лиды выключены')

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном запросе
Полеdata.mode Типnumber ОписаниеТекущий режим: 1 — классическая CRM с лидами, 2 — простая CRM без лидов
Полеdata.name Типstring ОписаниеНазвание текущего режима на языке портала
Полеdata.modes Типarray ОписаниеВсе режимы, которые поддерживает портал
Полеdata.modes[].id Типnumber ОписаниеИдентификатор режима. Текущему режиму соответствует элемент, у которого id равен data.mode
Полеdata.modes[].name Типstring ОписаниеНазвание режима на языке портала

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

JSON
{
  "success": true,
  "data": {
    "mode": 1,
    "name": "Классическая CRM",
    "modes": [
      { "id": 1, "name": "Классическая CRM" },
      { "id": 2, "name": "Простая CRM" }
    ]
  }
}

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

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

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

Ошибки

HTTP Код Описание
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя ключа нет права читать настройки CRM в Битрикс24
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил запрос, текст причины в message
HTTP429 КодRATE_LIMITED ОписаниеПревышена частота запросов к Битрикс24, повторите через 1-2 секунды
HTTP502 КодBITRIX_RESPONSE_INVALID ОписаниеБитрикс24 вернул режим или список режимов в неожиданном виде, либо текущего режима нет в списке
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен: ответил ошибкой сервера или соединение оборвалось
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа нет настроенных токенов Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ API-ключа нет скоупа crm

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

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

  • Сравнивайте режим по числу. name приходит на языке портала, поэтому условие строится по mode, а не по названию.
  • Параметры запроса игнорируются. Метод не принимает параметров, переданные в адресе на ответ не влияют.

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