#Зарегистрировать команду

POST /v1/bots/:botId/commands

Регистрирует новую slash-команду бота. Vibe принимает плоский формат и автоматически оборачивает в fields для Bitrix24.

#Поля запроса (body)

Параметр Тип Обяз. По умолч. Описание
command string да — Текст команды без / (например, help)
title string/object нет — Заголовок. Строка или мультиязычный объект { "ru": "Помощь", "en": "Help" }
params string/object нет — Описание параметров. Строка или объект { "ru": "тема", "en": "topic" }
common string нет "N" "Y" — доступна во всех чатах, "N" — только в личном диалоге с ботом и чатах с ботом
hidden string нет "N" "Y" — скрыть из списка команд
extranetSupport string нет "N" "Y" — доступна для экстранет-пользователей

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/commands \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "command": "help",
    "title": { "ru": "Помощь", "en": "Help" },
    "params": { "ru": "тема", "en": "topic" },
    "common": "Y"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/commands \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "command": "help",
    "title": { "ru": "Помощь", "en": "Help" },
    "params": { "ru": "тема", "en": "topic" },
    "common": "Y"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/commands', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    command: 'help',
    title: { ru: 'Помощь', en: 'Help' },
    params: { ru: 'тема', en: 'topic' },
    common: 'Y',
  }),
})

const { success, data } = await res.json()
console.log('Command ID:', data.commandId)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/commands', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    command: 'help',
    title: { ru: 'Помощь', en: 'Help' },
    params: { ru: 'тема', en: 'topic' },
    common: 'Y',
  }),
})

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

#Поля ответа

Поле Тип Описание
command.id number ID зарегистрированной команды
command.botId number ID бота
command.command string Текст команды (с /)
command.common boolean Доступна во всех чатах
command.hidden boolean Скрыта из списка
command.extranetSupport boolean Доступна экстранет-пользователям

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

JSON 
{
  "success": true,
  "data": {
    "command": {
      "id": 117,
      "botId": 1327,
      "command": "/help",
      "common": true,
      "hidden": false,
      "extranetSupport": false
    }
  }
}

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

502 — ошибка Bitrix24:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Command 'help' already registered"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Bitrix24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

#Известные особенности

Идемпотентность: повторный вызов с тем же command для того же бота возвращает существующую команду без изменений. Для обновления используйте PATCH.

Мультиязычность: title и params принимают как строку, так и объект с языковыми ключами (ru, en, de и т.д.).

Событие: при вызове команды пользователем срабатывает событие ONIMBOTV2COMMANDADD.

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