Получить список сценариев CRM-форм crm.form.scenario.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на просмотр CRM-форм

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.form.scenario.list возвращает сценарии CRM-форм — заготовки форм под задачи, например обратный звонок или регистрацию на мероприятие.

Параметры метода

Без параметров. Метод возвращает весь справочник. Фильтр, сортировка, постраничная навигация и select не поддерживаются: если передать их в запросе, метод их не учитывает.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.form.scenario.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.scenario.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.scenario.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type FormScenarioListResult = {
  items: Array<{
    id: string
    title: string
    description: string | null
    categoryId: string
    iconUrl: string | null
    sections: string[]
    expertSections: string[]
    defaultSection: string | null
    openable: boolean
    soon: boolean
    actions: string[]
  }>
}

try {
  const response = await $b24.actions.v3.call.make<FormScenarioListResult>({
    method: 'crm.form.scenario.list',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    // Scenarios that open the form editor right away
    console.info(result.items.filter(scenario => scenario.openable && !scenario.soon))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getFormScenarios() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'crm.form.scenario.list',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.items)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getFormScenarios)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.form.scenario.list().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.form.scenario.list',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.form.scenario.list',
    {},
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.form.scenario.list',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.form.scenario.list", b24.Params{}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.form.scenario.list: %w", err)
}

// Метод заворачивает список в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет ключа items")
}

var items []struct {
	ID         string `json:"id"`
	Title      string `json:"title"`
	CategoryID string `json:"categoryId"`
	Openable   bool   `json:"openable"`
	Soon       bool   `json:"soon"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, scenario := range items {
	fmt.Println(scenario.ID, scenario.Title)
}

Обработка ответа

HTTP-статус: 200

Пример сокращен: в списке оставлено три сценария из 26.

{
    "result": {
        "items": [
            {
                "id": "callback",
                "title": "Обратный звонок",
                "description": "Узнайте номер телефона и запустите обратный звонок",
                "categoryId": "crm",
                "iconUrl": "/bitrix/images/crm/webform/icons/revertcall.svg",
                "sections": ["fields", "agreements", "header-and-button", "crm", "callback", "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": "callback",
                "openable": true,
                "soon": false,
                "actions": []
            },
            {
                "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": "personalisation",
                "title": "Персональная форма",
                "description": "Если у вас уже есть данные, заполните эти поля формы за клиента",
                "categoryId": "crm_automation",
                "iconUrl": "/bitrix/images/crm/webform/icons/personalization.svg",
                "sections": ["fields", "agreements", "header-and-button", "crm", "design", "other"],
                "expertSections": [],
                "defaultSection": "fields",
                "openable": false,
                "soon": false,
                "actions": ["showHelp"]
            }
        ]
    },
    "time": {
        "start": 1792593642,
        "finish": 1792593642.129926,
        "duration": 0.12992596626281738,
        "processing": 0,
        "date_start": "2026-10-21T17:40:42+03:00",
        "date_finish": "2026-10-21T17:40:42+03:00",
        "operating_reset_at": 1792594200,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

items
object[]

Массив сценариев (подробное описание)

time
time

Информация о времени выполнения запроса

Элемент items

Название
тип

Описание

id
string

Код сценария, например callback, contacts, event_registration

title
string

Название сценария

description
string

Описание сценария или null

categoryId
string

Код категории сценария. Названия категорий возвращает метод crm.form.scenariocategory.list

iconUrl
string

Путь к иконке сценария на Битрикс24 или null, если иконки нет

sections
string[]

Разделы конструктора, которые сценарий открывает для настройки, например fields, agreements, crm, design

expertSections
string[]

Разделы конструктора, которые сценарий открывает в расширенном режиме. Может быть пустым

defaultSection
string

Раздел, с которого открывается конструктор, или null

openable
boolean

Признак того, что сценарий открывает конструктор формы.

Возможные значения:

  • true — сценарий открывает конструктор
  • false — сценарий не открывает конструктор, а выполняет действие из actions

soon
boolean

Признак анонсированного сценария.

Возможные значения:

  • true — сценарий анонсирован, но пока недоступен
  • false — сценарий доступен

actions
string[]

Дополнительные действия сценария, например showHelp или check. Для большинства сценариев массив пустой

Обработка ошибок

HTTP-статус: 403

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION",
        "message": "Доступ запрещен"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Выдайте пользователю право на просмотр CRM-форм

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение