# imbot.chat.add

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

Создать чат от лица чат-бота
Scope: `imbot`
Кто может выполнять метод: пользователь приложения, которое зарегистрировало чат-бота

> Устаревший метод. Развитие метода остановлено. Используйте imbot.v2.Chat.add.

## Описание

Метод `imbot.chat.add` создает чат от лица чат-бота.

## Параметры

- `TYPE` `string` — необязательный. Тип чата. Возможные значения:
  - `OPEN` — открытый чат
  - `CHAT` — закрытый чат
  По умолчанию — `CHAT`
- `TITLE` `string` — необязательный. Заголовок чата
- `DESCRIPTION` `string` — необязательный. Описание чата
- `COLOR` `string` — необязательный. Цвет чата для мобильного приложения. Возможные значения:
  - `RED` — красный
  - `GREEN` — зеленый
  - `MINT` — мятный
  - `LIGHT_BLUE` — светло-синий
  - `DARK_BLUE` — темно-синий
  - `PURPLE` — фиолетовый
  - `AQUA` — аквамариновый
  - `PINK` — розовый
  - `LIME` — лаймовый
  - `BROWN` — коричневый
  - `AZURE` — лазурный
  - `KHAKI` — хаки
  - `SAND` — песочный
  - `MARENGO` — маренго
  - `GRAY` — серый
  - `GRAPHITE` — графитовый
- `MESSAGE` `string` — необязательный. Приветственное сообщение в чате
- `USERS` `array` — необязательный. Массив участников чата
- `AVATAR` `string` — необязательный. Аватар чата в формате [Base64](https://apidocs.bitrix24.ru/api-reference/files/how-to-upload-files.html).
  Максимальный размер изображения — 5000х5000
- `ENTITY_TYPE` `string` — необязательный. Тип объекта для привязки чата к внешнему контексту
- `ENTITY_ID` `string` — необязательный. Идентификатор объекта в рамках `ENTITY_TYPE`. 
  При создании чата можно передать произвольную пару `ENTITY_TYPE` и `ENTITY_ID`. Параметры используются для получения идентификатора чата методом [imbot.chat.get](https://chugunov.pro/api-bitrix24/chat-bots/outdated/chats/imbot-chat-get/) и для определения контекста в обработчиках событий [ONIMBOTMESSAGEADD](https://chugunov.pro/api-bitrix24/chat-bots/outdated/messages/events/on-imbot-message-add/), [ONIMBOTMESSAGEUPDATE](https://chugunov.pro/api-bitrix24/chat-bots/outdated/messages/events/on-imbot-message-update/), [ONIMBOTMESSAGEDELETE](https://chugunov.pro/api-bitrix24/chat-bots/outdated/messages/events/on-imbot-message-delete/)
- `BOT_ID` `integer` — необязательный. Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода [imbot.bot.list](https://chugunov.pro/api-bitrix24/chat-bots/outdated/bots/imbot-bot-list/).
  Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением
- `CLIENT_ID` `string` — необязательный. Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

## Ответ

HTTP-статус: 200

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

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

- `result` `integer`. Идентификатор созданного чата
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

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

- `INVALID_FORMAT` — Parameter USERS has wrong type. Параметр `USERS` передан в неверном формате
- `BOT_ID_ERROR` — Bot not found. Чат-бот не найден
- `APP_ID_ERROR` — Bot was installed by another rest application. Указанный чат-бот установлен другим приложением
- `WRONG_REQUEST` — Chat can't be created. Не удалось создать чат

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

### cURL (Webhook)

```bash
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"TYPE":"CHAT","TITLE":"Новый чат","DESCRIPTION":"Важные новости","COLOR":"GREEN","MESSAGE":"Добро пожаловать!","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 (OAuth)

```bash
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"TYPE":"CHAT","TITLE":"Новый чат","DESCRIPTION":"Важные новости","COLOR":"GREEN","MESSAGE":"Добро пожаловать!","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
```

### JS

```js
try
{
    const response = await $b24.callMethod(
        'imbot.chat.add',
        {
            TYPE: 'CHAT',
            TITLE: 'Новый чат',
            DESCRIPTION: 'Важные новости',
            COLOR: 'GREEN',
            MESSAGE: 'Добро пожаловать!',
            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);
}
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.chat.add',
            [
                'TYPE' => 'CHAT',
                'TITLE' => 'Новый чат',
                'DESCRIPTION' => 'Важные новости',
                'COLOR' => 'GREEN',
                'MESSAGE' => 'Добро пожаловать!',
                '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.js

```js
BX24.callMethod(
    'imbot.chat.add',
    {
        TYPE: 'CHAT',
        TITLE: 'Новый чат',
        DESCRIPTION: 'Важные новости',
        COLOR: 'GREEN',
        MESSAGE: 'Добро пожаловать!',
        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());
    }
);
```

### PHP CRest

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

$result = CRest::call(
    'imbot.chat.add',
    [
        'TYPE' => 'CHAT',
        'TITLE' => 'Новый чат',
        'DESCRIPTION' => 'Важные новости',
        'COLOR' => 'GREEN',
        'MESSAGE' => 'Добро пожаловать!',
        '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>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.chat.add", b24.Params{
	"TYPE":        "CHAT",
	"TITLE":       "Новый чат",
	"DESCRIPTION": "Важные новости",
	"COLOR":       "GREEN",
	"MESSAGE":     "Добро пожаловать!",
	"USERS":       []int{1271},
	"AVATAR":      "/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==",
	"ENTITY_TYPE": "CHAT",
	"ENTITY_ID":   "13",
	"BOT_ID":      1291,
	"CLIENT_ID":   "**put_your_client_id_here**",
})
if err != nil {
	return fmt.Errorf("imbot.chat.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-add.html