Получить адрес Битрикс24 BX24.getDomain

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

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

Метод BX24.getDomain возвращает адрес Битрикс24, в котором открыто приложение, например mycompany.bitrix24.ru. Протокола в адресе нет. Адрес пригодится, если ссылку на Битрикс24 нужно использовать вне него: например, отправить в письме или передать во внешнюю систему.

Адрес библиотека получает сразу при загрузке, поэтому метод работает и до BX24.init. Собственный scope методу не нужен.

Чтобы открыть страницу Битрикс24 из приложения, адрес собирать не нужно: передайте путь от корня, например /crm/deal/details/5/, в метод BX24.openPath.

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

Без параметров.

Пример кода

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

BX24.init(function () {
    const domain = BX24.getDomain();
    console.log(domain); // mycompany.bitrix24.ru
});

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

Метод синхронно возвращает результат типа string. Пример результата:

"mycompany.bitrix24.ru"

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

Название
тип

Описание

result
string

Адрес Битрикс24 без протокола. Порты 80 и 443 библиотека убирает, другой порт остается в адресе, например mycompany.ru:8080

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

Кодов ошибок метод не возвращает.

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