Получить конфигурацию подключения к RT-серверам pull.application.config.get

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

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

Scope: pull

Кто может выполнять метод: пользователь авторизованный в приложении

Метод pull.application.config.get возвращает конфигурацию подключения к Push&Pull серверам для текущего приложения.

Метод работает только в контексте приложения.

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

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

Название
тип

Описание

CACHE
string

Использовать кешированные данные:

  • Y — использовать кеш
  • N — не использовать кеш

Если параметр не передан, кеш используется

REOPEN
string

Обновлять каналы при истечении срока:

  • Y — обновлять
  • N — не обновлять

Если параметр не передан, обновление включено

Примеры кода

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

Пример получения конфигурации Push&Pull для приложения, где:

  • CACHE — используется кешированные данных
  • REOPEN — обновляет каналы
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "CACHE": "Y",
    "REOPEN": "Y",
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/pull.application.config.get.json"

try
{
	const response = await $b24.callMethod(
		'pull.application.config.get',
		{
			CACHE: 'Y',
			REOPEN: 'Y'
		}
	);

	const result = response.getData().result;
	console.info(result);
}
catch (error)
{
	console.error(error);
}

try {
    $response = $b24Service
        ->core
        ->call(
            'pull.application.config.get',
            [
                'CACHE' => 'Y',
                'REOPEN' => 'Y',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting pull config: ' . $e->getMessage();
}

BX24.callMethod(
    'pull.application.config.get',
    {
        CACHE: 'Y',
        REOPEN: 'Y'
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);

$result = CRest::call(
    'pull.application.config.get',
    [
        'CACHE' => 'Y',
        'REOPEN' => 'Y',
    ]
);

echo '<pre>';
print_r($result);
echo '</pre>';

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

HTTP-статус: 200

{
    "result": {
        "server": {
            "version": 4,
            "server_enabled": true,
            "mode": "personal",
            "hostname": "your-portal.bitrix24.ru",
            "long_polling": "https://rtc-**.bitrix24.com/sub2/",
            "long_pooling_secure": "https://rtc-**.bitrix24.com/sub2/",
            "websocket_enabled": true,
            "websocket": "wss://rtc-**.bitrix24.com/subws2/",
            "websocket_secure": "wss://rtc-**.bitrix24.com/subws2/",
            "publish_enabled": true,
            "publish": "https://rtc-**.bitrix24.com/rest/",
            "publish_secure": "https://rtc-**.bitrix24.com/rest/",
            "config_timestamp": 1774886062
        },
        "api": {
            "revision_web": 19,
            "revision_mobile": 3
        },
        "channels": {
            "shared": {
                "id": "***masked***",
                "start": "2026-03-31T17:05:18+03:00",
                "end": "2026-04-01T05:05:23+03:00",
                "type": "shared"
            },
            "private": {
                "id": "***masked***",
                "public_id": "***masked***",
                "start": "2026-03-31T17:05:18+03:00",
                "end": "2026-04-01T05:05:23+03:00",
                "type": "private"
            }
        },
        "exp": 1775052318,
        "publicChannels": {
            "<user_id>": {
                "user_id": 577,
                "public_id": "***masked***",
                "signature": "***masked***",
                "start": "2026-03-31T10:06:39+03:00",
                "end": "2026-03-31T22:06:44+03:00"
            }
        }
    },
    "time": {
        "start": 1774965918,
        "finish": 1774965918.322255,
        "duration": 0.32225489616394043,
        "processing": 0,
        "date_start": "2026-03-31T17:05:18+03:00",
        "date_finish": "2026-03-31T17:05:18+03:00",
        "operating_reset_at": 1774966518,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n
}

где:

  • field_n — поле объекта result
  • value_n — значение поля result

Поля объекта result смотрите в разделе Тип result.

Состав полей может отличаться и зависит от конфигурации Push&Pull сервера

time
time

Информация о времени выполнения запроса

Тип result

Название
тип

Описание

server
object

Параметры сервера Push&Pull подробнее

api
object

Версии API Push&Pull:

  • revision_web integer — версия web API
  • revision_mobile integer — версия mobile API

channels
object

Каналы приложения.

Содержит два варианта канала: shared и private.

Описание полей канала смотрите в разделе Тип канала shared/private

exp
integer

Время истечения конфигурации в формате Unix timestamp

publicChannels
object

Публичные каналы пользователей в формате:

{
    "<user_id>": {
        "user_id": user_id,
        "public_id": "string",
        "signature": "string",
        "start": "datetime",
        "end": "datetime"
    }
}

где:

  • <user_id> — идентификатор пользователя
  • user_id — идентификатор пользователя
  • public_id — публичный идентификатор канала
  • signature — подпись канала
  • start — время начала действия канала
  • end — время окончания действия канала

clientId
string

Публичный идентификатор клиента.

Возвращается в shared-режиме сервера

jwt
string

JWT-токен для подключения.

Возвращается, если включена выдача JWT в конфигурации сервера

Тип server

Название
тип

Описание

version
integer

Версия Push&Pull сервера

server_enabled
boolean

Признак доступности сервера

mode
string

Режим сервера:

  • personal — собственный сервер Push&Pull
  • shared — общий сервер Push&Pull

hostname
string

Хост портала

long_polling
string

URL long polling

long_pooling_secure
string

URL long polling для защищенного соединения

websocket_enabled
boolean

Признак доступности websocket

websocket
string

URL websocket

websocket_secure
string

URL websocket для защищенного соединения

publish_enabled
boolean

Признак доступности publish API

publish
string

URL publish API

publish_secure
string

URL publish API для защищенного соединения

config_timestamp
integer

Метка версии конфигурации

Тип канала shared/private

Название
тип

Описание

id
string

Идентификатор канала

public_id
string | null

Публичный идентификатор канала.

Для shared может отсутствовать

start
datetime

Время начала действия канала

end
datetime

Время окончания действия канала

type
string

Тип канала:

  • shared
  • private

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

HTTP-статус: 403

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Get access to application config available only for application authorization."
}

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Get access to application config available only for application authorization.

Вызов метода не из контекста OAuth-приложения

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Push&Pull
Следующая
Отправить события в RT-канал приложения