Create a Chat-Bot imbot.register

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 registers the chat-bot.

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Bot.register.

The method imbot.register registers a chat-bot and binds event handlers of the application.

If the bot runs as part of an application, events will not be sent to the application until the installation is complete. Check the application installation

Method Parameters

Required parameters are marked with *

Name `Type`	Description
CODE* `string`	The string code of the bot, unique within Bitrix24
TYPE `string`	The type of the bot. Allowed values: `B` — standard chat-bot. In group chats, it sees messages that are specifically addressed to it. `O` — chat-bot for Open Channels. `H` — chat-bot in "human" mode. Before auto-replying, it activates the "typing..." status `startWriting`. `S` — chat-bot with elevated privileges (supervisor). It reads all messages in the chats it is part of. If the bot was added with history visibility, it sees both old and new messages. If added without history, it only sees new messages. Default value: `B`
OPENLINE `string`	Operation mode with Open Channels. Allowed values: `Y` — enable Open Channels support mode `N` — disable, default value For `TYPE=O`, this parameter can be omitted. The value will be forcibly set to `Y`
EVENT_HANDLER `string`	General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`. If different handlers are needed, do not pass `EVENT_HANDLER`. Specify separate URLs in the parameters `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`
EVENT_MESSAGE_ADD* `string`	URL for the event handler ONIMBOTMESSAGEADD
EVENT_MESSAGE_UPDATE `string`	URL for the event handler ONIMBOTMESSAGEUPDATE. This parameter is ignored only for bots with `TYPE=B/H` and `OPENLINE=N`
EVENT_MESSAGE_DELETE `string`	URL for the event handler ONIMBOTMESSAGEDELETE. This parameter is ignored only for bots with `TYPE=B/H` and `OPENLINE=N`
EVENT_WELCOME_MESSAGE* `string`	URL for the event handler ONIMBOTJOINCHAT
EVENT_BOT_DELETE* `string`	URL for the event handler ONIMBOTDELETE
CLIENT_ID `string`	This parameter is required only for webhooks. Provide a unique CLIENT_ID — this key will be linked to the chat-bot and will be needed for all subsequent calls to imbot* via webhook
PROPERTIES* `object`	Properties of the chat-bot profile. The structure of the object is described in detail below

Parameter PROPERTIES

Name `Type`	Description
NAME* `string`	The name of the chat-bot. You must provide either `NAME` or `LAST_NAME`
LAST_NAME* `string`	The last name of the chat-bot. You must provide either `NAME` or `LAST_NAME`
COLOR `string`	The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE`
EMAIL `string`	Email for contacting the chat-bot. The bot is created as a user, so the bot's email must not match the email of a real Bitrix24 user. This will help avoid account conflicts
PERSONAL_BIRTHDAY `string`	Birthday in the format `YYYY-MM-DD`
WORK_POSITION `string`	Position or description of the chat-bot
PERSONAL_WWW `string`	Website link
PERSONAL_GENDER `string`	Gender, allowed values: `M` or `F`
PERSONAL_PHOTO `file`	Avatar of the chat-bot in Base64 The image size must not exceed the limit of 5000x5000

If the application logic allows, send a response to the bot upon explicit mention. This can be checked via the TO_USER_ID field.

Only one set of event handler URLs can be used in a single application.

If registering a second bot, the parameters EVENT_MESSAGE_ADD, EVENT_WELCOME_MESSAGE, and EVENT_BOT_DELETE must match those of the first bot.

If there are multiple bots in the application, differentiate them within a single event handler. Pass an array of bots in the event.

The maximum number of bots for a single application: 5

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"CODE":"newbot","TYPE":"B","EVENT_HANDLER":"https://example.com/bot/events","OPENLINE":"N","PROPERTIES":{"NAME":"NewBot","WORK_POSITION":"Support bot"},"CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.register

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"CODE":"newbot","TYPE":"B","EVENT_HANDLER":"https://example.com/bot/events","OPENLINE":"N","PROPERTIES":{"NAME":"NewBot"},"auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.register

