Получить параметры карточки сделки crm.deal.details.configuration.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод:
- пользователь может получать свои и общие настройки
- получить личные настройки другого пользователя можно при наличии прав на редактирование персонального вида для пользователя
DEPRECATED
Развитие метода остановлено. Используйте crm.item.details.configuration.get.
Метод crm.deal.details.configuration.get получает настройки карточки сделки. Метод читает личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.
Примечание
Настройки карточки сделок в разных воронках могут отличаться. Для выбора воронки используйте параметр extras.dealCategoryId.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Область применения настроек. Возможные значения:
По умолчанию — |
|
userId |
Идентификатор пользователя. Нужен только при запросе личных настроек другого пользователя. Если не задан, берется текущий |
|
extras |
Дополнительные параметры (подробное описание) |
Параметр extras
Обязательные параметры отмечены *
|
Название |
Описание |
|
dealCategoryId |
Идентификатор воронки сделок. Можно получить с помощью 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
// 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 each section returned in result[]
type CrmDealDetailsSection = {
name: string
title: string
type: string
elements: CrmDealDetailsSectionElement[]
}
type CrmDealDetailsSectionElement = {
name: string
optionFlags?: string
options?: Record<string, unknown>
}
try {
const response = await $b24.actions.v2.call.make<CrmDealDetailsSection[] | null>({
method: 'crm.deal.details.configuration.get',
params: {
scope: 'C',
extras: {
dealCategoryId: 32,
},
},
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
console.info('Card sections:', result?.length ?? 0, result)
}
} 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 getDealCardConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.details.configuration.get',
params: {
scope: 'C',
extras: {
dealCategoryId: 32,
},
},
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('Card sections:', result?.length ?? 0, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDealCardConfiguration)
</script>
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>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.deal.details.configuration.get(
scope="P",
user_id=1,
extras={"dealCategoryId": 0},
).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}")
Обработка ответа
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 |
Корневой элемент ответа. Содержит конфигурацию разделов детальной карточки сделки. Возвращает |
|
time |
Информация о времени выполнения запроса |
Параметр section
Описывает отдельный раздел с полями внутри карточки сделки
|
Название |
Описание |
|
name |
Уникальное название раздела, используемое для идентификации |
|
title |
Название раздела |
|
type |
Тип раздела |
|
elements |
Список выводимых в карточке полей с дополнительными настройками |
Параметр section_element
Конфигурация отдельного поля внутри раздела
|
Название |
Описание |
|
name |
Идентификатор поля |
|
optionFlags |
Значения:
|
|
options |
Дополнительные опции поля |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Access denied |
Нет прав на получение настроек карточки сделки |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |