Получить ревизии API imbot.v2.Revision.get

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: imbot

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

Метод imbot.v2.Revision.get возвращает номера ревизий REST API и клиентских протоколов мессенджера. Используется для проверки совместимости: какие методы и возможности поддерживает конкретный Битрикс24.

Зачем нужен метод

Облако и коробочные версии Битрикс24 могут иметь разные ревизии API. Облачные Битрикс24 обновляются автоматически, а коробочные установки могут отставать по возможностям.

Вызывая imbot.v2.Revision.get перед использованием новых методов или полей, приложение может:

  • определить, какие возможности доступны на текущем Битрикс24
  • адаптировать логику бота под ревизию API
  • корректно обрабатывать сценарии, когда нужный функционал еще не доступен у клиента

В документации по методам может встречаться пометка «доступно с ревизии N». Это означает, что поле или поведение появилось только начиная с указанной ревизии.

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

Метод не требует botId и botToken. Параметров нет.

Как использовать

Типичный сценарий — проверка перед использованием метода или поля, которое появилось в определенной ревизии:

const revision = await BX.rest.callMethod('imbot.v2.Revision.get', {});
        const restRevision = revision.data().rest;
        
        if (restRevision >= 33)
        {
            await BX.rest.callMethod('imbot.v2.Chat.Message.send', {
                botId: 456,
                botToken: '...',
                dialogId: 'chat5',
                fields: { message: 'Hello', system: true }
            });
        }
        else
        {
            // system может не работать корректно в более ранней ревизии
        }

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Revision.get
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Revision.get
        
BX.rest.callMethod('imbot.v2.Revision.get', {})
            .then(result => console.log(result.data()));
        
$result = $b24Service->core->call('imbot.v2.Revision.get');
        print_r($result->getResponseData()->getResult());
        
BX24.callMethod('imbot.v2.Revision.get', {}, function(result) {
            if (result.error()) {
                console.error(result.error().ex);
            } else {
                console.log(result.data());
            }
        });
        
$result = CRest::call('imbot.v2.Revision.get');
        print_r($result['result']);

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

HTTP-код: 200

{
          "result": {
            "rest": 33,
            "web": 130,
            "mobile": 23,
            "desktop": 6
          },
          "time": {
            "start": 1728626400.123,
            "finish": 1728626400.234,
            "duration": 0.111,
            "processing": 0.045,
            "date_start": "2024-10-11T10:00:00+03:00",
            "date_finish": "2024-10-11T10:00:00+03:00"
          }
        }

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

Название
Тип

Описание

result
object

Номера ревизий API и клиентских протоколов (подробное описание)

time
time

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

Поля объекта Revision

Поле
Тип

Описание

rest
integer

Ревизия серверного REST API. Основной ключ для проверки совместимости методов и полей

web
integer

Ревизия протокола веб-клиента мессенджера

mobile
integer

Ревизия протокола мобильного клиента

desktop
integer

Ревизия протокола десктоп-приложения

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

Метод не возвращает ошибок вызова. Возможны только стандартные ошибки авторизации REST API.

Название
тип

Описание

error
string

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

error_description
error_description

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

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

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

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

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

Предыдущая
Получить ссылку для скачивания файла
Следующая
Обзор методов