Для AI-агентов: markdown этой страницы — /docs-content/bots/commands/answer.md индекс документации — /llms.txt

Ответить на команду

POST /v1/bots/:botId/commands/:commandId/answer

Отправляет ответ на вызов slash-команды. Вызывайте из обработчика события ONIMBOTV2COMMANDADD.

Параметры

Параметр	Тип	Обяз.	Описание
`botId` (path)	number	да	ID бота. Список: `GET /v1/bots`
`commandId` (path)	number	да	ID команды. Приходит в поле `command.id` события бота `ONIMBOTV2COMMANDADD`. Список команд бота: `GET /v1/bots/:botId/commands`

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

Параметр	Тип	Обяз.	Описание
`messageId`	number	да	ID сообщения с вызовом команды. Приходит в поле `message.id` события `ONIMBOTV2COMMANDADD`
`dialogId`	string	да	ID диалога. Для группового чата — `chat{chatId}`, для личного — `{userId}`. Приходит в поле `chat.dialogId` события `ONIMBOTV2COMMANDADD`
`fields`	object	нет	Поля ответного сообщения
`fields.message`	string	нет	Текст ответа. Поддерживает BB-коды
`fields.keyboard`	array	нет	Интерактивная клавиатура
`fields.attach`	array/object	нет	ATTACH-блоки
`fields.system`	boolean	нет	Системное сообщение. По умолчанию `false`
`fields.urlPreview`	boolean	нет	Показывать превью ссылок. По умолчанию `true`

Примеры

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

Terminal

curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/commands/7/answer \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": 1510,
    "dialogId": "chat123",
    "fields": {
      "message": "[b]Справка по задачам[/b]\n\nДоступные действия:\n[SEND=/status]Проверить статус[/SEND]\n[SEND=/create]Создать задачу[/SEND]"
    }
  }'

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

Terminal

curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/commands/7/answer \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": 1510,
    "dialogId": "chat123",
    "fields": {
      "message": "[b]Справка по задачам[/b]\n\nДоступные действия:\n[SEND=/status]Проверить статус[/SEND]\n[SEND=/create]Создать задачу[/SEND]"
    }
  }'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/commands/7/answer', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    messageId: 1510,
    dialogId: 'chat123',
    fields: {
      message: '[b]Справка по задачам[/b]\n\nДоступные действия:\n[SEND=/status]Проверить статус[/SEND]',
    },
  }),
})

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

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/commands/7/answer', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    messageId: 1510,
    dialogId: 'chat123',
    fields: {
      message: '[b]Справка по задачам[/b]\n\nДоступные действия:\n[SEND=/status]Проверить статус[/SEND]',
    },
  }),
})

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

Поля ответа

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	object	Результат отправки ответа
`data.result`	boolean	`true` при успешной отправке ответа

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

JSON

{
  "success": true,
  "data": {
    "result": true
  }
}

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

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