try {
          const response = await $b24.callMethod('imbot.register', {
            CODE: 'newbot',
            TYPE: 'B',
            EVENT_HANDLER: 'https://example.com/bot/events',
            OPENLINE: 'N',
            PROPERTIES: {
              NAME: 'NewBot',
              WORK_POSITION: 'Support bot',
            },
          });
        
          const { result } = response.getData();
          console.log('Created bot ID:', result);
        } catch (error) {
          console.error('Error registering bot:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.register',
                    [
                        'CODE' => 'newbot',
                        'TYPE' => 'B',
                        'EVENT_HANDLER' => 'https://example.com/bot/events',
                        'OPENLINE' => 'N',
                        'PROPERTIES' => [
                            'NAME' => 'NewBot',
                            'WORK_POSITION' => 'Support bot',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Created bot ID: ' . $result->data();
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error registering bot: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imbot.register',
            {
                CODE: 'newbot',
                TYPE: 'B',
                EVENT_HANDLER: 'https://example.com/bot/events',
                OPENLINE: 'N',
                PROPERTIES: {
                    NAME: 'NewBot',
                    WORK_POSITION: 'Support bot',
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.register',
            [
                'CODE' => 'newbot',
                'TYPE' => 'B',
                'EVENT_HANDLER' => 'https://example.com/bot/events',
                'OPENLINE' => 'N',
                'PROPERTIES' => [
                    'NAME' => 'NewBot',
                    'WORK_POSITION' => 'Support bot',
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Created bot ID: ' . $result['result'];
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.register", b24.Params{
        	"CODE":          "newbot",
        	"TYPE":          "B",
        	"EVENT_HANDLER": "https://example.com/bot/events",
        	"OPENLINE":      "N",
        	"PROPERTIES": b24.Params{
        		"NAME":          "NewBot",
        		"WORK_POSITION": "Support bot",
        	},
        	"CLIENT_ID": "**put_your_client_id_here**",
        })
        if err != nil {
        	return fmt.Errorf("imbot.register: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)

Response Handling

HTTP Code: 200

{
            "result": 39,
            "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 `integer`	Identifier of the created chat-bot `BOT_ID`
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "CODE_ERROR",
            "error_description": "Bot code isn't specified"
        }

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
`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization	The method was called with session authorization instead of OAuth or webhook
`ACCESS_DENIED`	Access denied! Client ID not specified	Unable to determine the application: `clientId` authorization is missing and `CLIENT_ID` was not provided
`EVENT_MESSAGE_ADD_ERROR`	Handler for "Message add" event isn't specified	The required event handler `EVENT_MESSAGE_ADD` was not provided
`EVENT_MESSAGE_ADD_ERROR`	Wrong handler URL	An invalid URL was provided for `EVENT_MESSAGE_ADD`
`EVENT_MESSAGE_UPDATE_ERROR`	Wrong handler URL	An invalid URL was provided for `EVENT_MESSAGE_UPDATE`
`EVENT_MESSAGE_DELETE_ERROR`	Wrong handler URL	An invalid URL was provided for `EVENT_MESSAGE_DELETE`
`EVENT_WELCOME_MESSAGE_ERROR`	Handler for "Welcome message" event isn't specified	The required event handler `EVENT_WELCOME_MESSAGE` was not provided
`EVENT_WELCOME_MESSAGE_ERROR`	Wrong handler URL	An invalid URL was provided for `EVENT_WELCOME_MESSAGE`
`EVENT_BOT_DELETE_ERROR`	Handler for "Bot delete" event isn't specified	The required event handler `EVENT_BOT_DELETE` was not provided
`EVENT_BOT_DELETE_ERROR`	Wrong handler URL	An invalid URL was provided for `EVENT_BOT_DELETE`
`CODE_ERROR`	Bot code isn't specified	The required bot code `CODE` was not provided
`NAME_ERROR`	Bot name isn't specified	One of the required fields in `PROPERTIES` is missing: `NAME` or `LAST_NAME`
`MAX_COUNT_ERROR`	Has reached the maximum number of bots for application (max: N)	The limit on the number of bots for the application has been reached
`WRONG_REQUEST`	Bot can't be created	The bot cannot be created

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

Was the article helpful?

Overview of Methods

Update a Chatbot

Create a Chat-Bot imbot.register

Method ParametersMethod Parameters

Parameter PROPERTIESParameter PROPERTIES

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning