Фоновый обработчик на всех страницах PAGE_BACKGROUND_WORKER
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
placement
Битрикс24 загружает обработчик этой точки на каждой странице в скрытом фрейме, без видимого элемента интерфейса. Пользователь виджет не открывает и не видит: код приложения выполняется в фоне на любой странице, которую открыл сотрудник.
Точка нужна там, где приложение должно реагировать не на клик, а на внешнее событие: принять сигнал от своего backend через интерактивное взаимодействие, показать входящий звонок в интеграции телефонии, открыть слайдер приложения методом openApplication.
Код точки встраивания указывается в параметре PLACEMENT метода placement.bind. Регистрация требует параметр OPTIONS[errorHandlerUrl]. В нем передают адрес, по которому Битрикс24 сообщит об отключении обработчика.
Виджет не отображается в интерфейсе, пока установка приложения не завершена. Проверьте установку приложения
Куда встраивается виджет
|
Код точки встраивания |
Место |
|
|
Скрытый фрейм на каждой странице Битрикс24 |
Когда вызывается обработчик
Обработчик загружается при каждой загрузке страницы Битрикс24. Страница, открытая слайдером, считается отдельным документом, поэтому в нем обработчик загружается еще раз, уже со своим адресом в ключе URI.
Из этого следует главное требование к обработчику: он должен отвечать быстро. Если ответ идет дольше пяти секунд и это повторяется больше десяти раз за сутки на одном Битрикс24, регистрация обработчика удаляется.
Об удалении Битрикс24 сообщает приложению: на адрес из OPTIONS[errorHandlerUrl] приходит запрос с ошибкой ERROR_PLACEMENT_LOADING_OVERTIME и описанием, какое время загрузки было превышено. Запрос отправляется без токенов авторизации. Чтобы вернуть виджет, приложение регистрирует обработчик заново методом placement.bind.
Что получает обработчик
Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса
Array
(
[DOMAIN] => xxx.bitrix24.com
[PROTOCOL] => 1
[LANG] => ru
[APP_SID] => 588b8a98e848778a4ffb38fbcf70f2b9
[AUTH_ID] => 4172bb660070f28d001e30ba00000001f0f107c42ca5bd5f61030c5d9c3e4d60
[AUTH_EXPIRES] => 3600
[REFRESH_ID] => 31f1e2660070f28d001e30ba00000001f0f107b1918506d8a2ed9ecf76e8fdac
[SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
[APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
[APPLICATION_SCOPE] => placement
[member_id] => d897063e1ce7c5eb9f04b9751eef5915
[status] => L
[PLACEMENT] => PAGE_BACKGROUND_WORKER
[PLACEMENT_OPTIONS] => {"ID":"PAGE_BACKGROUND_WORKER","URI":"\/company\/personal\/user\/1\/blog\/"}
)
Обязательные параметры отмечены *
Параметры в 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-строка с контекстом вызова.
|
Параметр |
Описание |
|
ID* |
Код точки встраивания, всегда равен |
|
URI* |
Путь с query-строкой страницы, на которой загрузился обработчик. По нему приложение понимает, где сейчас находится пользователь |
OPTIONS при регистрации через placement.bind
Для PAGE_BACKGROUND_WORKER метод placement.bind поддерживает один параметр OPTIONS.
Обязательные параметры отмечены *
|
Параметр |
Описание |
|
errorHandlerUrl* |
Адрес, на который Битрикс24 сообщит об удалении регистрации обработчика. Параметр обязателен: без него |
Приложение регистрирует один обработчик этой точки. Повторный вызов placement.bind возвращает ошибку ERROR_PLACEMENT_MAX_COUNT. Чтобы сменить адрес обработчика, сначала снимите регистрацию методом placement.unbind.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"PLACEMENT": "PAGE_BACKGROUND_WORKER",
"HANDLER": "https://your-domain.com/widgets/background-handler.php",
"OPTIONS": {
"errorHandlerUrl": "https://your-domain.com/widgets/background-error.php"
},
"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: 'PAGE_BACKGROUND_WORKER',
HANDLER: 'https://your-domain.com/widgets/background-handler.php',
OPTIONS: {
errorHandlerUrl: 'https://your-domain.com/widgets/background-error.php',
},
},
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 bindBackgroundWorker() {
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: 'PAGE_BACKGROUND_WORKER',
HANDLER: 'https://your-domain.com/widgets/background-handler.php',
OPTIONS: {
errorHandlerUrl: 'https://your-domain.com/widgets/background-error.php',
},
},
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', bindBackgroundWorker)
</script>
try {
$response = $b24Service
->core
->call(
'placement.bind',
[
'PLACEMENT' => 'PAGE_BACKGROUND_WORKER',
'HANDLER' => 'https://your-domain.com/widgets/background-handler.php',
'OPTIONS' => [
'errorHandlerUrl' => 'https://your-domain.com/widgets/background-error.php',
],
]
);
$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: 'PAGE_BACKGROUND_WORKER',
HANDLER: 'https://your-domain.com/widgets/background-handler.php',
OPTIONS: {
errorHandlerUrl: 'https://your-domain.com/widgets/background-error.php'
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'placement.bind',
[
'PLACEMENT' => 'PAGE_BACKGROUND_WORKER',
'HANDLER' => 'https://your-domain.com/widgets/background-handler.php',
'OPTIONS' => [
'errorHandlerUrl' => 'https://your-domain.com/widgets/background-error.php',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
"PLACEMENT": "PAGE_BACKGROUND_WORKER",
"HANDLER": "https://your-domain.com/widgets/background-handler.php",
"OPTIONS": b24.Params{
"errorHandlerUrl": "https://your-domain.com/widgets/background-error.php",
},
})
if err != nil {
return fmt.Errorf("placement.bind: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его по форме ответа
// метода placement.bind, см. раздел «Обработка ответа» на его странице.
fmt.Printf("%s\n", res.Result)
Обработчик для одного пользователя
PAGE_BACKGROUND_WORKER — единственная точка встраивания, которая поддерживает параметр USER_ID метода placement.bind. Обработчик, зарегистрированный с USER_ID, загружается только на страницах этого пользователя. Так фоновый код подключают только тем, кому он нужен, например операторам телефонии.
Ограничение в один обработчик считается отдельно для общей регистрации и для каждого пользователя, поэтому персональный обработчик и обработчик для всех сотрудников можно зарегистрировать одновременно.
Связь с другими объектами
Карточка звонка. Из фонового обработчика приложение управляет карточкой звонка: меняет ее состояние, кнопки и заголовок, подписывается на действия оператора. Методы и события собраны в разделе Управление карточкой звонка WebRTC-клиента: обзор команд и событий, а весь сценарий описан в статье Сценарий встраивания WebRTC.
Сигналы от backend. Обработчик получает сообщения от серверной части приложения механизмом интерактивного взаимодействия и по ним открывает интерфейс приложения методами JavaScript для виджетов.
Пользователь. Идентификатор для параметра USER_ID при регистрации персонального обработчика возвращают методы раздела Пользователи: обзор методов.
Типовые ошибки
|
Ошибка |
Как решить |
|
|
Передайте |
|
|
Обработчик уже зарегистрирован. Снимите старую регистрацию методом placement.unbind |
|
Обработчик перестал вызываться, в |
Регистрацию удалили из-за долгой загрузки. Ускорьте ответ обработчика и зарегистрируйте его заново |
|
Обработчик вызывается по несколько раз на одном экране |
Страницы в слайдерах — отдельные документы, и в каждом обработчик загружается заново. Проверяйте |
Частые кейсы и сценарии
Продолжите изучение
- Универсальные виджеты: обзор точек встраивания
- Открытие приложения по ссылке REST_APP_URI
- Зарегистрировать обработчик виджета placement.bind
- Удалить обработчик виджета placement.unbind
- Управление карточкой звонка WebRTC-клиента: обзор команд и событий
- Методы BX24 SDK для виджетов
- Интерактивность в приложениях: обзор сценариев и методов