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

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

GET /v1/crm-forms/scenarios

Возвращает сценарии конструктора CRM-форм — заготовки форм для обратного звонка, онлайн-записи, продажи товаров, регистрации на мероприятие и других задач.

Примеры

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

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/scenarios', {
  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 ОписаниеИдентификатор сценария, например contacts, callback
Полеdata[].title Типstring ОписаниеНазвание сценария
Полеdata[].description Типstring ОписаниеОписание сценария
Полеdata[].categoryId Типstring ОписаниеКатегория сценария. Список: Категории сценариев
Полеdata[].iconUrl Типstring ОписаниеПуть к значку сценария от корня адреса Битрикс24, например /bitrix/images/crm/webform/icons/contacts.svg
Полеdata[].sections Типarray of string ОписаниеРазделы настроек формы, которые относятся к сценарию, например fields, agreements, crm, design
Полеdata[].expertSections Типarray of string ОписаниеРасширенный набор разделов настроек формы
Полеdata[].defaultSection Типstring ОписаниеРаздел настроек по умолчанию, одно из значений sections
Полеdata[].openable Типboolean ОписаниеМожно ли открыть сценарий в конструкторе форм
Полеdata[].soon Типboolean ОписаниеСценарий помечен как готовящийся к выпуску
Полеdata[].actions Типarray of string ОписаниеДействия сценария, например check, showHelp. Пустой массив, если действий нет

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

Показаны два сценария из 26:

JSON 
{
  "success": true,
  "data": [
    {
      "id": "contacts",
      "title": "Контактные данные",
      "description": "Получите телефон, адрес почты, имя клиента",
      "categoryId": "crm",
      "iconUrl": "/bitrix/images/crm/webform/icons/contacts.svg",
      "sections": [
        "fields",
        "agreements",
        "header-and-button",
        "crm",
        "design",
        "other"
      ],
      "expertSections": [
        "fields",
        "booking-resource-auto-selection",
        "agreements",
        "crm",
        "pay-systems",
        "header-and-button",
        "spam-protection",
        "fields-rules",
        "actions",
        "default-values",
        "analytics",
        "callback",
        "design",
        "other"
      ],
      "defaultSection": "fields",
      "openable": true,
      "soon": false,
      "actions": []
    },
    {
      "id": "event_registration",
      "title": "Онлайн-события",
      "description": "Регистрация на онлайн-мероприятие",
      "categoryId": "events",
      "iconUrl": "/bitrix/images/crm/webform/icons/online.svg",
      "sections": [
        "fields",
        "agreements",
        "crm",
        "header-and-button",
        "actions",
        "default-values",
        "design",
        "other"
      ],
      "expertSections": [
        "fields",
        "booking-resource-auto-selection",
        "agreements",
        "crm",
        "pay-systems",
        "header-and-button",
        "spam-protection",
        "fields-rules",
        "actions",
        "default-values",
        "analytics",
        "callback",
        "design",
        "other"
      ],
      "defaultSection": "fields",
      "openable": true,
      "soon": false,
      "actions": [
        "check"
      ]
    }
  ]
}

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

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 — Ошибки.

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