Виджет для сайдбара IM_SIDEBAR

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: placement, im

Виджет добавляет свой пункт в сайдбар чата.

Код точки встраивания указывается в параметре PLACEMENT метода placement.bind.

Виджет не отображается в интерфейсе, пока установка приложения не завершена. Проверьте установку приложения

Куда встраивается виджет

Код точки встраивания

Место

IM_SIDEBAR

Пункт в сайдбаре чата

Где находится в интерфейсе

Откройте чат и нажмите кнопку сайдбара в правой части верхней панели чата. В открывшемся сайдбаре внизу есть блок Приложения, в котором отображается пункт приложения с PLACEMENT=IM_SIDEBAR.

Пункт в сайдбаре чата

Что получает обработчик

Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса

Array
(
    [DOMAIN] => xxx.bitrix24.com
    [PROTOCOL] => 1
    [LANG] => ru
    [APP_SID] => 99c80eff6378726287350416ee5fef0
    [AUTH_ID] => 6061e72600631fcd00005a4b00000001f0f1076700000000f69dd5fc643d9ce2fdbc1
    [AUTH_EXPIRES] => 3600
    [REFRESH_ID] => 50e00aa340631fcd00005a4b00000001f0f1071111116580a5b83c2de639ef28c12
    [SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
    [APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
    [APPLICATION_SCOPE] => im,placement
    [member_id] => da45a03b265ed12127f8a258d793cc5d
    [status] => L
    [PLACEMENT] => IM_SIDEBAR
    [PLACEMENT_OPTIONS] => {"dialogId":"chat1","URI":"\/online\/"}
)

Строка PLACEMENT_OPTIONS из этого примера после разбора выглядит так:

{
    "dialogId": "chat1",
    "URI": "/online/"
}

Обязательные параметры отмечены *

Параметры в query-строке адреса обработчика

Параметр
тип

Описание

DOMAIN*
string

Адрес Битрикс24, на котором был вызван обработчик виджета

PROTOCOL*
string

Защищенный или незащищенный протокол HTTP:

  • 0 — HTTP
  • 1 — HTTPS

LANG*
string

Язык интерфейса пользователя Битрикс24, который вызвал виджет. Вы можете локализовать язык интерфейса в своем виджете, ориентируясь на это значение

APP_SID*
string

Идентификатор сессии приложения. Битрикс24 создает его заново при каждой отрисовке виджета и использует, чтобы связать js-библиотеку с окружением приложения

Параметры в теле POST-запроса

Параметр
тип

Описание

AUTH_ID
string

Авторизационный токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для вызовов REST API от лица этого пользователя

AUTH_EXPIRES
integer

Время в секундах, после которого авторизационный токен станет неактуальным

REFRESH_ID
string

Refresh-токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для обновления авторизационного токена от лица этого пользователя

SERVER_ENDPOINT*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2

APPLICATION_TOKEN*
string

Токен приложения. То же значение приходит в параметре application_token при вызове обработчиков событий. По нему обработчик виджета может проверить, что запрос пришел от Битрикс24

APPLICATION_SCOPE*
string

Список скоупов, выданных приложению, через запятую. Показывает, какие методы REST API доступны с полученным авторизационным токеном

member_id*
string

Уникальный строковый идентификатор Битрикс24, на котором был вызван обработчик виджета

status
string

Тип приложения, зарегистрировавшего обработчик данного виджета. Принимает значения:

PLACEMENT*
string

Код точки встраивания. Вы можете использовать один и тот же URL обработчика для всех своих виджетов. Значение, которое Битрикс24 будет сообщать в параметре PLACEMENT, поможет определить, из какой именно точки встраивания был вызван ваш обработчик в каждом конкретном случае

PLACEMENT_OPTIONS
string

Дополнительные данные в виде JSON-строки, определяющие контекст выполнения виджета. Например, это может быть массив, содержащий числовой идентификатор элемента CRM, в карточке которого был вызван обработчик виджета, и так далее. Параметр PLACEMENT_OPTIONS вместе с параметром PLACEMENT позволяет точно определить, для какой именно точки встраивания и какого объекта был вызван обработчик виджета

Битрикс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-строка с контекстом вызова.

Параметр
тип

Описание

dialogId*
string

Идентификатор чата, в сайдбаре которого открыт виджет: chatNNN для группового чата, идентификатор пользователя для личной переписки. Получить чат по нему можно методом im.dialog.get. Для личной переписки данные собеседника вернет метод user.get

URI*
string

Адрес страницы, с которой открыт виджет. Для мессенджера это /online/

OPTIONS при регистрации через placement.bind

Для IM_SIDEBAR метод placement.bind поддерживает параметры OPTIONS.

Обязательные параметры отмечены *

Параметр
тип

Описание

iconName*
string

Имя иконки Font Awesome 4, например fa-file-text-o. Класс набора fa Битрикс24 подставляет сам. До 50 символов, значение должно содержать латинские буквы, пробел или -

extranet
string

Доступ в экстранете, по умолчанию N.

Возможные значения:

  • N — приложение недоступно для экстранет-пользователей
  • Y — приложение доступно для экстранет-пользователей

context
string

Контекст показа, по умолчанию ALL. Можно передать несколько значений через ;.

Возможные значения:

  • ALL — все чаты
  • USER — личные чаты пользователей, кроме чатов с ботами
  • CHAT — групповые чаты, кроме LINES и CRM
  • LINES — чаты открытых линий
  • CRM — чаты, созданные в рамках CRM

Если передан ALL вместе с другими значениями, используется только ALL. Неверное значение вызывает ошибку регистрации

role
string

Роль пользователя, по умолчанию USER.

Возможные значения:

  • USER — приложение доступно всем пользователям
  • ADMIN — приложение доступно только администраторам портала

color
string

Цвет иконки из палитры IM.

Возможные значения:

  • RED — красный
  • GREEN — зеленый
  • MINT — мятный
  • LIGHT_BLUE — светло-голубой
  • DARK_BLUE — темно-синий
  • PURPLE — фиолетовый
  • AQUA — аквамариновый
  • PINK — розовый
  • LIME — лаймовый
  • BROWN — коричневый
  • AZURE — лазурный
  • KHAKI — хаки
  • SAND — песочный
  • ORANGE — оранжевый
  • MARENGO — маренго
  • GRAY — серый
  • GRAPHITE — графитовый

Примеры кода

Как использовать примеры в документации

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "PLACEMENT": "IM_SIDEBAR",
    "HANDLER": "https://your-domain.com/widgets/im-sidebar-handler.php",
    "TITLE": "Мой пункт сайдбара",
    "LANG_ALL": {
      "ru": {
        "TITLE": "Мой пункт сайдбара"
      },
      "en": {
        "TITLE": "My sidebar item"
      }
    },
    "OPTIONS": {
      "iconName": "fa-file-text-o",
      "context": "ALL",
      "role": "USER",
      "extranet": "N",
      "color": "LIGHT_BLUE"
    },
    "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_SIDEBAR',
      HANDLER: 'https://your-domain.com/widgets/im-sidebar-handler.php',
      TITLE: 'My sidebar item',
      LANG_ALL: {
        ru: {
          TITLE: 'Мой пункт сайдбара',
        },
        en: {
          TITLE: 'My sidebar item',
        },
      },
      OPTIONS: {
        iconName: 'fa-file-text-o',
        context: 'ALL',
        role: 'USER',
        extranet: 'N',
        color: 'LIGHT_BLUE',
      },
    },
    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 bindImSidebar() {
    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_SIDEBAR',
          HANDLER: 'https://your-domain.com/widgets/im-sidebar-handler.php',
          TITLE: 'My sidebar item',
          LANG_ALL: {
            ru: {
              TITLE: 'Мой пункт сайдбара',
            },
            en: {
              TITLE: 'My sidebar item',
            },
          },
          OPTIONS: {
            iconName: 'fa-file-text-o',
            context: 'ALL',
            role: 'USER',
            extranet: 'N',
            color: 'LIGHT_BLUE',
          },
        },
        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', bindImSidebar)
</script>
try {
    $response = $b24Service
        ->core
        ->call(
            'placement.bind',
            [
                'PLACEMENT' => 'IM_SIDEBAR',
                'HANDLER' => 'https://your-domain.com/widgets/im-sidebar-handler.php',
                'TITLE' => 'Мой пункт сайдбара',
                'LANG_ALL' => [
                    'ru' => [
                        'TITLE' => 'Мой пункт сайдбара',
                    ],
                    'en' => [
                        'TITLE' => 'My sidebar item',
                    ],
                ],
                'OPTIONS' => [
                    'iconName' => 'fa-file-text-o',
                    'context' => 'ALL',
                    'role' => 'USER',
                    'extranet' => 'N',
                    'color' => 'LIGHT_BLUE',
                ],
            ]
        );

    $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_SIDEBAR',
        HANDLER: 'https://your-domain.com/widgets/im-sidebar-handler.php',
        TITLE: 'Мой пункт сайдбара',
        LANG_ALL: {
            ru: { TITLE: 'Мой пункт сайдбара' },
            en: { TITLE: 'My sidebar item' }
        },
        OPTIONS: {
            iconName: 'fa-file-text-o',
            context: 'ALL',
            role: 'USER',
            extranet: 'N',
            color: 'LIGHT_BLUE'
        }
    },
    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_SIDEBAR',
        'HANDLER' => 'https://your-domain.com/widgets/im-sidebar-handler.php',
        'TITLE' => 'Мой пункт сайдбара',
        'LANG_ALL' => [
            'ru' => [
                'TITLE' => 'Мой пункт сайдбара',
            ],
            'en' => [
                'TITLE' => 'My sidebar item',
            ],
        ],
        'OPTIONS' => [
            'iconName' => 'fa-file-text-o',
            'context' => 'ALL',
            'role' => 'USER',
            'extranet' => 'N',
            'color' => 'LIGHT_BLUE',
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
	"PLACEMENT": "IM_SIDEBAR",
	"HANDLER":   "https://your-domain.com/widgets/im-sidebar-handler.php",
	"TITLE":     "Мой пункт сайдбара",
	"LANG_ALL": b24.Params{
		"ru": b24.Params{
			"TITLE": "Мой пункт сайдбара",
		},
		"en": b24.Params{
			"TITLE": "My sidebar item",
		},
	},
	"OPTIONS": b24.Params{
		"iconName": "fa-file-text-o",
		"context":  "ALL",
		"role":     "USER",
		"extranet": "N",
		"color":    "LIGHT_BLUE",
	},
})
if err != nil {
	return fmt.Errorf("placement.bind: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа из раздела «Обработка ответа» страницы placement.bind.
fmt.Printf("%s\n", res.Result)

Типовые ошибки

Ошибка

Как решить

placement.bind возвращает WRONG_AUTH_TYPE с описанием Application context required

Регистрируйте точку от имени приложения. Вебхуком точку не привязать

placement.bind возвращает ERROR_ARGUMENT

Не передан обязательный параметр OPTIONS[iconName]. Код незаполненного поля приходит в argument

Пункт не появился в блоке Приложения сайдбара чата

Завершите установку приложения и заново откройте чат

Регистрация не проходит из-за значения context

Используйте только допустимые значения: ALL, USER, CHAT, LINES, CRM

Пункт виден не в тех чатах, для которых задан context

Вместе с другими значениями передан ALL, и остальные значения не учитываются. Передавайте либо ALL, либо список конкретных контекстов через ;

Другие коды ошибок регистрации перечислены в разделе «Возможные коды ошибок» страницы placement.bind.

Продолжите изучение