Установить параметры индивидуальной карточки crm.contact.details.configuration.set
Scope:
crmКто может выполнять метод:
- Любой пользователь имеет право получать свои и общие настройки
- Только администратор имеет право получать чужие настройки
DEPRECATED
Развитие метода остановлено. Используйте crm.item.details.configuration.set.
Метод устанавливает настройки карточки контактов: записывает личные настройки карточки указанного пользователя или общие настройки для всех пользователей.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Область применения настроек. Возможные значения:
По умолчанию — |
|
userId |
Идентификатор пользователя. Нужен только при установке личных настроек. Если не задан — берется |
|
data* |
Список Структура описана ниже |
section
Описывает отдельно взятый раздел с полями внутри карточки контакта.
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Уникальное название раздела |
|
title* |
Название раздела. Отображается в карточке элемента |
|
type* |
Тип раздела. На данный момент доступно только значение |
|
elements |
Массив Структура описана ниже |
section_element
Конфигурация отдельно взятого поля внутри раздела.
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Идентификатор поля. Список доступных полей можно узнать с помощью |
|
optionFlags |
Нужно ли показывать поле всегда:
По умолчанию — |
|
options |
Дополнительный список опций для поля |
section_element.options
|
Название |
Поля, где доступна опция |
Описание |
|
defaultAddressType |
|
Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте |
|
defaultCountry |
|
Код страны для формата телефонного номера по умолчанию — строка из двух латинских букв. Например |
|
isPayButtonVisible |
|
Показана ли кнопка принятия оплаты. Возможные значения:
По умолчанию — |
|
isPaymentDocumentsVisible |
|
Показан ли блок «Оплата и доставка». Возможные значения:
По умолчанию — |
Примеры кода
Как использовать примеры в документации
Для пользователя с id = 1 в контактах установить следующую конфигурацию карточки элементов:
- Раздел 1 — Личные данные
- Имя
- Показывать всегда
- Фамилия
- Показывать всегда
- Отчество
- Дата рождения
- Телефон
- Показывать всегда
- Страна по умолчанию: Великобритания(+44)
- Адрес
- Показывать всегда
- Тип адреса по умолчанию: Адрес регистрации (смотрите
crm.enum.addresstype)
- Имя
- Раздел 2 — Основная информация
- Тип контакта
- Источник
- Должность
- Раздел 3 — Дополнительная информация
- Фотография
- Комментарий
- Пользовательское поле #1
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"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.contact.details.configuration.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"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.contact.details.configuration.set
try
{
const response = await $b24.callMethod(
'crm.contact.details.configuration.set',
{
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;
result.error()
? console.error(result.error())
: console.info(result)
;
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.contact.details.configuration.set',
[
'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();
if ($response->getError()) {
echo 'Error: ' . $response->getError();
} else {
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting contact details configuration: ' . $e->getMessage();
}
BX24.callMethod(
'crm.contact.details.configuration.set',
{
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) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.contact.details.configuration.set',
[
'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": 1724677217.639681,
"finish": 1724677217.986853,
"duration": 0.3471717834472656,
"processing": 0.01840806007385254,
"date_start": "2024-08-26T15:00:17+02:00",
"date_finish": "2024-08-26T15:00:17+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 |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустое значение |
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.contact.details.configuration.get
- Установить общую карточку для всех пользователей crm.contact.details.configuration.forceCommonScopeForAll
- Сбросить параметры карточки crm.contact.details.configuration.reset