Поиск клиента в карточке элемента CRM_DETAIL_SEARCH
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
placement, crm
Точка CRM_DETAIL_SEARCH подключает обработчик приложения к поиску клиента в карточке CRM — к полям Контакт и Компания блока Клиент. Она нужна, когда приложение ищет клиента во внешнем источнике и подставляет найденный вариант в карточку.
Собственный интерфейс приложение не выводит: оно получает поисковый запрос и возвращает список вариантов, а показывает их Битрикс24.
Код точки встраивания указывается в параметре PLACEMENT метода placement.bind.
Виджет не отображается в интерфейсе, пока установка приложения не завершена. Проверьте установку приложения
Куда встраивается виджет
|
Код точки встраивания |
Место |
|
|
Пункт приложения в поиске клиента карточки CRM |
Где находится в интерфейсе
Откройте карточку объекта CRM и начните вводить запрос в поле Контакт или Компания блока Клиент. Пункт приложения появляется под списком найденных клиентов, когда в запросе не меньше трех символов. Пункт выводится с названием из параметра TITLE.
Нажмите на пункт, чтобы приложение выполнило поиск. Пока обработчик отвечает, на пункте показывается индикатор загрузки. Найденные приложением варианты выводятся в том же списке, что и клиенты Битрикс24.

Что получает обработчик
Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса
Array
(
[DOMAIN] => xxx.bitrix24.com
[PROTOCOL] => 1
[LANG] => ru
[APP_SID] => 1a7f0c3e59d84b2c7e6f5a83d1c40b92
[AUTH_ID] => 83fd7166007e9c94001e30ba00000001f0f107a52e6ad7ef9a1b8c3d5e2f4061
[AUTH_EXPIRES] => 3600
[REFRESH_ID] => 737c9966007e9c94001e30ba00000001f0f1072b8d4e6f01a3c57d9e8b2f4160
[SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
[APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
[APPLICATION_SCOPE] => crm,placement
[member_id] => d897063e1ce7c5eb9f04b9751eef5915
[status] => L
[PLACEMENT] => CRM_DETAIL_SEARCH
[PLACEMENT_OPTIONS] => {"entityTypeName":"CONTACT","searchQuery":"Ромаш","URI":"\/crm\/deal\/details\/8061\/?any=details%2F8061%2F&IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"}
)
Строка PLACEMENT_OPTIONS из этого примера после разбора выглядит так:
{
"entityTypeName": "CONTACT",
"searchQuery": "Ромаш",
"URI": "/crm/deal/details/8061/?any=details%2F8061%2F&IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"
}
Обязательные параметры отмечены *
Параметры в query-строке адреса обработчика
|
Параметр |
Описание |
|
DOMAIN* |
Адрес Битрикс24, на котором был вызван обработчик виджета |
|
PROTOCOL* |
Защищенный или незащищенный протокол HTTP:
|
|
LANG* |
Язык интерфейса пользователя Битрикс24, который вызвал виджет. Вы можете локализовать язык интерфейса в своем виджете, ориентируясь на это значение |
|
APP_SID* |
Идентификатор сессии приложения. Битрикс24 создает его заново при каждой отрисовке виджета и использует, чтобы связать js-библиотеку с окружением приложения |
Параметры в теле POST-запроса
|
Параметр |
Описание |
|
AUTH_ID |
Авторизационный токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для вызовов REST API от лица этого пользователя |
|
AUTH_EXPIRES |
Время в секундах, после которого авторизационный токен станет неактуальным |
|
REFRESH_ID |
Refresh-токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для обновления авторизационного токена от лица этого пользователя |
|
SERVER_ENDPOINT* |
Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2 |
|
APPLICATION_TOKEN* |
Токен приложения. То же значение приходит в параметре |
|
APPLICATION_SCOPE* |
Список скоупов, выданных приложению, через запятую. Показывает, какие методы REST API доступны с полученным авторизационным токеном |
|
member_id* |
Уникальный строковый идентификатор Битрикс24, на котором был вызван обработчик виджета |
|
status |
Тип приложения, зарегистрировавшего обработчик данного виджета. Принимает значения:
|
|
PLACEMENT* |
Код точки встраивания. Вы можете использовать один и тот же URL обработчика для всех своих виджетов. Значение, которое Битрикс24 будет сообщать в параметре |
|
PLACEMENT_OPTIONS |
Дополнительные данные в виде JSON-строки, определяющие контекст выполнения виджета. Например, это может быть массив, содержащий числовой идентификатор элемента CRM, в карточке которого был вызван обработчик виджета, и так далее. Параметр |
Битрикс24 добавляет в PLACEMENT_OPTIONS ключ URI — путь с query-строкой той страницы, с которой открыт виджет. Он приходит для любой точки встраивания, вместе с ее собственными ключами. Ключа не будет, если браузер не передал заголовок Referer или виджет открыт со страницы другого домена.
Как разобрать контекст вызова
PLACEMENT_OPTIONS приходит JSON-строкой, а не массивом: перед использованием разберите ее на стороне обработчика. Состав ключей у каждой точки свой и описан в разделе PLACEMENT_OPTIONS этой страницы.
$placement = $_POST['PLACEMENT'] ?? '';
$options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);
options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")
В B24JsSDK разбирать строку не нужно: свойство $b24.placement.options возвращает готовый объект, а $b24.placement.placement — код точки встраивания.
Что должен вернуть обработчик
Обработчик отвечает обычной HTML-страницей — Битрикс24 показывает ее во фрейме на месте виджета. Страница должна разрешать встраивание: если сервер приложения отдает заголовки X-Frame-Options или Content-Security-Policy, запрещающие фрейм, на месте виджета останется пустая область. Как это исправить, описано в статье Сайт не разрешает подключение.
PLACEMENT_OPTIONS
Значение PLACEMENT_OPTIONS передается как JSON-строка с контекстом вызова. Кроме универсального ключа URI в контекст попадают собственные ключи точки.
Обязательные параметры отмечены *
|
Параметр |
Описание |
|
entityTypeName* |
Тип клиента, которого ищет пользователь. Возможные значения:
|
|
searchQuery* |
Строка, которую пользователь ввел в поле поиска |
Идентификатор объекта, из карточки которого открыт поиск, отдельным ключом не приходит. Его можно взять из пути в универсальном ключе URI.
OPTIONS при регистрации через placement.bind
Параметры OPTIONS точка не поддерживает. Переданные значения не сохраняются: метод placement.get возвращает для такой регистрации пустой массив.
Как вернуть найденные варианты
Передайте найденные варианты командой BX24.placement.call с именем crmShowFoundEntities.
|
Поле |
Описание |
|
data |
Список найденных вариантов |
|
data[].id |
Идентификатор варианта на стороне приложения |
|
data[].name |
Название варианта, которое будет показано пользователю |
|
data[].phone |
Телефон варианта. Передавайте поле, если номер найден |
|
data[].email |
E-mail варианта. Передавайте поле, если адрес найден |
|
data[].web |
Сайт варианта. Передавайте поле, если сайт найден |
BX24.placement.call(
'crmShowFoundEntities',
{
data: [
{
id: 'company-123',
name: 'ООО Ромашка',
phone: '+7 495 000-00-00',
email: 'info@example.com',
web: 'https://example.com'
}
]
}
);
Если приложение ничего не нашло, передайте пустой список. Битрикс24 сделает пункт приложения неактивным.
Как подставить выбранный вариант в карточку
Если пользователь выбрал вариант из ответа приложения, Битрикс24 вызывает событие интерфейса onCrmEntityIsNeedToCreate. Подпишитесь на него методом BX24.placement.bindEvent.
В обработчик события передаются данные выбранного варианта.
|
Поле |
Описание |
|
appSid |
Идентификатор сессии приложения, в которой был найден выбранный вариант |
|
data |
Данные выбранного варианта из списка, который приложение передало через |
Создайте объект в CRM методом crm.company.add или crm.contact.add, а затем передайте его идентификатор командой crmShowCreatedEntity. Битрикс24 подставит этот объект в поле Клиент карточки.
BX24.placement.bindEvent('onCrmEntityIsNeedToCreate', function (eventData) {
const selected = eventData.data;
BX24.placement.call(
'crmShowCreatedEntity',
{
entityType: 'company',
id: selected.id,
title: selected.title || selected.name
}
);
});
Поля команды crmShowCreatedEntity:
|
Поле |
Описание |
|
entityType |
Тип созданного объекта. Для компании передайте |
|
id |
Идентификатор созданного объекта в CRM |
|
title |
Название созданного объекта |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"PLACEMENT": "CRM_DETAIL_SEARCH",
"HANDLER": "https://your-domain.com/widgets/crm-detail-search-handler.php",
"TITLE": "Поиск в реестре",
"LANG_ALL": {
"ru": {
"TITLE": "Поиск в реестре"
},
"en": {
"TITLE": "Registry search"
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/placement.bind
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'placement.bind',
params: {
PLACEMENT: 'CRM_DETAIL_SEARCH',
HANDLER: 'https://your-domain.com/widgets/crm-detail-search-handler.php',
TITLE: 'Registry search',
LANG_ALL: {
ru: {
TITLE: 'Поиск в реестре',
},
en: {
TITLE: 'Registry search',
},
},
},
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('Placement bound successfully:', 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 bindCrmDetailSearch() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'placement.bind',
params: {
PLACEMENT: 'CRM_DETAIL_SEARCH',
HANDLER: 'https://your-domain.com/widgets/crm-detail-search-handler.php',
TITLE: 'Registry search',
LANG_ALL: {
ru: {
TITLE: 'Поиск в реестре',
},
en: {
TITLE: 'Registry search',
},
},
},
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('Placement bound successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', bindCrmDetailSearch)
</script>
try {
$response = $b24Service
->core
->call(
'placement.bind',
[
'PLACEMENT' => 'CRM_DETAIL_SEARCH',
'HANDLER' => 'https://your-domain.com/widgets/crm-detail-search-handler.php',
'TITLE' => 'Поиск в реестре',
'LANG_ALL' => [
'ru' => [
'TITLE' => 'Поиск в реестре',
],
'en' => [
'TITLE' => 'Registry search',
],
],
]
);
$result = $response->getResponseData()->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error binding placement: ' . $e->getMessage();
}
BX24.callMethod(
'placement.bind',
{
PLACEMENT: 'CRM_DETAIL_SEARCH',
HANDLER: 'https://your-domain.com/widgets/crm-detail-search-handler.php',
TITLE: 'Поиск в реестре',
LANG_ALL: {
ru: { TITLE: 'Поиск в реестре' },
en: { TITLE: 'Registry search' }
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'placement.bind',
[
'PLACEMENT' => 'CRM_DETAIL_SEARCH',
'HANDLER' => 'https://your-domain.com/widgets/crm-detail-search-handler.php',
'TITLE' => 'Поиск в реестре',
'LANG_ALL' => [
'ru' => [
'TITLE' => 'Поиск в реестре',
],
'en' => [
'TITLE' => 'Registry search',
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
"PLACEMENT": "CRM_DETAIL_SEARCH",
"HANDLER": "https://your-domain.com/widgets/crm-detail-search-handler.php",
"TITLE": "Поиск в реестре",
"LANG_ALL": b24.Params{
"ru": b24.Params{
"TITLE": "Поиск в реестре",
},
"en": b24.Params{
"TITLE": "Registry search",
},
},
})
if err != nil {
return fmt.Errorf("placement.bind: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его по форме ответа
// метода placement.bind, см. раздел «Обработка ответа» на его странице.
fmt.Printf("%s\n", res.Result)
Типовые ошибки
|
Ошибка |
Как решить |
|
|
Регистрируйте точку от имени приложения. Вебхуком точку не привязать |
|
|
Код указан неверно или приложению не выдан скоуп |
|
Виджет зарегистрирован, но в интерфейсе не появляется |
Завершите установку приложения и перезагрузите страницу |
|
Пункт не появляется в поиске клиента |
Введите в поле Контакт или Компания не меньше трех символов — до этого пункт приложения не выводится |
Другие коды ошибок регистрации перечислены в разделе «Возможные коды ошибок» страницы placement.bind.