Получить список чат-ботов imbot.bot.list

Scope: imbot

Кто может выполнять метод: авторизованный пользователь приложения

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Bot.list.

Метод imbot.bot.list возвращает список зарегистрированных чат-ботов.

Без параметров.

Примеры кода

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

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']);
        }

Обработка ответа

HTTP-код: 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+03:00",
                "date_finish": "2024-10-11T10:00:00+03:00",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

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

Название
Тип

Описание

result
object

Объект, где ключ верхнего уровня равен BOT_ID, а значение содержит данные бота. Структура элемента подробно описана ниже

time
time

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

Элемент /

Название
Тип

Описание

ID
integer

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

NAME
string

Полное имя чат-бота

CODE
string

Код чат-бота

OPENLINE
string

Признак поддержки открытых линий: Y или N

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

HTTP-статус: 403

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

WRONG_AUTH_TYPE

Access for this method not allowed by session authorization.

Метод вызван с сессионной авторизацией вместо OAuth или вебхука

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

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