Список ботов приложения imbot.v2.Bot.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

Кто может выполнять метод: владелец зарегистрированного бота

Метод imbot.v2.Bot.list возвращает список ботов текущего приложения в расширенном формате.

Параметры метода

Обязательные параметры отмечены *

Название
Тип

Описание

botToken
string

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

filter
object

Фильтр результатов.

Доступные поля фильтра:

limit
integer

Количество ботов на страницу. По умолчанию 50

offset
integer

Смещение для пагинации. По умолчанию 0

Примеры кода

Как использовать примеры в документации

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

try {
  const response = await $b24.callMethod('imbot.v2.Bot.list', {
    filter: { type: 'bot' },
    limit: 10,
  });

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.bot.list(
        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',
            [
                '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',
    [
        '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-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00"
    }
}

Возвращаемые данные

Название
Тип

Описание

result
object

Результат запроса

result.bots
Bot[]

Массив ботов в расширенном формате (подробное описание)

result.users
User[]

Массив связанных пользователей (подробное описание)

result.hasNextPage
boolean

Есть ли следующая страница

time
time

Информация о времени выполнения запроса

Поля объекта Bot

Поле
Тип

Описание

id
integer

Идентификатор бота

code
string

Символьный код бота

type
string

Тип бота

isHidden
boolean

Бот скрыт от списка контактов

isSupportOpenline
boolean

Бот поддерживает открытые линии

isReactionsEnabled
boolean

Для сообщений бота включены реакции

backgroundId
string|null

ID фона чата или null

language
string

Язык бота

moduleId
string

Идентификатор модуля

eventMode
string

Режим доставки событий: webhook или fetch

countMessage
integer

Количество сообщений, отправленных ботом

countCommand
integer

Количество зарегистрированных команд

countChat
integer

Количество чатов бота

countUser
integer

Количество пользователей, взаимодействовавших с ботом

Поля объекта User

Поле
Тип

Описание

id
integer

Идентификатор пользователя

active
boolean

Пользователь активен

name
string

Имя и фамилия пользователя

bot
boolean

Признак пользователя-бота

type
string

Тип пользователя

Полное описание всех полей объектов — на странице Объекты и поля

Метод всегда возвращает успешный ответ. Если у приложения нет ботов или передано неизвестное значение filter.type — возвращается пустой массив bots.

Обработка ошибок

HTTP-статус: 400, 403

{
    "error": "BOT_TOKEN_NOT_SPECIFIED",
    "error_description": "Bot token is not specified"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Значение

BOT_TOKEN_NOT_SPECIFIED

Bot token is not specified

Не указан botToken. Обязателен при авторизации через вебхук

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить информацию о боте
Следующая
Удалить бота