Установить параметры карточки элементов crm.item.details.configuration.set
Название метода: crm.item.details.configuration.set
Scope:
crmКто может выполнять метод: проверка прав при выполнении метода зависит от переданных данных:
- Любой пользователь имеет право установить свои личные настройки
- Пользователь имеет право устанавливать общие и чужие настройки только если он является администратором
Метод устанавливает настройки карточки определенного объекта CRM. Записывает личные настройки карточки указанного пользователя или общие настройки для всех пользователей.
Примечание
- Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов применяется параметр
extras.leadCustomerType. - Настройки карточки элемента могут отличаться в зависимости от их воронки. Для переключения используется параметры
extras.categoryId— для смарт-процессовextras.dealCategoryId— для сделок
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор системного или пользовательского типа объектов CRM |
|
data* |
Список |
|
userId |
Идентификатор пользователя, для которого вы хотите установить конфигурацию. Если параметр не передан, то будет взят Нужен только при запросе личных настроек |
|
scope |
Область применения настроек. Допустимые значения:
По умолчанию значение равно |
|
extras |
Дополнительные параметры. Возможные значения и их структура описана ниже |
section
Описывает отдельно взятый раздел с полями внутри карточки элемента.
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Уникальное название раздела |
|
title* |
Название раздела. Отображается в карточке элемента |
|
type* |
Тип раздела. На данный момент доступно только значение |
|
elements |
Массив |
section_element
Конфигурация отдельно взятого поля внутри раздела.
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Идентификатор поля. Список доступных полей можно узнать с помощью |
|
optionFlags |
Нужно ли показывать поле всегда:
По умолчанию значение равно |
|
options |
Дополнительный список опций для поля |
section_element.options
|
Название |
Поля, где доступна опция |
Описание |
По умолчанию |
|
defaultAddressType |
|
Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте |
|
|
defaultCountry |
|
Код страны для формата телефонного номера по умолчанию — строка из двух латинских букв. Например |
|
|
isPayButtonVisible |
|
Показана ли кнопка принятия оплаты. Возможные значения:
|
|
|
isPaymentDocumentsVisible |
|
Показан ли блок «Оплата и доставка». Возможные значения:
|
|
extras
Параметр в extras зависит от объекта CRM.
|
Объект CRM |
Название |
Описание |
|
Смарт-процесс |
|
Идентификатор воронки смарт-процессов. Можно получить с помощью Если не указано, то берется идентификатор воронки по умолчанию для данного смарт-процесса |
|
Сделка |
|
Идентификатор воронки сделок. Можно получить с помощью Если не указан, то берется идентификатор воронки по умолчанию для сделок |
|
Лид |
|
Тип лидов. озможные значения:
|
Примеры кода
Как использовать примеры в документации
Для пользователя с id = 1 в контактах установить следующую конфигурацию карточки элементов
- Раздел 1 - Личные данные
- Имя
- Показывать всегда
- Фамилия
- Показывать всегда
- Отчество
- Дата рождения
- Телефон
- Показывать всегда
- Страна по умолчанию: Великобритания(+44)
- Адрес
- Показывать всегда
- Тип адреса по умолчанию: Адрес регистрации (см.
crm.enum.addresstype)
- Имя
- Раздел 2 - Основная информация
- Тип контакта
- Источник
- Должность
- Раздел 3 - Дополнительная информация
- Фотография
- Комментарий
- Пользовательское поле #1
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":3,"userId":1,"data":[{"name":"section_1","title":"Личные данные","type":"section","elements":[{"name":"NAME","optionFlags":1},{"name":"LAST_NAME","optionFlags":1},{"name":"SECOND_NAME"},{"name":"BIRTHDATE"},{"name":"PHONE","optionFlags":1,"options":{"defaultCountry":"GB"}},{"name":"ADDRESS","optionFlags":1,"options":{"defaultAddressType":4}}]},{"name":"section_2","title":"Основная информация","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"POST"}]},{"name":"section_3","title":"Дополнительная информация","type":"section","elements":[{"name":"PHOTO"},{"name":"COMMENTS"},{"name":"UF_CRM_1720697698689"}]}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":3,"userId":1,"data":[{"name":"section_1","title":"Личные данные","type":"section","elements":[{"name":"NAME","optionFlags":1},{"name":"LAST_NAME","optionFlags":1},{"name":"SECOND_NAME"},{"name":"BIRTHDATE"},{"name":"PHONE","optionFlags":1,"options":{"defaultCountry":"GB"}},{"name":"ADDRESS","optionFlags":1,"options":{"defaultAddressType":4}}]},{"name":"section_2","title":"Основная информация","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"POST"}]},{"name":"section_3","title":"Дополнительная информация","type":"section","elements":[{"name":"PHOTO"},{"name":"COMMENTS"},{"name":"UF_CRM_1720697698689"}]}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.set
try
{
const response = await $b24.callMethod(
'crm.item.details.configuration.set',
{
entityTypeId: 3,
userId: 1,
data: [
{
name: "section_1",
title: "Личные данные",
type: "section",
elements: [
{
name: "NAME",
optionFlags: 1,
},
{
name: "LAST_NAME",
optionFlags: 1,
},
{
name: "SECOND_NAME",
},
{
name: "BIRTHDATE",
},
{
name: "PHONE",
optionFlags: 1,
options: {
defaultCountry: "GB",
},
},
{
name: "ADDRESS",
optionFlags: 1,
options: {
defaultAddressType: 4,
},
},
],
},
{
name: "section_2",
title: "Основная информация",
type: "section",
elements: [
{ name: "TYPE_ID" },
{ name: "SOURCE_ID" },
{ name: "POST" },
],
},
{
name: "section_3",
title: "Дополнительная информация",
type: "section",
elements: [
{ name: "PHOTO" },
{ name: "COMMENTS" },
{ name: "UF_CRM_1720697698689" },
],
},
],
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.item.details.configuration.set',
[
'entityTypeId' => 3,
'userId' => 1,
'data' => [
[
'name' => "section_1",
'title' => "Личные данные",
'type' => "section",
'elements' => [
[
'name' => "NAME",
'optionFlags' => 1,
],
[
'name' => "LAST_NAME",
'optionFlags' => 1,
],
[
'name' => "SECOND_NAME",
],
[
'name' => "BIRTHDATE",
],
[
'name' => "PHONE",
'optionFlags' => 1,
'options' => [
'defaultCountry' => "GB",
],
],
[
'name' => "ADDRESS",
'optionFlags' => 1,
'options' => [
'defaultAddressType' => 4,
],
],
],
],
[
'name' => "section_2",
'title' => "Основная информация",
'type' => "section",
'elements' => [
['name' => "TYPE_ID"],
['name' => "SOURCE_ID"],
['name' => "POST"],
],
],
[
'name' => "section_3",
'title' => "Дополнительная информация",
'type' => "section",
'elements' => [
['name' => "PHOTO"],
['name' => "COMMENTS"],
['name' => "UF_CRM_1720697698689"],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting details configuration: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.details.configuration.set',
{
entityTypeId: 3,
userId: 1,
data: [
{
name: "section_1",
title: "Личные данные",
type: "section",
elements: [
{
name: "NAME",
optionFlags: 1,
},
{
name: "LAST_NAME",
optionFlags: 1,
},
{
name: "SECOND_NAME",
},
{
name: "BIRTHDATE",
},
{
name: "PHONE",
optionFlags: 1,
options: {
defaultCountry: "GB",
},
},
{
name: "ADDRESS",
optionFlags: 1,
options: {
defaultAddressType: 4,
},
},
],
},
{
name: "section_2",
title: "Основная информация",
type: "section",
elements: [
{ name: "TYPE_ID" },
{ name: "SOURCE_ID" },
{ name: "POST" },
],
},
{
name: "section_3",
title: "Дополнительная информация",
type: "section",
elements: [
{ name: "PHOTO" },
{ name: "COMMENTS" },
{ name: "UF_CRM_1720697698689" },
],
},
],
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.item.details.configuration.set',
[
'entityTypeId' => 3,
'userId' => 1,
'data' => [
[
'name' => "section_1",
'title' => "Личные данные",
'type' => "section",
'elements' => [
[
'name' => "NAME",
'optionFlags' => 1,
],
[
'name' => "LAST_NAME",
'optionFlags' => 1,
],
[
'name' => "SECOND_NAME",
],
[
'name' => "BIRTHDATE",
],
[
'name' => "PHONE",
'optionFlags' => 1,
'options' => [
'defaultCountry' => "GB",
],
],
[
'name' => "ADDRESS",
'optionFlags' => 1,
'options' => [
'defaultAddressType' => 4,
],
],
],
],
[
'name' => "section_2",
'title' => "Основная информация",
'type' => "section",
'elements' => [
['name' => "TYPE_ID"],
['name' => "SOURCE_ID"],
['name' => "POST"],
],
],
[
'name' => "section_3",
'title' => "Дополнительная информация",
'type' => "section",
'elements' => [
['name' => "PHOTO"],
['name' => "COMMENTS"],
['name' => "UF_CRM_1720697698689"],
],
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Результат
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1720699969.76157,
"finish": 1720699970.153406,
"duration": 0.39183592796325684,
"processing": 0.02178215980529785,
"date_start": "2024-07-11T14:12:49+02:00",
"date_finish": "2024-07-11T14:12:50+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Возвращает |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Element at index 0 in section at index 1 does not have name."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустое значение |
Parameter 'entityTypeId' is not defined |
Не передан обязательный параметр |
|
Пустое значение |
The entity type ' |
Метод не поддерживает данный тип сущности |
|
Пустое значение |
Access denied. |
У пользователя нет административных прав |
|
Пустое значение |
Parameter 'data' must be array. |
В |
|
Пустое значение |
The data must be indexed array. |
В |
|
Пустое значение |
There are no data to write. |
В |
|
Пустое значение |
Section at index |
В |
|
Пустое значение |
Section at index |
В |
|
Пустое значение |
Section at index |
В |
|
Пустое значение |
Element at index |
В |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Настройка разделов в карточке элементов
- Получить параметры карточки элементов crm.item.details.configuration.get
- Сбросить параметры карточки элементов crm.item.details.configuration.reset
- Установить общую карточку для всех пользователей crm.item.details.configuration.forceCommonScopeForAll