Добавить поле в поиск дубликатов crm.duplicate.volatileType.register
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: администратор Битрикс24 или администратор CRM
Метод crm.duplicate.volatileType.register добавляет поле в функционал поиска дубликатов в лидах, контактах или компаниях.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор типа объекта. Возможные значения: |
|
fieldCode* |
Код поля, который нужно добавить в поиск дубликатов. Например |
Особенности работы метода
Суммарно можно зарегистрировать семь нестандартных полей для поиска дубликатов. Например, если уже добавили три поля для контактов и четыре поля для компаний, при попытке добавить еще одно поле для любого типа объекта получите ошибку MAX_TYPES_COUNT_EXCEEDED.
Повторный вызов метода для уже зарегистрированного поля не занимает новый слот — метод вернет id существующей записи.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1,"fieldCode":"TITLE"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.duplicate.volatileType.register
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1,"fieldCode":"TITLE","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.duplicate.volatileType.register
// 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 RegisterVolatileTypeResult = {
id: number
}
try {
const response = await $b24.actions.v2.call.make<RegisterVolatileTypeResult>({
method: 'crm.duplicate.volatileType.register',
params: {
entityTypeId: 1,
fieldCode: 'TITLE',
},
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('Registered field with id:', result.id)
}
} 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 registerVolatileType() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.duplicate.volatileType.register',
params: {
entityTypeId: 1,
fieldCode: 'TITLE',
},
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('Registered field with id:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', registerVolatileType)
</script>
try {
$response = $b24Service
->core
->call(
'crm.duplicate.volatileType.register',
[
'entityTypeId' => 1,
'fieldCode' => 'TITLE',
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error registering volatile type: ' . $e->getMessage();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.duplicate.volatile_type.register(
entity_type_id=1,
field_code="TITLE",
).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}")
BX24.callMethod(
"crm.duplicate.volatileType.register",
{
entityTypeId: 1,
fieldCode: "TITLE"
},
function(result) {
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.duplicate.volatileType.register',
[
'entityTypeId' => 1,
'fieldCode' => 'TITLE'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.duplicate.volatileType.register", b24.Params{
"entityTypeId": 1,
"fieldCode": "TITLE",
})
if err != nil {
return fmt.Errorf("crm.duplicate.volatileType.register: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID)
Обработка ответа
HTTP-статус: 200
{
"result": {
"id": 3355
},
"time": {
"start": 1750934251.736599,
"finish": 1750934252.028757,
"duration": 0.2921581268310547,
"processing": 0.24904417991638184,
"date_start": "2025-06-26T13:37:31+03:00",
"date_finish": "2025-06-26T13:37:32+03:00",
"operating_reset_at": 1750934851,
"operating": 0.24902796745300293
}
}
Возвращаемые данные
|
Название |
Описание |
|
id |
Идентификатор записи для поля, добавленного в поиск дубликатов |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "FIELD_NOT_FOUND",
"error_description": "Field not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Field not found |
Поле с указанным |
|
|
There is already a maximum number of volatile types |
Заняты все семь слотов дополнительных полей. Освободите слот методом crm.duplicate.volatileType.unregister |
|
|
Access denied |
Метод доступен только администратору Битрикс24 или администратору CRM |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |