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

The method does not require botId and botToken. There are no parameters.

How to Use

A typical scenario is to check before using a method or field that appeared in a specific revision:

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 may not work correctly in earlier revisions
        }

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

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

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']);

Response Handling

HTTP Code: 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

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Get a Download Link for the File

Overview of Methods

Get API Revisions imbot.v2.Revision.get

Purpose of the MethodPurpose of the Method

Method ParametersMethod Parameters

How to UseHow to Use

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the Revision ObjectFields of the Revision Object

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning