im-message-command.md

Execute the chat-bot command im.message.command

{% note tip "" %}

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.

{% endnote %}

Scope: im

Who can execute the method: chat participant

The method im.message.command executes a chat-bot command in the context of a message.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || MESSAGE_ID* integer | The identifier of the message in the context of which the command is executed.

The identifier can be obtained using the method im.dialog.messages.get || || BOT_ID* integer | The identifier of the bot.

The identifier can be obtained using the method imbot.bot.list. || || COMMAND* string | The bot command.

The text is specified when registering the command by the chat-bot through the method imbot.command.register || || COMMAND_PARAMS string | Command parameter || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  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)

  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)

  // 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)

  <!-- 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>

• 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

  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

  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

  // client and ctx are already created — see the Go SDK section
  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("parse response: %w", err)
  }
  fmt.Println("done:", ok)

{% endlist %}

Response Handling

HTTP Status: 200

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

Returned Data

#| || Name type | Description || || result boolean | true if the command was executed successfully || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400

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

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description | Value || || MESSAGE_ID_ERROR | Message ID can't be empty | MESSAGE_ID is missing or incorrect || || BOT_ID_ERROR | Bot ID can't be empty | BOT_ID is missing or incorrect || || COMMAND_ERROR | Command can't be empty | COMMAND is missing || || PARAMS_ERROR | Incorrect params | Command parameters are incorrect || |#

{% include system errors %}

Continue Learning

• {#T}
• {#T}
• {#T}