Получить параметры карточки сделки crm.deal.details.configuration.get

Scope: crm

Кто может выполнять метод:

  • пользователь может получать свои и общие настройки
  • получить личные настройки другого пользователя можно при наличии прав на редактирование персонального вида для пользователя

DEPRECATED

Развитие метода остановлено. Используйте crm.item.details.configuration.get.

Метод crm.deal.details.configuration.get получает настройки карточки сделки. Метод читает личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.

Примечание

Настройки карточки сделок в разных воронках могут отличаться. Для выбора воронки используйте параметр extras.dealCategoryId.

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

Обязательные параметры отмечены *

Название
тип

Описание

scope
string

Область применения настроек.

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

  • P — личные настройки
  • C — общие настройки

По умолчанию — P

userId
user

Идентификатор пользователя. Нужен только при запросе личных настроек другого пользователя.

Если не задан, берется текущий

extras
object

Дополнительные параметры (подробное описание)

Параметр extras

Обязательные параметры отмечены *

Название
тип

Описание

dealCategoryId
integer

Идентификатор воронки сделок. Можно получить с помощью crm.category.list

Если не указан, используется воронка по умолчанию для сделок

Примеры кода

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

Пример получения общей конфигурации карточки сделки для воронки с id = 32.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C","extras":{"dealCategoryId":32}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.details.configuration.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C","extras":{"dealCategoryId":32},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.details.configuration.get
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.details.configuration.get',
        		{
        			scope: "C",
        			extras: {
        				dealCategoryId: 32,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.details.configuration.get',
                    [
                        'scope' => 'C',
                        'extras' => [
                            'dealCategoryId' => 32,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting deal details configuration: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.details.configuration.get',
            {
                scope: "C",
                extras: {
                    dealCategoryId: 32,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.details.configuration.get',
            [
                'scope' => 'C',
                'extras' => [
                    'dealCategoryId' => 32,
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                {
                    "name": "main",
                    "title": "О сделке",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TITLE"
                        },
                        {
                            "name": "OPPORTUNITY_WITH_CURRENCY"
                        },
                        {
                            "name": "STAGE_ID"
                        },
                        {
                            "name": "CLOSEDATE"
                        },
                        {
                            "name": "CLIENT"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Дополнительно",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TYPE_ID"
                        },
                        {
                            "name": "SOURCE_ID",
                            "optionFlags": "1"
                        },
                        {
                            "name": "SOURCE_DESCRIPTION"
                        },
                        {
                            "name": "BEGINDATE"
                        },
                        {
                            "name": "OPENED"
                        },
                        {
                            "name": "ASSIGNED_BY_ID"
                        },
                        {
                            "name": "OBSERVER"
                        },
                        {
                            "name": "COMMENTS"
                        },
                        {
                            "name": "UTM"
                        }
                    ]
                },
                {
                    "name": "products",
                    "title": "Товары",
                    "type": "section",
                    "elements": [
                        {
                            "name": "PRODUCT_ROW_SUMMARY"
                        }
                    ]
                },
                {
                    "name": "recurring",
                    "title": "Регулярная сделка",
                    "type": "section",
                    "elements": [
                        {
                            "name": "RECURRING"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1773240673,
                "finish": 1773240673.91616,
                "duration": 0.9161601066589355,
                "processing": 0,
                "date_start": "2026-03-11T17:51:13+03:00",
                "date_finish": "2026-03-11T17:51:13+03:00",
                "operating_reset_at": 1773241273,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
section[]|null

Корневой элемент ответа. Содержит конфигурацию разделов детальной карточки сделки. Возвращает null в случае отсутствия конфигурации

time
time

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

Параметр section

Описывает отдельный раздел с полями внутри карточки сделки

Название
тип

Описание

name
string

Уникальное название раздела, используемое для идентификации

title
string

Название раздела

type
string

Тип раздела

elements
section_element[]

Список выводимых в карточке полей с дополнительными настройками

Параметр section_element

Конфигурация отдельного поля внутри раздела

Название
тип

Описание

name
string

Идентификатор поля

optionFlags
string

Значения:

  • "1" — показывать всегда
  • "0" — показывать не всегда

options
object

Дополнительные опции поля

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус

Код

Описание

Значение

400

Пустое значение

Access denied

Нет прав на получение настроек карточки сделки

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Обзор методов
Следующая
Установить параметры карточки сделки