Список ботов приложения imbot.v2.Bot.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imbotКто может выполнять метод: авторизованный пользователь
Метод imbot.v2.Bot.list возвращает список ботов текущего приложения в расширенном формате. При вызове через вебхук — ботов, зарегистрированных с переданным botToken. Он заменяет метод imbot.bot.list первой версии API, соответствие параметров — в таблице миграции.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
botToken |
Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота |
|
filter |
Фильтр результатов. Доступные поля фильтра:
|
|
limit |
Количество ботов на страницу. По умолчанию |
|
offset |
Смещение для пагинации. По умолчанию |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botToken":"my_bot_token","filter":{"type":"bot"},"limit":10}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"type":"bot"},"limit":10,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Bot.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Minimal shape of result; the API returns the full Bot and User objects
// Shape of the payload returned in result (match the "response handling" section of the page)
type BotListResult = {
bots: Array<{
id: number
code: string
type: string
}>
users: Array<{
id: number
name: string
}>
hasNextPage: boolean
}
try {
const response = await $b24.actions.v2.call.make<BotListResult>({
method: 'imbot.v2.Bot.list',
params: {
botToken: 'my_bot_token',
filter: { type: 'bot' },
limit: 10,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Bots:', result.bots.length, '| Has next page:', result.hasNextPage)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listBots() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imbot.v2.Bot.list',
params: {
botToken: 'my_bot_token',
filter: { type: 'bot' },
limit: 10,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Bots:', result.bots.length, '| Has next page:', result.hasNextPage)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listBots)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.bot.list(
bot_token="my_bot_token",
filter={
"type": "bot",
},
limit=10,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'imbot.v2.Bot.list',
[
'botToken' => 'my_bot_token',
'filter' => ['type' => 'bot'],
'limit' => 10,
]
);
$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.list',
{
filter: { type: 'bot' },
limit: 10,
},
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.list',
[
'botToken' => 'my_bot_token',
'filter' => ['type' => 'bot'],
'limit' => 10,
]
);
if (!empty($result['error'])) {
echo 'Error: '. $result['error_description'];
} else {
foreach ($result['result']['bots'] as $bot) {
echo $bot['id']. ': '. $bot['code']. "\n";
}
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Bot.list", b24.Params{
"botToken": "my_bot_token",
"filter": b24.Params{
"type": "bot",
},
"limit": 10,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imbot.v2.Bot.list: %w", err)
}
var item struct {
HasNextPage bool `json:"hasNextPage"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.HasNextPage)
Обработка ответа
HTTP-статус: 200
{
"result": {
"bots": [
{
"id": 456,
"code": "support_bot",
"type": "bot",
"isHidden": false,
"isSupportOpenline": false,
"isReactionsEnabled": true,
"backgroundId": null,
"language": "ru",
"moduleId": "rest",
"eventMode": "fetch",
"countMessage": 150,
"countCommand": 3,
"countChat": 12,
"countUser": 45
}
],
"users": [
{
"id": 456,
"active": true,
"name": "Support Bot",
"bot": true,
"type": "bot"
}
],
"hasNextPage": false
},
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T09:00:00+03:00",
"date_finish": "2024-10-11T09:00:00+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Результат запроса |
|
result.bots |
Массив ботов в расширенном формате (подробное описание) |
|
result.users |
Массив связанных пользователей (подробное описание) |
|
result.hasNextPage |
Есть ли следующая страница |
|
time |
Информация о времени выполнения запроса |
Поля объекта Bot
|
Поле |
Описание |
|
id |
Идентификатор бота |
|
code |
Символьный код бота |
|
type |
Тип бота |
|
isHidden |
Бот скрыт от списка контактов |
|
isSupportOpenline |
Бот поддерживает открытые линии |
|
isReactionsEnabled |
Для сообщений бота включены реакции |
|
backgroundId |
ID фона чата или |
|
language |
Язык бота |
|
moduleId |
Идентификатор модуля |
|
eventMode |
Режим доставки событий: |
|
countMessage |
Количество сообщений, отправленных ботом |
|
countCommand |
Количество зарегистрированных команд |
|
countChat |
Количество чатов бота |
|
countUser |
Количество пользователей, взаимодействовавших с ботом |
Поля объекта User
В таблице и в примере ответа — основные поля. Метод возвращает объект User целиком.
|
Поле |
Описание |
|
id |
Идентификатор пользователя |
|
active |
Пользователь активен |
|
name |
Имя и фамилия пользователя |
|
bot |
Признак пользователя-бота |
|
type |
Тип пользователя |
Полное описание всех полей объектов — на странице Объекты и поля
Если у приложения нет ботов, передано неизвестное значение filter.type или чужой botToken, метод вернет пустой массив bots без ошибки.
Обработка ошибок
HTTP-статус: 400
{
"error": "BOT_TOKEN_NOT_SPECIFIED",
"error_description": "Bot token not specified (botToken is required for webhook auth)"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Bot token not specified (botToken is required for webhook auth) |
Не указан |
|
|
Invalid value {…} to match with parameter {…}. Should be value of type … |
В |
|
|
Internal server error. |
Передано отрицательное значение |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |