Открыть путь в слайдере BX24.openPath

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

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
BX24.openPath(path: string, callback?: callable): void;

Метод BX24.openPath открывает страницу Битрикс24 в слайдере поверх приложения, например карточку сделки или профиль сотрудника. Когда пользователь закроет слайдер, он вернется в приложение.

Метод работает только внутри фрейма приложения в Битрикс24. Вызывайте его после инициализации библиотеки в обработчике BX24.init. Собственный scope методу не нужен: он управляет интерфейсом, а не обращается к REST API.

Метод не работает на телефонах и планшетах — ни в мобильном приложении, ни в мобильном браузере. Слайдер не откроется, а callback получит ошибку METHOD_NOT_SUPPORTED_ON_DEVICE.

Параметры метода

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

Название
тип

Описание

path*
string

Путь к странице того же Битрикс24, в котором открыто приложение. Путь начинается с /. Полный адрес с протоколом и доменом метод не откроет, даже если это адрес того же Битрикс24.

Числа в пути — это идентификаторы конкретных объектов. Подставляйте вместо них свои значения:

  • /crm/deal/details/5/ — карточка сделки, где 5 — идентификатор сделки
  • /crm/lead/details/12/ — карточка лида, где 12 — идентификатор лида
  • /crm/contact/details/2/ — карточка контакта, где 2 — идентификатор контакта
  • /crm/company/details/7/ — карточка компании, где 7 — идентификатор компании
  • /crm/type/128/details/3/ — карточка элемента смарт-процесса, где 128 — идентификатор типа смарт-процесса entityTypeId, а 3 — идентификатор самого элемента
  • /company/personal/user/1/ — профиль сотрудника, где 1 — идентификатор пользователя
  • /workgroups/group/4/ — рабочая группа или проект, где 4 — идентификатор группы
  • /marketplace/ — Маркетплейс, идентификатор не нужен

callback
callable

Функция обратного вызова. Вызывается один раз: когда пользователь закроет слайдер, когда путь не прошел проверку или когда приложение открыто на телефоне (подробное описание)

Идентификаторы объектов CRM возвращают методы списков и создания, например crm.item.list и crm.item.add. Идентификатор сотрудника возвращает user.get, а идентификатор рабочей группы — sonet_group.get.

Битрикс24 открывает страницу с дополнительными параметрами в адресе: from=rest_placement&from_app=<код приложения>. Код приложения — его client_id, например local.6ab58ce578dd87.16527213. Поэтому адрес открытой страницы отличается от переданного пути — учитывайте это, если сравниваете адреса.

Пример кода

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

BX24.init(function () {
    BX24.openPath('/crm/deal/details/5/', function (result) {
        if (result.result === 'error') {
            console.log('Не удалось открыть страницу:', result.errorCode);
            return;
        }

        console.log('Пользователь закрыл слайдер');
    });
});

Обработка ответа

Метод не возвращает данные (void). Когда пользователь закроет слайдер, Битрикс24 вызовет callback и передаст объект:

{
    "result": "close"
}

Если путь не прошел проверку или приложение открыто на телефоне, callback вызывается сразу, без слайдера:

{
    "result": "error",
    "errorCode": "PATH_NOT_AVAILABLE"
}

Возвращаемые данные

Название
тип

Описание

result
string

Итог: close — пользователь закрыл слайдер, error — слайдер не открылся

errorCode
string

Код ошибки. Есть только при result: "error"

Обработка ошибок

Код

Когда возникает

Что делать

PATH_NOT_AVAILABLE

Путь не прошел проверку: он пустой, не начинается с / — как полный адрес https://example.com/, — ведет на другой сайт или содержит знак % без кода символа, как /crm/%

Передать путь от корня Битрикс24, например /crm/deal/details/5/

METHOD_NOT_SUPPORTED_ON_DEVICE

Приложение открыто на телефоне или планшете

Показать пользователю, где найти страницу, или предложить открыть ее на компьютере

Существование страницы метод не проверяет. Если передать путь к несуществующей странице, слайдер все равно откроется, а после закрытия callback получит close.

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

Предыдущая
Загрузить javascript-файлы
Следующая
Позвонить по внутренней связи