метод REST scope: im

im.chat.add

Создать чат

Кто может выполнять: любой пользователь

Описание

Метод im.chat.add создает новый чат.

Параметры

USERS array необязательный

Массив идентификаторов пользователей, которых нужно добавить в чат.

Создатель чата добавляет в чат автоматически в роли Владельца чата

TYPE string необязательный

Тип чата:
- OPEN — открытый чат
- CHAT — закрытый чат

По умолчанию создается закрытый чат CHAT

TITLE string необязательный

Название чата.

Если не передать параметр, название сформируется автоматически по шаблону #COLOR# чат №#NUMBER# или Чат с #USERS_NAMES#

DESCRIPTION string необязательный

Описание чата

COLOR string необязательный

Цвет чата. Возможные значения:
- RED — красный
- GREEN — зеленый
- MINT — мятный
- LIGHT_BLUE — светло-синий
- DARK_BLUE — темно-синий
- PURPLE — фиолетовый
- AQUA — аквамариновый
- PINK — розовый
- LIME — лаймовый
- BROWN — коричневый
- AZURE — лазурный
- KHAKI — хаки
- SAND — песочный
- MARENGO — маренго
- GRAY — серый
- GRAPHITE — графитовый

MESSAGE string необязательный

Первое сообщение в чате

AVATAR string необязательный

Аватар чата в формате строки base64.

Максимальный размер изображения — 5000х5000.

Частые кейсы и сценарии

ENTITY_TYPE string необязательный

Тип объекта для связи чата с внешним контекстом.

Возможные значения:
- VIDEOCONF — чат видеоконференции
- AI_ASSISTANT_PRIVATE — приватный чат с AI-ассистентом
- LINES — чат открытой линии со стороны оператора
- LIVECHAT — чат открытой линии со стороны клиента
- ANNOUNCEMENT — чат объявлений
- CALENDAR — чат, связанный с событием календаря
- MAIL — чат, связанный с почтовой перепиской
- CRM — чат, связанный с CRM-элементом
- SONET_GROUP — системный чат группы или проекта. Не используйте это значение для создания дополнительного чата внутри существующей группы
- TASKS — чат, связанный с задачей
- CALL — чат, связанный со звонком

ENTITY_ID string необязательный

Идентификатор объекта в рамках ENTITY_TYPE.

Передается строкой. Формат зависит от выбранного ENTITY_TYPE.

Поддерживаемые форматы для распространенных типов:
- CRM<CRM_TYPE>|<ID>, например LEAD|13, DEAL|1663, CONTACT|25, COMPANY|7. Для смарт-процессов — DYNAMIC_<entityTypeId>|<itemId>
- LINES<connectorId>|<lineId>|<connectorChatId>|<connectorUserId>, например telegrambot|2|209607941|744
- LIVECHAT<connectorId>|<lineId>
- TASKS — идентификатор задачи, например 8293
- CALENDAR — идентификатор события календаря
- SONET_GROUP — идентификатор группы. Пара ENTITY_TYPE со значением SONET_GROUP и ENTITY_ID со значением идентификатора группы должна указывать только на штатный чат этой группы

Для остальных ENTITY_TYPE формат определяется модулем или интеграцией.

COPILOT_MAIN_ROLE string необязательный

Код основной роли для BitrixGPT.

Возможные значения:
- copilot_assistant — универсальная роль по умолчанию
- любой код доступной роли BitrixGPT из библиотеки AI

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

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

Ответ

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 integer

Идентификатор созданного чата

time time

Информация о времени выполнения запроса

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

HTTP-статус: 401

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.