Получить список зарегистрированных приложением роботов bizproc.robot.list
Scope:
bizprocКто может выполнять метод: администратор
Метод возвращает список роботов, зарегистрированных приложением.
Работает только в контексте приложения.
Без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.robot.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'bizproc.robot.list',
{},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('bizproc.robot.list', {}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('bizproc.robot.list', {}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$result = $serviceBuilder
->getBizProcScope()
->robot()
->list();
foreach ($result->getRobots() as $robot) {
print($robot->code);
print($robot->name);
print($robot->handlerUrl);
print($robot->authUserId);
print($robot->isUseSubscription ? 'Yes' : 'No');
print($robot->isUsePlacement ? 'Yes' : 'No');
if ($robot->createdDate instanceof DateTime) {
print($robot->createdDate->format(DateTime::ATOM));
}
}
} catch (Throwable $e) {
// Handle the exception
print('Error: ' . $e->getMessage());
}
BX24.callMethod(
'bizproc.robot.list',
{},
function(result)
{
if(result.error())
alert("Error: " + result.error());
else
alert("Успешно: " + result.data().join(', '));
}
);
require_once('crest.php');
$result = CRest::call(
'bizproc.robot.list',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
"test_robot",
"sms_robot"
],
"time": {
"start": 1738151724.710429,
"finish": 1738151724.7319269,
"duration": 0.021497964859008789,
"processing": 0.0011229515075683594,
"date_start": "2025-01-29T14:55:24+03:00",
"date_finish": "2025-01-29T14:55:24+03:00",
"operating_reset_at": 1738152324,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список идентификаторов роботов приложения |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Сообщение об ошибке |
Описание |
|
|
Application context required |
Необходим контекст приложения |
|
|
Access denied! |
Метод выполнил не администратор |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Роботы приложений
- Зарегистрировать нового робота bizproc.robot.add
- Обновить поля робота bizproc.robot.update
- Удалить зарегистрированного робота bizproc.robot.delete
- Вернуть параметры действию или роботу bizproc.event.send