Отправить ответ на команду imbot.command.answer
Scope:
imbotКто может выполнять метод: пользователь приложения, которое зарегистрировало чат-бота
DEPRECATED
Развитие метода остановлено. Используйте imbot.v2.Command.answer.
Метод imbot.command.answer публикует ответ на команду чат-бота.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
COMMAND_ID* |
Идентификатор команды. Обязателен, если не передан |
|
COMMAND* |
Текст команды. Обязателен, если не передан |
|
MESSAGE_ID* |
Идентификатор сообщения, на которое отправляется ответ. Идентификатор можно узнать из входящего события ONIMCOMMANDADD |
|
MESSAGE* |
Текст ответа |
|
ATTACH |
Объект с вложением к сообщению. Минимальный формат:
|
|
KEYBOARD |
Клавиатура сообщения. Минимальный формат:
|
|
MENU |
Контекстное меню сообщения. Минимальный формат:
|
|
SYSTEM |
Тип сообщения:
По умолчанию - |
|
URL_PREVIEW |
Преобразование ссылок в rich-ссылки:
По умолчанию - Работает для ссылок, переданных в поле |
|
CLIENT_ID |
Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота |
Примеры кода
Как использовать примеры в документации
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"COMMAND_ID":99,"MESSAGE_ID":33871,"MESSAGE":"Принято. Выполняю команду.","SYSTEM":"N","URL_PREVIEW":"Y","ATTACH":{"BLOCKS":[{"MESSAGE":"Детали задачи"},{"DELIMITER":true},{"LINK":{"NAME":"Открыть","LINK":"https://example.com"}}]},"KEYBOARD":{"BUTTONS":[{"TEXT":"Повторить","COMMAND":"echo repeat"}]},"MENU":[{"TEXT":"bitrix24","LINK":"https://bitrix24.ru"}],"CLIENT_ID":"**put_your_client_id_here**"}' /
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.command.answer
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"COMMAND_ID":99,"MESSAGE_ID":33871,"MESSAGE":"Принято. Выполняю команду.","SYSTEM":"N","URL_PREVIEW":"Y","ATTACH":{"BLOCKS":[{"MESSAGE":"Детали задачи"},{"DELIMITER":true},{"LINK":{"NAME":"Открыть","LINK":"https://example.com"}}]},"KEYBOARD":{"BUTTONS":[{"TEXT":"Повторить","COMMAND":"echo repeat"}]},"MENU":[{"TEXT":"bitrix24","LINK":"https://bitrix24.ru"}],"auth":"**put_access_token_here**"}' /
https://**put_your_bitrix24_address**/rest/imbot.command.answer
try
{
const response = await $b24.callMethod(
'imbot.command.answer',
{
COMMAND_ID: 99,
MESSAGE_ID: 33871,
MESSAGE: 'Принято. Выполняю команду.',
SYSTEM: 'N',
URL_PREVIEW: 'Y',
ATTACH: {
BLOCKS: [
{MESSAGE: 'Детали задачи'},
{DELIMITER: true},
{LINK: {NAME: 'Открыть', LINK: 'https://example.com'}}
]
},
KEYBOARD: {
BUTTONS: [
{TEXT: 'Повторить', COMMAND: 'echo repeat'}
]
},
MENU: [
{TEXT: 'bitrix24', LINK: 'https://bitrix24.ru'}
]
}
);
const result = response.getData().result;
console.log('Answered command with ID:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'imbot.command.answer',
[
'COMMAND_ID' => 99,
'MESSAGE_ID' => 33871,
'MESSAGE' => 'Принято. Выполняю команду.',
'SYSTEM' => 'N',
'URL_PREVIEW' => 'Y',
'ATTACH' => [
'BLOCKS' => [
['MESSAGE' => 'Детали задачи'],
['DELIMITER' => true],
['LINK' => ['NAME' => 'Открыть', 'LINK' => 'https://example.com']]
]
],
'KEYBOARD' => [
'BUTTONS' => [
['TEXT' => 'Повторить', 'COMMAND' => 'echo repeat']
]
],
'MENU' => [
['TEXT' => 'bitrix24', 'LINK' => 'https://bitrix24.ru']
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error answering command: ' . $e->getMessage();
}
BX24.callMethod(
'imbot.command.answer',
{
COMMAND_ID: 99,
MESSAGE_ID: 33871,
MESSAGE: 'Принято. Выполняю команду.',
SYSTEM: 'N',
URL_PREVIEW: 'Y',
ATTACH: {
BLOCKS: [
{MESSAGE: 'Детали задачи'},
{DELIMITER: true},
{LINK: {NAME: 'Открыть', LINK: 'https://example.com'}}
]
},
KEYBOARD: {
BUTTONS: [
{TEXT: 'Повторить', COMMAND: 'echo repeat'}
]
},
MENU: [
{TEXT: 'bitrix24', LINK: 'https://bitrix24.ru'}
]
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.command.answer',
[
'COMMAND_ID' => 99,
'MESSAGE_ID' => 33871,
'MESSAGE' => 'Принято. Выполняю команду.',
'SYSTEM' => 'N',
'URL_PREVIEW' => 'Y',
'ATTACH' => [
'BLOCKS' => [
['MESSAGE' => 'Детали задачи'],
['DELIMITER' => true],
['LINK' => ['NAME' => 'Открыть', 'LINK' => 'https://example.com']]
]
],
'KEYBOARD' => [
'BUTTONS' => [
['TEXT' => 'Повторить', 'COMMAND' => 'echo repeat']
]
],
'MENU' => [
['TEXT' => 'bitrix24', 'LINK' => 'https://bitrix24.ru']
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": 33879,
"time": {
"start": 1772102358,
"finish": 1772102359.061859,
"duration": 1.061858892440796,
"processing": 1,
"date_start": "2026-02-26T13:39:18+03:00",
"date_finish": "2026-02-26T13:39:19+03:00",
"operating_reset_at": 1772102958,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор отправленного сообщения-ответа |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "MESSAGE_EMPTY",
"error_description": "Message can't be empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Command not found |
Команда не найдена |
|
|
Command was installed by another rest application |
Команда зарегистрирована другим приложением |
|
|
Message ID can't be empty |
Не передан |
|
|
Message can't be empty |
Не передан текст сообщения |
|
|
Incorrect attach params |
Невалидный объект |
|
|
You have exceeded the maximum allowable size of attach |
Размер |
|
|
Incorrect keyboard params |
Невалидный объект |
|
|
You have exceeded the maximum allowable size of keyboard |
Размер |
|
|
Incorrect menu params |
Невалидный объект |
|
|
Message isn't added |
Не удалось отправить сообщение |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить команду imbot.command.register
- Обновить команду imbot.command.update
- Удалить команду imbot.command.unregister
- Событие при вызове команды чат-бота ONIMCOMMANDADD
- Работа с клавиатурами
- Вложения в сообщениях
- Работа с контекстным меню