#Список команд

GET /v1/bots/:botId/commands

Возвращает все зарегистрированные команды бота.

#Параметры

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

#Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/bots/42/commands \
  -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/commands', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Команды:', data)

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

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

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
data array Массив команд
data[].id number ID команды
data[].command string Текст команды
data[].title string Заголовок (локализованный)
data[].params string Описание параметров (локализованное)
data[].common boolean Доступна во всех чатах
data[].hidden boolean Скрыта из списка
data[].extranetSupport boolean Доступна экстранет-пользователям

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 7,
      "command": "help",
      "title": "Помощь",
      "params": "тема",
      "common": true,
      "hidden": false,
      "extranetSupport": false
    },
    {
      "id": 8,
      "command": "status",
      "title": "Статус",
      "params": "",
      "common": false,
      "hidden": false,
      "extranetSupport": false
    }
  ]
}

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

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 Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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