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:
imbotWho 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 -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']);
}
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 |
Description |
|
result |
An object where the top-level key is |
|
time |
Information about the request execution time |
Element /
|
Name |
Description |
|
ID |
Identifier of the chat bot |
|
NAME |
Full name of the chat bot |
|
CODE |
Code of the chat bot |
|
OPENLINE |
Indicator of open line support: |
Error Handling
HTTP Status: 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Access for this method not allowed by session authorization."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
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: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |