Responding to the imbot.v2.Command.answer Command
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
imbotWho can execute the method: owner of the registered bot
The imbot.v2.Command.answer method sends the bot's response to a slash command call.
The bot can respond in the chat from which the command originated, even if the bot is not a participant in that chat. Access is temporarily granted based on the command token — messageId + commandId. If the bot is not a participant in the chat, the message is sent as a system message indicating the bot's name.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
botId* |
Bot ID |
|
botToken |
Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth. Pass the same botToken that was specified during the chat bot registration |
|
commandId* |
Command ID |
|
messageId* |
Message ID with the command |
|
dialogId* |
Dialog ID. For group chats — |
|
fields |
Fields of the response message. The structure of the object is described below |
Parameter fields
|
Name |
Description |
|
message |
Response text. Maximum length — 20,000 characters |
|
attach |
Attachments. More details: How to use attachments |
|
keyboard |
Keyboard. More details: Working with keyboards |
|
system |
System message. Allowed values: |
|
urlPreview |
Show link previews. Allowed values: |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"botToken":"my_bot_token","commandId":42,"messageId":789,"dialogId":"chat5","fields":{"message":"Here is the help text..."}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.answer
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"commandId":42,"messageId":789,"dialogId":"chat5","fields":{"message":"Here is the help text..."},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Command.answer
try {
const response = await $b24.callMethod('imbot.v2.Command.answer', {
botId: 456,
commandId: 42,
messageId: 789,
dialogId: 'chat5',
fields: { message: 'Here is the help text...' },
});
const { result } = response.getData();
console.log('result:', result);
} catch (error) {
console.error('Error:', error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.command.answer(
bot_id=456,
command_id=42,
message_id=789,
dialog_id="chat5",
fields={
"message": "Here is the help text...",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'imbot.v2.Command.answer',
[
'botId' => 456,
'commandId' => 42,
'messageId' => 789,
'dialogId' => 'chat5',
'fields' => ['message' => 'Here is the help text...'],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error: ' . $exception->getMessage();
}
BX24.callMethod(
'imbot.v2.Command.answer',
{
botId: 456,
commandId: 42,
messageId: 789,
dialogId: 'chat5',
fields: { message: 'Here is the help text...' },
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.v2.Command.answer',
[
'botId' => 456,
'commandId' => 42,
'messageId' => 789,
'dialogId' => 'chat5',
'fields' => ['message' => 'Here is the help text...'],
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Answer sent';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imbot.v2.Command.answer", b24.Params{
"botId": 456,
"botToken": "my_bot_token",
"commandId": 42,
"messageId": 789,
"dialogId": "chat5",
"fields": b24.Params{
"message": "Here is the help text...",
},
})
if err != nil {
return fmt.Errorf("imbot.v2.Command.answer: %w", err)
}
var item struct {
Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Result)
Response Handling
HTTP Status: 200
{
"result": {
"result": true
},
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T10:00:00+02:00",
"date_finish": "2024-10-11T10:00:00+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the operation |
|
result.result |
|
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 403
{
"error": "COMMAND_ANSWER_FAILED",
"error_description": "Command answer failed"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Bot token is not specified |
|
|
|
Bot ID is required |
|
|
|
Bot not found |
Bot not found |
|
|
Bot is registered by another application |
Bot is registered by another application |
|
|
Command answer failed |
Error sending response |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |