#Получить бота

GET /v1/bots/:botId

Получает актуальные данные о боте из Битрикс24 (живой запрос, не из кэша).

#Параметры

Параметр Тип Обяз. Описание
botId number да ID бота (path-параметр)

#Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/bots/42 \
  -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/42', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Бот:', data)

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

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

#Поля ответа

Поле Тип Описание
id number ID бота
code string Уникальный код
type string Тип бота
isHidden boolean Скрыт из контактов
eventMode string Режим событий
properties.name string Имя
properties.lastName string Фамилия
properties.workPosition string Должность
properties.color string Цвет аватара
properties.gender string Пол
properties.avatar string URL аватара

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

JSON 
{
  "success": true,
  "data": {
    "id": 42,
    "code": "support_bot",
    "type": "bot",
    "isHidden": false,
    "eventMode": "fetch",
    "properties": {
      "name": "Техподдержка",
      "lastName": "",
      "workPosition": "Помощник по техническим вопросам",
      "color": "AZURE",
      "gender": "M",
      "avatar": ""
    }
  }
}

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

404 — бот не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BOT_NOT_FOUND",
    "message": "Bot 999 not found. Register it first via POST /v1/bots."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот не найден — зарегистрируйте через POST /v1/bots
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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