Set "Like" for the message imbot.message.like

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: imbot

Who can execute the method: an authorized user of the application that registered the chat bot. The method only works with bots of this application.

DEPRECATED

The development of this method has been halted. Please use the methods imbot.v2.Chat.Message.Reaction.add and imbot.v2.Chat.Message.Reaction.delete.

The method imbot.message.like sets or removes the "Like" mark for a message.

Method Parameters

Required parameters are marked with *

Name
Type

Description

BOT_ID
integer

The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.

If the parameter is not provided, the method searches for the first bot registered by the current application.

MESSAGE_ID*
integer

The identifier of the message in personal dialogs or group chats where the chat bot is present. The value must be greater than 0.

For messages sent by the bot via REST, the identifier is returned by the method imbot.message.add.

Message identifiers sent to the chat by users can be obtained using the method im.dialog.messages.get.

ACTION
string

The action for the message reaction.

Allowed values:

  • auto — automatically toggle the current status: if there is no "Like" reaction, it will be set; if there is a reaction, it will be removed.
  • plus — set "Like"
  • minus — remove "Like"

If the parameter is not provided, auto is used.

CLIENT_ID
string

This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot.

Code Examples

How to Use Examples in Documentation

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"MESSAGE_ID":19880117,"ACTION":"auto","CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.message.like
        
curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"MESSAGE_ID":19880117,"ACTION":"auto","auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.message.like
        
try {
          const response = await $b24.callMethod('imbot.message.like', {
            BOT_ID: 39,
            MESSAGE_ID: 19880117,
            ACTION: 'plus',
          });
        
          const { result } = response.getData();
          console.log('Like status changed:', result);
        } catch (error) {
          console.error('Error changing status:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.message.like',
                    [
                        'BOT_ID' => 39,
                        'MESSAGE_ID' => 19880117,
                        'ACTION' => 'auto',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Like status changed: ' . ($result->data() ? 'true' : 'false');
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error changing status: ' . $exception->getMessage();
        }
        
BX24.callMethod(
            'imbot.message.like',
            {
                BOT_ID: 39,
                MESSAGE_ID: 19880117,
                ACTION: 'auto',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.message.like',
            [
                'BOT_ID' => 39,
                'MESSAGE_ID' => 19880117,
                'ACTION' => 'auto',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Like status changed: ' . ($result['result'] ? 'true' : 'false');
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.message.like", b24.Params{
        	"BOT_ID":     39,
        	"MESSAGE_ID": 19880117,
        	"ACTION":     "auto",
        	"CLIENT_ID":  "**put_your_client_id_here**",
        })
        if err != nil {
        	return fmt.Errorf("imbot.message.like: %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)
        

Response Handling

HTTP Code: 200

{
            "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",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }
        

Returned Data

Name
Type

Description

result
boolean

true if the action was successful.

time
time

Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "WITHOUT_CHANGES",
            "error_description": "Action completed without changes"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

BOT_ID_ERROR

Bot not found

The bot was not found or the application does not have an available bot for auto-filling BOT_ID.

APP_ID_ERROR

Bot was installed by another REST application

The provided BOT_ID belongs to another application.

MESSAGE_ID_ERROR

Message ID can't be empty

The message identifier was not provided.

WITHOUT_CHANGES

Action completed without changes

The reaction state did not change after the call.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning