# im.chat.add

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

Создать чат
Scope: `im`
Кто может выполнять метод: любой пользователь

## Описание

Метод `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.
  **Частые кейсы и сценарии**
  - [Как загрузить файлы](https://apidocs.bitrix24.ru/api-reference/files/how-to-upload-files.html)
- `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

## Ответ

HTTP-статус: 200

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

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


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

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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}")
```

### PHP

```php
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.js

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

### PHP CRest

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

### Go

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

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