Get the List of Chat Bots imbot.bot.list

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 application user

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Bot.list.

The method imbot.bot.list returns a list of registered chat bots.

No parameters required.

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.bot.list

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.bot.list

try {
          const response = await $b24.callMethod('imbot.bot.list', {});
          const { result } = response.getData();
          console.log('Bots:', result);
        } catch (error) {
          console.error('Error getting bot list:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call('imbot.bot.list', []);
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                print_r($result->data());
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error getting bot list: ' . $exception->getMessage();
        }

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

require_once('crest.php');
        
        $result = CRest::call('imbot.bot.list', []);
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            print_r($result['result']);
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.bot.list", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imbot.bot.list: %w", err)
        }
        
        // The response is an object whose top-level key is the ID.
        var items map[string]struct {
        	ID       b24.ID `json:"ID"`
        	Name     string `json:"NAME"`
        	Code     string `json:"CODE"`
        	Openline string `json:"OPENLINE"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for id, it := range items {
        	fmt.Println(id, it.Name)
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "39": {
                    "ID": 39,
                    "NAME": "NewBot",
                    "CODE": "newbot",
                    "OPENLINE": "N"
                }
            },
            "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",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `object`	An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below
time `time`	Information about the request execution time

Element {BOT_ID}

Name `Type`	Description
ID `integer`	Identifier of the chat bot
NAME `string`	Full name of the chat bot
CODE `string`	Code of the chat bot
OPENLINE `string`	Indicator of open line support: `Y` or `N`

Error Handling

HTTP Status: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Access for this method not allowed by session authorization."
        }

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

Possible Error Codes

Code	Description	Value
`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization.	The method was called with session authorization instead of OAuth or webhook

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?

Update a Chatbot

Delete a Chatbot

Get the List of Chat Bots imbot.bot.list

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Element {BOT_ID}Element {BOT_ID}

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning