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

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

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

Scope: imbot

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

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

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

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

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

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

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

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

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

Примеры кода

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

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

try {
  const response = await $b24.callMethod('imbot.v2.Revision.get', {});

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.revision.get().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call('imbot.v2.Revision.get');

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

    echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error: ' . $exception->getMessage();
}

BX24.callMethod(
    'imbot.v2.Revision.get',
    {},
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call('imbot.v2.Revision.get');

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    echo 'REST revision: ' . $result['result']['rest'];
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Revision.get", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imbot.v2.Revision.get: %w", err)
}

var item struct {
	Rest    int `json:"rest"`
	Web     int `json:"web"`
	Mobile  int `json:"mobile"`
	Desktop int `json:"desktop"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Rest, item.Web)

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

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

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

Проверка совместимости перед вызовом

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

const response = await $b24.callMethod('imbot.v2.Revision.get', {});
const restRevision = response.getData().result.rest;

if (restRevision >= 33) {
    // поле fields.system поддерживается — отправляем системное сообщение
    await $b24.callMethod('imbot.v2.Chat.Message.send', {
        botId: 456,
        dialogId: 'chat5',
        fields: { message: 'Hello', system: true }
    });
} else {
    // в более ранней ревизии поле fields.system может обрабатываться некорректно
}

Номер ревизии, начиная с которой доступно конкретное изменение, указан в Журнале изменений API imbot.v2.

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

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

Название
тип

Описание

error
string

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

error_description
string

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

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