Get Information About the Bot imbot.v2.Bot.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: authorized user

The method imbot.v2.Bot.get returns information about the bot. It is used to verify the bot's installation.

For the owner application, it returns an extended format (including moduleId, appId, eventMode, and counters). For other applications, it returns a brief format.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
botId `integer`	Bot ID. Required if `code` is not specified
code `string`	Bot code. Required if `botId` is not specified
botToken `string`	Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth. Pass the same botToken that was specified during the chatbot registration

You must provide one of the parameters: botId or code.

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" \
          -d '{"botToken":"my_bot_token","code":"support_bot"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"code":"support_bot","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Bot.get

try {
          const response = await $b24.callMethod('imbot.v2.Bot.get', {
            code: 'support_bot',
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Bot.get',
                    [
                        'code' => 'support_bot',
                    ]
                );
        
            $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.Bot.get',
            {
                code: 'support_bot',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Bot.get',
            ['code' => 'support_bot']
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Bot ID: '. $result['result']['bot']['id'];
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "bot": {
                    "id": 456,
                    "code": "support_bot",
                    "type": "bot",
                    "isHidden": false,
                    "isSupportOpenline": false,
                    "isReactionsEnabled": true,
                    "backgroundId": null,
                    "language": "de",
                    "moduleId": "rest",
                    "appId": "local.67890abcdef12.34567890",
                    "eventMode": "fetch",
                    "countMessage": 150,
                    "countCommand": 3,
                    "countChat": 12,
                    "countUser": 45
                },
                "users": [
                    {
                        "id": 456,
                        "active": true,
                        "name": "Support Bot",
                        "bot": true,
                        "type": "bot"
                    }
                ]
            },
            "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`	Result of the request
result.bot `Bot`	Bot object. Extended format for the owner, brief for others (detailed description)
result.users `User[]`	Array of associated users (detailed description)
time `time`	Information about the request execution time

Fields of the Bot Object

Field `Type`	Description
id `integer`	Bot identifier
code `string`	Symbolic code of the bot
type `string`	Type of the bot
isHidden `boolean`	Bot is hidden from the contact list
isSupportOpenline `boolean`	Bot supports open channels
isReactionsEnabled `boolean`	Reactions are enabled for bot messages
backgroundId [`string	null`](../../../../data-types.md)	Chat background ID or `null`
language `string`	Language of the bot
moduleId `string`	Module identifier
appId `string`	ID of the application that registered the bot
eventMode `string`	Event delivery mode: `webhook` or `fetch`
countMessage `integer`	Number of messages sent by the bot
countCommand `integer`	Number of registered commands
countChat `integer`	Number of chats for the bot
countUser `integer`	Number of users who interacted with the bot

Fields of the User Object

Field `Type`	Description
id `integer`	User identifier
active `boolean`	User is active
name `string`	User's first and last name
bot `boolean`	Indicates if the user is a bot
type `string`	Type of user

A complete description of all object fields can be found on the Objects and Fields page.

Error Handling

HTTP Status: 400, 403

{
            "error": "BOT_NOT_FOUND",
            "error_description": "Bot not found"
        }

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

Possible Error Codes

Code	Description	Value
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` is not specified. Required for webhook authorization
`PARAMS_REQUIRED`	Required parameters are missing	Neither `botId` nor `code` is provided
`BOT_NOT_FOUND`	Bot not found	Bot not found

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

Update a Bot

List of Application Bots

Get Information About the Bot imbot.v2.Bot.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the Bot ObjectFields of the Bot Object

Fields of the User ObjectFields of the User Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning