# im.chat.user.add

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

Пригласить участников в чат
Scope: `im`
Кто может выполнять метод: участник чата с правом добавлять участников в чат

## Описание

Метод `im.chat.user.add` добавляет пользователей в чат.

## Параметры

- `CHAT_ID` `integer` — обязательный. Идентификатор чата.
  Идентификатор чата можно получить с помощью метода [im.chat.get](https://chugunov.pro/api-bitrix24/chats/im-chat-get/)
- `USERS` `array` — обязательный. Массив идентификаторов пользователей, которых нужно добавить в чат.
  Идентификаторы пользователей можно получить с помощью методов [user.get](https://chugunov.pro/api-bitrix24/user/user-get/) и [user.search](https://chugunov.pro/api-bitrix24/user/user-search/)
- `HIDE_HISTORY` `string` — необязательный. Скрыть историю чата для добавляемых пользователей:
  - `Y` — скрыть
  - `N` — не скрывать 
  По умолчанию: `Y`

## Ответ

HTTP-статус: 200

```json
{
    "result": true,
    "time": {
        "start": 1772452546,
        "finish": 1772452546.179628,
        "duration": 0.1796278953552246,
        "processing": 0,
        "date_start": "2026-03-02T10:55:46+03:00",
        "date_finish": "2026-03-02T10:55:46+03:00",
        "operating_reset_at": 1772453146,
        "operating": 0.1326589584350586
    }
}
```

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

- `result` `boolean`. `true`, если пользователи добавлены в чат
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID can't be empty"
}
```

- `CHAT_ID_EMPTY` — Chat ID can't be empty. Не передан `CHAT_ID`
- `ACCESS_ERROR` — Action unavailable. Операция недоступна для этого чата
- `ACCESS_ERROR` — It is forbidden to add users to this chat. Нельзя добавлять пользователей в этот чат
- `ACCESS_DENIED_EXTEND` — Недостаточно прав на добавление участников в чат. Недостаточно прав для добавления участников в чат

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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":2935,"USERS":[99,1271],"HIDE_HISTORY":"N"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.user.add
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":2935,"USERS":[99,1271],"HIDE_HISTORY":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.chat.user.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<boolean>({
    method: 'im.chat.user.add',
    params: {
      CHAT_ID: 2935,
      USERS: [99, 1271],
      HIDE_HISTORY: 'N',
    },
    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('Users added to chat:', 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 addChatUsers() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.chat.user.add',
        params: {
          CHAT_ID: 2935,
          USERS: [99, 1271],
          HIDE_HISTORY: 'N',
        },
        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('Users added to chat:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addChatUsers)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.chat.user.add(
        chat_id=2935,
        users=[
            99,
            1271,
        ],
        hide_history=False,
    ).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.user.add',
            [
                'CHAT_ID' => 2935,
                'USERS' => [99, 1271],
                'HIDE_HISTORY' => 'N'
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding users to chat: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'im.chat.user.add',
    {
        CHAT_ID: 2935,
        USERS: [99, 1271],
        HIDE_HISTORY: 'N'
    },
    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.user.add',
    [
        'CHAT_ID' => 2935,
        'USERS' => [99, 1271],
        'HIDE_HISTORY' => 'N'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.chat.user.add", b24.Params{
	"CHAT_ID":      2935,
	"USERS":        []int{99, 1271},
	"HIDE_HISTORY": "N",
})
if err != nil {
	return fmt.Errorf("im.chat.user.add: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
```

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