#Список ботов

GET /v1/bots

Возвращает список ботов, зарегистрированных текущим API-ключом. Запрос выполняется к Bitrix24 imbot.v2.Bot.list.

#Параметры

Параметр Тип Обяз. Описание
limit number нет Максимальное количество ботов в ответе
offset number нет Смещение для пагинации
type string нет Фильтр по типу бота: bot, personal, supervisor, openline

#Примеры

#curl — личный ключ

Terminal 
curl https://vibecode.bitrix24.tech/v1/bots \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl https://vibecode.bitrix24.tech/v1/bots \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Мои боты:', data.bots)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

#Поля ответа

Поле Тип Описание
bots array Массив объектов ботов
bots[].id number ID бота на портале
bots[].code string Уникальный код бота
bots[].type string Тип: bot, personal, supervisor, openline
bots[].isHidden boolean Скрыт из списка контактов
bots[].eventMode string Режим событий: fetch или webhook
users array Массив пользователей Битрикс24, связанных с ботами
users[].id number ID пользователя
users[].name string Полное имя
users[].active boolean Пользователь активен
users[].bot boolean Является ботом
users[].type string Тип пользователя

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "bots": [
      {
        "id": 42,
        "code": "support_bot",
        "type": "bot",
        "isHidden": false,
        "eventMode": "fetch"
      },
      {
        "id": 58,
        "code": "analytics_bot",
        "type": "personal",
        "isHidden": false,
        "eventMode": "fetch"
      }
    ],
    "users": [
      {
        "id": 42,
        "name": "Техподдержка",
        "active": true,
        "bot": true,
        "type": "bot"
      },
      {
        "id": 58,
        "name": "Аналитик",
        "active": true,
        "bot": true,
        "type": "bot"
      }
    ]
  }
}

#Пример ответа при ошибке

403 — нет скоупа imbot:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'imbot' scope"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
502 BITRIX_UNAVAILABLE Портал Битрикс24 недоступен

Полный список общих ошибок API — Ошибки.

#Смотрите также