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

`POST /v1/bots/:botId/commands`

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

## Поля запроса (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"` — доступна для экстранет-пользователей |

Таблица перечисляет все принимаемые поля. Поле с другим именем отбрасывается, запрос при этом завершается успешно: в ответ добавляется объект `warning` с кодом `UNSUPPORTED_FIELDS_DROPPED` и списком отброшенных имён. Описательный текст команды передавайте в `title`, подсказку по аргументам — в `params`.

## Примеры

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

```bash
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-приложение

```bash
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.command.id)
```

### 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()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `data.command.id` | number | ID зарегистрированной команды |
| `data.command.botId` | number | ID бота |
| `data.command.command` | string | Текст команды (с `/`) |
| `data.command.common` | boolean | Доступна во всех чатах |
| `data.command.hidden` | boolean | Скрыта из списка |
| `data.command.extranetSupport` | boolean | Доступна экстранет-пользователям |
| `warning.code` | string | `UNSUPPORTED_FIELDS_DROPPED`. Приходит, когда в теле запроса было поле вне таблицы «Поля запроса» |
| `warning.message` | string | Текст с перечислением отброшенных полей |
| `warning.droppedFields` | array | Имена отброшенных полей |

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

Тело запроса содержало только принимаемые поля:

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

В теле запроса было поле `description` — команда зарегистрирована, поле отброшено:

```json
{
  "success": true,
  "data": {
    "command": {
      "id": 117,
      "botId": 1327,
      "command": "/help",
      "common": true,
      "hidden": false,
      "extranetSupport": false
    }
  },
  "warning": {
    "code": "UNSUPPORTED_FIELDS_DROPPED",
    "message": "Bitrix24 imbot.v2.Command.register does not accept these fields; they were dropped: description.",
    "droppedFields": ["description"]
  }
}
```

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

422 — ошибка Битрикс24:

```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-ключу |
| 422 | `BITRIX_ERROR` | Ошибка Битрикс24 (текст ошибки в `message`) |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `imbot` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

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

**Мультиязычность:** `title` и `params` принимают строку или объект с языковыми ключами, например `ru`, `en`, `de`. Строка сохраняется как английский перевод, поэтому русский текст задавайте объектом: `{ "ru": "Помощь", "en": "Help" }`.

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

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

- [Список команд](/docs/bots/commands/list)
- [Ответить на команду](/docs/bots/commands/answer)
- [События](/docs/bots/events)
- [Бот-платформа](/docs/bots)
- [Лимиты и оптимизация](/docs/optimization)