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

Что получает обработчик
Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса
Array
(
[DOMAIN] => xxx.bitrix24.com
[PROTOCOL] => 1
[LANG] => ru
[APP_SID] => c14d1f3266fe7ba3cd098e2d04dccda3
[AUTH_ID] => 83fd7166007e9c94001e30ba00000001f0f107a52e6ad7ef9a1b8c3d5e2f4061
[AUTH_EXPIRES] => 3600
[REFRESH_ID] => 737c9966007e9c94001e30ba00000001f0f1072b8d4e6f01a3c57d9e8b2f4160
[SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
[APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
[APPLICATION_SCOPE] => im,placement
[member_id] => d897063e1ce7c5eb9f04b9751eef5915
[status] => L
[PLACEMENT] => IM_NAVIGATION
[PLACEMENT_OPTIONS] => {"URI":"\/online\/"}
)
Строка PLACEMENT_OPTIONS из этого примера после разбора выглядит так:
{
"URI": "/online/"
}
Обязательные параметры отмечены *
Параметры в 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 с адресом страницы мессенджера.
Если приложению нужен идентификатор чата, используйте точки, которые вызываются из самого чата: IM_SIDEBAR, IM_TEXTAREA или IM_CONTEXT_MENU.
OPTIONS при регистрации через placement.bind
Для IM_NAVIGATION метод placement.bind поддерживает параметры OPTIONS.
Обязательные параметры отмечены *
|
Параметр |
Описание |
|
iconName* |
Имя иконки Font Awesome 4, например Параметр обязателен: без него |
|
extranet |
Доступ в экстранете, по умолчанию Возможные значения:
|
|
role |
Роль пользователя, по умолчанию Возможные значения:
|
Параметр context, который ограничивает показ по типу чата, для этой точки не применяется: пункт навигации не привязан к чату.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"PLACEMENT": "IM_NAVIGATION",
"HANDLER": "https://your-domain.com/widgets/im-navigation-handler.php",
"TITLE": "Мой раздел",
"LANG_ALL": {
"ru": {
"TITLE": "Мой раздел"
},
"en": {
"TITLE": "My section"
}
},
"OPTIONS": {
"iconName": "fa-rocket",
"role": "USER",
"extranet": "N"
},
"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: 'IM_NAVIGATION',
HANDLER: 'https://your-domain.com/widgets/im-navigation-handler.php',
TITLE: 'My section',
LANG_ALL: {
ru: {
TITLE: 'Мой раздел',
},
en: {
TITLE: 'My section',
},
},
OPTIONS: {
iconName: 'fa-rocket',
role: 'USER',
extranet: 'N',
},
},
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 bindImNavigation() {
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: 'IM_NAVIGATION',
HANDLER: 'https://your-domain.com/widgets/im-navigation-handler.php',
TITLE: 'My section',
LANG_ALL: {
ru: {
TITLE: 'Мой раздел',
},
en: {
TITLE: 'My section',
},
},
OPTIONS: {
iconName: 'fa-rocket',
role: 'USER',
extranet: 'N',
},
},
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', bindImNavigation)
</script>
try {
$response = $b24Service
->core
->call(
'placement.bind',
[
'PLACEMENT' => 'IM_NAVIGATION',
'HANDLER' => 'https://your-domain.com/widgets/im-navigation-handler.php',
'TITLE' => 'Мой раздел',
'LANG_ALL' => [
'ru' => [
'TITLE' => 'Мой раздел',
],
'en' => [
'TITLE' => 'My section',
],
],
'OPTIONS' => [
'iconName' => 'fa-rocket',
'role' => 'USER',
'extranet' => 'N',
],
]
);
$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: 'IM_NAVIGATION',
HANDLER: 'https://your-domain.com/widgets/im-navigation-handler.php',
TITLE: 'Мой раздел',
LANG_ALL: {
ru: { TITLE: 'Мой раздел' },
en: { TITLE: 'My section' }
},
OPTIONS: {
iconName: 'fa-rocket',
role: 'USER',
extranet: 'N'
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'placement.bind',
[
'PLACEMENT' => 'IM_NAVIGATION',
'HANDLER' => 'https://your-domain.com/widgets/im-navigation-handler.php',
'TITLE' => 'Мой раздел',
'LANG_ALL' => [
'ru' => [
'TITLE' => 'Мой раздел',
],
'en' => [
'TITLE' => 'My section',
],
],
'OPTIONS' => [
'iconName' => 'fa-rocket',
'role' => 'USER',
'extranet' => 'N',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
"PLACEMENT": "IM_NAVIGATION",
"HANDLER": "https://your-domain.com/widgets/im-navigation-handler.php",
"TITLE": "Мой раздел",
"LANG_ALL": b24.Params{
"ru": b24.Params{
"TITLE": "Мой раздел",
},
"en": b24.Params{
"TITLE": "My section",
},
},
"OPTIONS": b24.Params{
"iconName": "fa-rocket",
"role": "USER",
"extranet": "N",
},
})
if err != nil {
return fmt.Errorf("placement.bind: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа из раздела «Обработка ответа» страницы placement.bind.
fmt.Printf("%s\n", res.Result)
Типовые ошибки
|
Ошибка |
Как решить |
|
|
Регистрируйте точку от имени приложения. Вебхуком точку не привязать |
|
|
Не передан обязательный параметр |
|
Пункт не появился в меню навигации мессенджера |
Завершите установку приложения и заново откройте мессенджер |
|
Пункт не находят в ряду навигации |
Пункт приложения добавляется последним, поэтому чаще всего он уезжает под кнопку Еще. Откройте этот список |
|
Показ пункта пытаются ограничить ключом |
Точка не привязана к чату, и ключ |
Другие коды ошибок регистрации перечислены в разделе «Возможные коды ошибок» страницы placement.bind.
Продолжите изучение
- Виджеты в мессенджере: обзор точек встраивания
- Виджет для сайдбара IM_SIDEBAR
- Виджет над полем ввода IM_TEXTAREA
- Пункт контекстного меню сообщения IM_CONTEXT_MENU
- Зарегистрировать обработчик виджета placement.bind
- Взаимодействие с UI: обзор методов
- Методы BX24 SDK для виджетов
- Интерактивность в приложениях: обзор методов