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

Список категорий сценариев

GET /v1/crm-forms/scenario-categories

Возвращает категории, по которым сгруппированы сценарии конструктора CRM-форм: коммуникации с клиентами, онлайн-запись, продажа, доставка и другие.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-forms/scenario-categories" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

const { success, data } = await res.json()
console.log(data.map(category => `${category.id} — ${category.title}`))

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеВсе категории сценариев. Постраничной выдачи нет
Полеdata[].id Типstring ОписаниеИдентификатор категории, например crm, booking. Это значение приходит в data[].categoryId сценария
Полеdata[].title Типstring ОписаниеНазвание категории

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

Показаны три категории из десяти:

JSON 
{
  "success": true,
  "data": [
    {
      "id": "crm",
      "title": "Коммуникации с клиентами"
    },
    {
      "id": "booking",
      "title": "Онлайн-запись"
    },
    {
      "id": "products",
      "title": "Продажа"
    }
  ]
}

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

400 — передан параметр строки запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Unknown query parameter"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеЭндпоинт не принимает параметры строки запроса
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя Битрикс24 нет прав на формы
HTTP403 КодBITRIX_INSUFFICIENT_SCOPE ОписаниеУ токена Битрикс24 нет необходимого скоупа
HTTP404 КодENTITY_NOT_FOUND ОписаниеПортал не нашёл запрошенную сущность или описание поля. Исходный код — error.b24Code
HTTP409 КодCRM_FORM_REST_NOT_ENABLED ОписаниеREST-методы CRM-форм недоступны на этом портале Битрикс24. Это не означает отсутствие отдельной формы
HTTP400–599 КодCRM_FORM_* ОписаниеОтказ по правилам форм. Код и HTTP-статус сохранены, исходный код — в error.b24Code
HTTP422 КодBITRIX_ERROR ОписаниеДругой отказ Битрикс24. Причина — в error.message, исходный код — в error.b24Code
HTTP429 КодRATE_LIMITED ОписаниеПревышена частота запросов. Учитывайте заголовок Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 вернул ответ в неожиданном виде
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен: ошибка сервера или разрыв соединения
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил вовремя. Чтение можно повторить
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа не настроен доступ к Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ API-ключа Вайбкод нет скоупа crm

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

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