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

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

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

Метод BX24.openPath открывает указанный путь внутри Битрикс24 в слайдере.

void BX24.openPath(String path[, Function callback])

По соображениям безопасности метод не работает в мобильном приложении.

Параметры

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

Название
тип

Описание

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
function

Функция обратного вызова. Вызывается при ошибке открытия пути или при закрытии слайдера

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

Перед открытием SDK автоматически добавляет к пути служебные параметры:
from=rest_placement&from_app={appId}.

Пример кода

BX24.init(function () {
    BX24.openPath('/crm/deal/details/5/', function (result) {
        console.log(result);
    });
});

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

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

Метод не возвращает данные (void).

Если передан callback, в него приходит объект результата.

Результат callback

Название
тип

Описание

result
string

Статус выполнения: close или error

errorCode
string

Код ошибки. Передается только при result: "error". Возможные значения: PATH_NOT_AVAILABLE, METHOD_NOT_SUPPORTED_ON_DEVICE

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