Get API revisions imbot.v2.Revision.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: imbot

Who can execute the method: any user

The method imbot.v2.Revision.get returns the revision numbers of the REST API and client protocols of the messenger. It is used to check compatibility: which methods and features are supported by a specific Bitrix24.

Purpose of the Method

Cloud and on-premise versions of Bitrix24 may have different API revisions. Cloud Bitrix24 instances are updated automatically, while on-premise installations may lag behind in capabilities.

By calling imbot.v2.Revision.get before using new methods or fields, the application can:

determine which features are available on the current Bitrix24
adapt the bot's logic to the API revision
correctly handle scenarios where the required functionality is not yet available to the client

In the method documentation, you may see the note “available from revision N”. This means that the field or behavior was introduced starting from the specified revision.

Method Parameters

No parameters. The method does not require botId and botToken.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println(item.Rest, item.Web)

Response Handling

HTTP Status: 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+02:00",
            "date_finish": "2024-10-11T10:00:00+02:00"
          }
        }

Returned Data

Name `Type`	Description
result `object`	API revision numbers and client protocols (detailed description)
time `time`	Information about the request execution time

Fields of the Revision Object

Field `Type`	Description
rest `integer`	Revision of the server REST API. The main key for checking compatibility of methods and fields
web `integer`	Revision of the web client protocol of the messenger
mobile `integer`	Revision of the mobile client protocol
desktop `integer`	Revision of the desktop application protocol

Checking Compatibility Before a Call

A typical scenario is to check the revision before using a method or field that was not available from the start:

const response = await $b24.callMethod('imbot.v2.Revision.get', {});
        const restRevision = response.getData().result.rest;
        
        if (restRevision >= 33) {
            // the fields.system field is supported — send a system message
            await $b24.callMethod('imbot.v2.Chat.Message.send', {
                botId: 456,
                dialogId: 'chat5',
                fields: { message: 'Hello', system: true }
            });
        } else {
            // in earlier revisions, the fields.system field may be handled incorrectly
        }

The revision number from which a specific change becomes available is listed in the API Change Log for imbot.v2.

Error Handling

The method does not return call errors. Only standard REST API authorization errors may occur.

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	The REST API is available only on commercial plans. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Passing Context to the Bot When Opening a Chat

Overview of Methods

Get API revisions imbot.v2.Revision.get

Purpose of the MethodPurpose of the Method

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the Revision ObjectFields of the Revision Object

Checking Compatibility Before a CallChecking Compatibility Before a Call

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning