Создать чат im.chat.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imКто может выполнять метод: любой пользователь
Метод im.chat.add создает новый чат.
Параметры метода
Обязательные параметры отмечены *
Обязательных параметров у метода нет: без параметров он создает закрытый чат с автоматическим названием, где текущий пользователь — единственный участник и владелец.
|
Название |
Описание |
|
USERS |
Массив идентификаторов пользователей, которых нужно добавить в чат. Создатель чата добавляет в чат автоматически в роли Владельца чата |
|
TYPE |
Тип чата:
По умолчанию создается закрытый чат |
|
TITLE |
Название чата. Если не передать параметр, название сформируется автоматически по шаблону |
|
DESCRIPTION |
Описание чата |
|
COLOR |
Цвет чата. Возможные значения:
|
|
MESSAGE |
Первое сообщение в чате |
|
AVATAR |
Аватар чата в формате строки base64. Максимальный размер изображения — 5000х5000. Частые кейсы и сценарии |
|
ENTITY_TYPE |
Тип объекта для связи чата с внешним контекстом. Возможные значения:
|
|
ENTITY_ID |
Идентификатор объекта в рамках Передается строкой. Формат зависит от выбранного Поддерживаемые форматы для распространенных типов:
Для остальных |
|
COPILOT_MAIN_ROLE |
Код основной роли для BitrixGPT. Возможные значения:
|
Особенности работы с чатами групп и проектов
Для системного чата группы или проекта используется пара параметров:
{
"ENTITY_TYPE": "SONET_GROUP",
"ENTITY_ID": "133"
}
В ENTITY_TYPE передается строковое значение SONET_GROUP. В ENTITY_ID передается идентификатор группы или проекта.
Не передавайте эту пару в im.chat.add с идентификатором существующей группы или проекта, чтобы создать дополнительный чат внутри группы. Такой вызов может создать второй системный чат с той же привязкой.
Дубль системного чата может нарушить работу чатов задач в этой группе:
tasks.task.addсоздает задачу безchatIdи может вернуть ошибкуERROR_UNKNOWN_ADD_TASK_ERROR: There was an error while saving task chattasks.task.updateиtasks.task.deleteдля такой задачи могут вернуть ошибку0: There was an error while creating new task chat
Чаты с привязкой SONET_GROUP используются как штатные чаты групп и проектов. Их нельзя переименовать, удалить, покинуть или перепривязать стандартными методами управления чатами.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USERS":[103, 547],"TYPE":"CHAT","TITLE":"Чат по сделке","DESCRIPTION":"Здесь обсуждаем сделку","COLOR":"PINK","MESSAGE":"Добро пожаловать в чат сделки","ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USERS":[103, 547],"TYPE":"CHAT","TITLE":"Чат по сделке","DESCRIPTION":"Здесь обсуждаем сделку","COLOR":"PINK","MESSAGE":"Добро пожаловать в чат сделки","ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.chat.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'im.chat.add',
params: {
USERS: [103, 547],
TYPE: 'CHAT',
TITLE: 'Chat about deal',
DESCRIPTION: 'Discuss the deal here',
COLOR: 'PINK',
MESSAGE: 'Welcome to the deal chat',
ENTITY_TYPE: 'CRM',
ENTITY_ID: 'DEAL|1663',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created chat ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function createChat() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.chat.add',
params: {
USERS: [103, 547],
TYPE: 'CHAT',
TITLE: 'Chat about deal',
DESCRIPTION: 'Discuss the deal here',
COLOR: 'PINK',
MESSAGE: 'Welcome to the deal chat',
ENTITY_TYPE: 'CRM',
ENTITY_ID: 'DEAL|1663',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created chat ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', createChat)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.chat.add(
users=[
103,
547,
],
type="CHAT",
title="Чат по сделке",
description="Здесь обсуждаем сделку",
color="PINK",
message="Добро пожаловать в чат сделки",
entity_type="CRM",
entity_id="DEAL|1663",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'im.chat.add',
[
'USERS' => [103, 547],
'TYPE' => 'CHAT',
'TITLE' => 'Чат по сделке',
'DESCRIPTION' => 'Здесь обсуждаем сделку',
'COLOR' => 'PINK',
'MESSAGE' => 'Добро пожаловать в чат сделки',
'ENTITY_TYPE' => 'CRM',
'ENTITY_ID' => 'DEAL|1663',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'CHAT_ID: ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'im.chat.add',
{
USERS: [103, 547],
TYPE: 'CHAT',
TITLE: 'Чат по сделке',
DESCRIPTION: 'Здесь обсуждаем сделку',
COLOR: 'PINK',
MESSAGE: 'Добро пожаловать в чат сделки',
ENTITY_TYPE: 'CRM',
ENTITY_ID: 'DEAL|1663',
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.chat.add',
[
'USERS' => [103, 547],
'TYPE' => 'CHAT',
'TITLE' => 'Чат по сделке',
'DESCRIPTION' => 'Здесь обсуждаем сделку',
'COLOR' => 'PINK',
'MESSAGE' => 'Добро пожаловать в чат сделки',
'ENTITY_TYPE' => 'CRM',
'ENTITY_ID' => 'DEAL|1663',
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.chat.add", b24.Params{
"USERS": []int{103, 547},
"TYPE": "CHAT",
"TITLE": "Чат по сделке",
"DESCRIPTION": "Здесь обсуждаем сделку",
"COLOR": "PINK",
"MESSAGE": "Добро пожаловать в чат сделки",
"ENTITY_TYPE": "CRM",
"ENTITY_ID": "DEAL|1663",
})
if err != nil {
return fmt.Errorf("im.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": 1417,
"time": {
"start": 1772009915,
"finish": 1772009915.872788,
"duration": 0.8727879524230957,
"processing": 0,
"date_start": "2026-02-25T11:58:35+03:00",
"date_finish": "2026-02-25T11:58:35+03:00",
"operating_reset_at": 1772010515,
"operating": 0.20950984954833984
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданного чата |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 401
{
"error": "INVALID_CREDENTIALS",
"error_description": "Invalid request credentials"
}
У метода нет собственных кодов ошибок — возможны только системные ошибки REST API.
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |