# im.message.command

URL: https://chugunov.pro/api-bitrix24/chats/messages/im-message-command/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Выполнить команду чат-бота
Scope: `im`
Кто может выполнять метод: участник чата

## Описание

Метод `im.message.command` выполняет команду чат-бота в контексте сообщения.

## Параметры

- `MESSAGE_ID` `integer` — обязательный. Идентификатор сообщения, в контексте которого выполняется команда.
  Идентификатор можно получить с помощью метода [im.dialog.messages.get](https://chugunov.pro/api-bitrix24/chats/messages/im-dialog-messages-get/)
- `BOT_ID` `integer` — обязательный. Идентификатор бота.
  Идентификатор можно получить с помощью метода [imbot.bot.list](https://chugunov.pro/api-bitrix24/chat-bots/outdated/bots/imbot-bot-list/).
- `COMMAND` `string` — обязательный. Команда бота.
  Текст указывается при регистрации команды чат-ботом через метод [imbot.command.register](https://chugunov.pro/api-bitrix24/chat-bots/outdated/commands/imbot-command-register/)
- `COMMAND_PARAMS` `string` — необязательный. Параметр команды

## Ответ

HTTP-статус: 200

```json
{
    "result": true,
    "time": {
        "start": 1772633574,
        "finish": 1772633574.201127,
        "duration": 0.2011270523071289,
        "processing": 0,
        "date_start": "2026-03-04T17:12:54+03:00",
        "date_finish": "2026-03-04T17:12:54+03:00",
        "operating_reset_at": 1772634174,
        "operating": 0.10915994644165039
    }
}
```

### Возвращаемые данные

- `result` `boolean`. `true`, если команда выполнена
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "PARAMS_ERROR",
    "error_description": "Incorrect params"
}
```

- `MESSAGE_ID_ERROR` — Message ID can't be empty. Не передан или некорректен `MESSAGE_ID`
- `BOT_ID_ERROR` — Bot ID can't be empty. Не передан или некорректен `BOT_ID`
- `COMMAND_ERROR` — Command can't be empty. Не передан `COMMAND`
- `PARAMS_ERROR` — Incorrect params. Некорректные параметры команды

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"MESSAGE_ID":34261,"BOT_ID":1291,"COMMAND":"task","COMMAND_PARAMS":"task №1"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.command
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"MESSAGE_ID":34261,"BOT_ID":1291,"COMMAND":"task","COMMAND_PARAMS":"task №1","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.message.command
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'im.message.command',
    params: {
      MESSAGE_ID: 34261,
      BOT_ID: 1291,
      COMMAND: 'task',
      COMMAND_PARAMS: 'task №1',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Command executed successfully:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function executeMessageCommand() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.message.command',
        params: {
          MESSAGE_ID: 34261,
          BOT_ID: 1291,
          COMMAND: 'task',
          COMMAND_PARAMS: 'task №1',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Command executed successfully:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', executeMessageCommand)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.message.command(
        message_id=34261,
        bot_id=1291,
        command="task",
        command_params="task ?1",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'im.message.command',
            [
                'MESSAGE_ID' => 34261,
                'BOT_ID' => 1291,
                'COMMAND' => 'task',
                'COMMAND_PARAMS' => 'task №1'
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error executing command: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'im.message.command',
    {
        MESSAGE_ID: 34261,
        BOT_ID: 1291,
        COMMAND: 'task',
        COMMAND_PARAMS: 'task №1'
    },
    function(result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'im.message.command',
    [
        'MESSAGE_ID' => 34261,
        'BOT_ID' => 1291,
        'COMMAND' => 'task',
        'COMMAND_PARAMS' => 'task №1'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.message.command", b24.Params{
	"MESSAGE_ID":     34261,
	"BOT_ID":         1291,
	"COMMAND":        "task",
	"COMMAND_PARAMS": "task №1",
})
if err != nil {
	return fmt.Errorf("im.message.command: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-command.html
