Create a Chat on Behalf of the Chatbot imbot.chat.add

Scope: imbot

Who can execute the method: a user of the application that registered the chatbot

The method imbot.chat.add creates a chat on behalf of the chatbot.

Method Parameters

Required parameters are marked with *

Name `type`	Description
TYPE `string`	Type of chat. Possible values: `OPEN` — open chat `CHAT` — closed chat Default is `CHAT`
TITLE `string`	Title of the chat
DESCRIPTION `string`	Description of the chat
COLOR `string`	Color of the chat for the mobile application. Possible values: `RED` — red `GREEN` — green `MINT` — mint `LIGHT_BLUE` — light blue `DARK_BLUE` — dark blue `PURPLE` — purple `AQUA` — aqua `PINK` — pink `LIME` — lime `BROWN` — brown `AZURE` — azure `KHAKI` — khaki `SAND` — sand `MARENGO` — marengo `GRAY` — gray `GRAPHITE` — graphite
MESSAGE `string`	Welcome message in the chat
USERS `array`	Array of chat participants
AVATAR `string`	Avatar of the chat in Base64 format. Maximum image size is 5000x5000
ENTITY_TYPE `string`	Type of the object to bind the chat to an external context
ENTITY_ID `string`	Identifier of the object within `ENTITY_TYPE`. When creating a chat, you can pass any pair of `ENTITY_TYPE` and `ENTITY_ID`. The parameters are used to retrieve the chat identifier using the method imbot.chat.get and to determine the context in event handlers ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE
BOT_ID `integer`	Identifier of the chatbot. You can obtain the bot identifier using the method imbot.bot.list. If the parameter is not provided, the method searches for the first bot registered by the current application
CLIENT_ID `string`	This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chatbot

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 '{"TYPE":"CHAT","TITLE":"New Chat","DESCRIPTION":"Important News","COLOR":"GREEN","MESSAGE":"Welcome!","USERS":[1271],"AVATAR":"/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==","ENTITY_TYPE":"CHAT","ENTITY_ID":"13","BOT_ID":1291,"CLIENT_ID":"**put_your_client_id_here**"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TYPE":"CHAT","TITLE":"New Chat","DESCRIPTION":"Important News","COLOR":"GREEN","MESSAGE":"Welcome!","USERS":[1271],"AVATAR":"/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==","ENTITY_TYPE":"CHAT","ENTITY_ID":"13","BOT_ID":1291,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/imbot.chat.add

try
        {
            const response = await $b24.callMethod(
                'imbot.chat.add',
                {
                    TYPE: 'CHAT',
                    TITLE: 'New Chat',
                    DESCRIPTION: 'Important News',
                    COLOR: 'GREEN',
                    MESSAGE: 'Welcome!',
                    USERS: [1271],
                    AVATAR: '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                    ENTITY_TYPE: 'CHAT',
                    ENTITY_ID: '13',
                    BOT_ID: 1291
                }
            );
            
            const result = response.getData().result;
            console.log('Created chat with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.chat.add',
                    [
                        'TYPE' => 'CHAT',
                        'TITLE' => 'New Chat',
                        'DESCRIPTION' => 'Important News',
                        'COLOR' => 'GREEN',
                        'MESSAGE' => 'Welcome!',
                        'USERS' => [1271],
                        'AVATAR' => '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                        'ENTITY_TYPE' => 'CHAT',
                        'ENTITY_ID' => '13',
                        'BOT_ID' => 1291
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding chat: ' . $e->getMessage();
        }

BX24.callMethod(
            'imbot.chat.add',
            {
                TYPE: 'CHAT',
                TITLE: 'New Chat',
                DESCRIPTION: 'Important News',
                COLOR: 'GREEN',
                MESSAGE: 'Welcome!',
                USERS: [1271],
                AVATAR: '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                ENTITY_TYPE: 'CHAT',
                ENTITY_ID: '13',
                BOT_ID: 1291
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.chat.add',
            [
                'TYPE' => 'CHAT',
                'TITLE' => 'New Chat',
                'DESCRIPTION' => 'Important News',
                'COLOR' => 'GREEN',
                'MESSAGE' => 'Welcome!',
                'USERS' => [1271],
                'AVATAR' => '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                'ENTITY_TYPE' => 'CHAT',
                'ENTITY_ID' => '13',
                'BOT_ID' => 1291
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
          "result": 2725,
          "time": {
              "start": 1771928379,
              "finish": 1771928380.102187,
              "duration": 1.102186918258667,
              "processing": 1,
              "date_start": "2026-02-24T13:19:39+01:00",
              "date_finish": "2026-02-24T13:19:40+01:00",
              "operating_reset_at": 1771928979,
              "operating": 0.3226499557495117
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created chat
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "WRONG_REQUEST",
            "error_description": "Chat can't be created"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`INVALID_FORMAT`	Parameter USERS has wrong type	The `USERS` parameter is in an incorrect format
`BOT_ID_ERROR`	Bot not found	Chatbot not found
`APP_ID_ERROR`	Bot was installed by another REST application	The specified chatbot was installed by another application
`WRONG_REQUEST`	Chat can't be created	Failed to create chat

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Chat Fields

Add Chat Participants

Create a Chat on Behalf of the Chatbot imbot.chat.add

Method ParametersMethod Parameters

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