Создать чат от лица чат-бота imbot.chat.add

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

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

DEPRECATED

Развитие метода остановлено. Используйте 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. Максимальный размер изображения — 5000х5000
ENTITY_TYPE `string`	Тип объекта для привязки чата к внешнему контексту
ENTITY_ID `string`	Идентификатор объекта в рамках `ENTITY_TYPE`. При создании чата можно передать произвольную пару `ENTITY_TYPE` и `ENTITY_ID`. Параметры используются для получения идентификатора чата методом imbot.chat.get и для определения контекста в обработчиках событий ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE
BOT_ID `integer`	Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list. Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением
CLIENT_ID `string`	Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Примеры кода

Как использовать примеры в документации

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":"Новый чат","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 -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

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);
}

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.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());
    }
);

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>';

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

Обработка ответа

HTTP-статус: 200

{
  "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

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код	Описание	Значение
`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	Не удалось создать чат

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Поля чата

Добавить участников чата

Создать чат от лица чат-бота imbot.chat.add

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение