# im.notify.system.add

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

Отправить системное уведомление
Scope: `im`
Кто может выполнять метод: любой пользователь

## Описание

Метод `im.notify.system.add` отправляет системное уведомление пользователю.

Метод нельзя вызвать с сессионной авторизацией — он вернет ошибку `WRONG_AUTH_TYPE`. Вызывайте его через вебхук или с токеном приложения.

## Параметры

- `USER_ID` `integer` — обязательный. Идентификатор пользователя-получателя уведомления.
  Получить идентификатор пользователя можно методами [user.get](https://chugunov.pro/api-bitrix24/user/user-get/), [user.search](https://chugunov.pro/api-bitrix24/user/user-search/) или [im.user.get](https://chugunov.pro/api-bitrix24/chats/users/im-user-get/)
- `MESSAGE` `string` — обязательный. Текст уведомления. Метод удаляет пробелы по краям строки перед отправкой. Поддерживает BB-коды — подробнее в разделе [Форматирование сообщений](https://apidocs.bitrix24.ru/api-reference/chats/messages/formatting.html)
- `MESSAGE_OUT` `string` — необязательный. Текст уведомления для внешних каналов, например, почты
- `TAG` `string` — необязательный. Уникальный тег уведомления в рамках приложения. При добавлении уведомления с существующим тегом другие уведомления будут удалены. Передавайте с `CLIENT_ID` при вызове через вебхук
- `SUB_TAG` `string` — необязательный. Дополнительный тег уведомления без проверки уникальности. Передавайте с `CLIENT_ID` при вызове через вебхук
- `ATTACH` `object` — необязательный. Вложение уведомления в формате объекта или JSON-строки. Подробнее смотрите в разделе [Вложения](https://apidocs.bitrix24.ru/api-reference/chats/messages/attachments.html)
- `CLIENT_ID` `string` — необязательный. Идентификатор приложения. Параметр обязателен только при вызове через вебхук: передавайте его вместе с `TAG` и `SUB_TAG`

## Ответ

HTTP-статус: 200

```json
{
    "result": 12345,
    "time": {
        "start": 1760000000.0,
        "finish": 1760000000.1,
        "duration": 0.1,
        "processing": 0.04,
        "date_start": "2026-03-02T09:30:00+03:00",
        "date_finish": "2026-03-02T09:30:00+03:00",
        "operating_reset_at": 1760030000,
        "operating": 0
    }
}
```

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

- `result` `integer`. Идентификатор созданного уведомления. Если уведомление не создано, может вернуться `false`
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "USER_ID_EMPTY",
    "error_description": "User ID can't be empty"
}
```

- `WRONG_AUTH_TYPE` — Access for this method not allowed by session authorization.. Метод вызван с сессионной авторизацией, для которой он запрещен
- `USER_ID_EMPTY` — User ID can't be empty. Параметр `USER_ID` не передан или `USER_ID <= 0`
- `MESSAGE_EMPTY` — Message can't be empty. Не передан текст сообщения
- `ATTACH_OVERSIZE` — You have exceeded the maximum allowable size of attach. Превышен допустимый размер вложения `ATTACH` — 60 000 символов
- `ATTACH_ERROR` — Incorrect attach params. Передан некорректный формат вложения `ATTACH`

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

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"USER_ID":5,"MESSAGE":"Системное уведомление","MESSAGE_OUT":"Системное уведомление для email","TAG":"SYSTEM_EVENT_42","SUB_TAG":"SYSTEM_EVENT|42"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.system.add
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"USER_ID":5,"MESSAGE":"Системное уведомление","MESSAGE_OUT":"Системное уведомление для email","TAG":"SYSTEM_EVENT_42","SUB_TAG":"SYSTEM_EVENT|42","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.notify.system.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 | false>({
    method: 'im.notify.system.add',
    params: {
      USER_ID: 5,
      MESSAGE: 'System notification',
      MESSAGE_OUT: 'System notification for email',
      TAG: 'SYSTEM_EVENT_42',
      SUB_TAG: 'SYSTEM_EVENT|42',
    },
    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('Notification 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 sendSystemNotification() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.notify.system.add',
        params: {
          USER_ID: 5,
          MESSAGE: 'System notification',
          MESSAGE_OUT: 'System notification for email',
          TAG: 'SYSTEM_EVENT_42',
          SUB_TAG: 'SYSTEM_EVENT|42',
        },
        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('Notification ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.im.notify.system.add(
        user_id=5,
        message="Системное уведомление",
        message_out="Системное уведомление для email",
        tag="SYSTEM_EVENT_42",
        sub_tag="SYSTEM_EVENT|42",
    ).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.notify.system.add',
        [
            'USER_ID' => 5,
            'MESSAGE' => 'Системное уведомление',
            'MESSAGE_OUT' => 'Системное уведомление для email',
            'TAG' => 'SYSTEM_EVENT_42',
            'SUB_TAG' => 'SYSTEM_EVENT|42',
        ]
    );

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

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Notification ID: ' . $result->data();
    }
} catch (Throwable $exception) {
    echo $exception->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'im.notify.system.add',
    {
        USER_ID: 5,
        MESSAGE: 'Системное уведомление',
        MESSAGE_OUT: 'Системное уведомление для email',
        TAG: 'SYSTEM_EVENT_42',
        SUB_TAG: 'SYSTEM_EVENT|42',
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'im.notify.system.add',
    [
        'USER_ID' => 5,
        'MESSAGE' => 'Системное уведомление',
        'MESSAGE_OUT' => 'Системное уведомление для email',
        'TAG' => 'SYSTEM_EVENT_42',
        'SUB_TAG' => 'SYSTEM_EVENT|42',
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    echo 'Notification ID: ' . $result['result'];
}
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.notify.system.add", b24.Params{
	"USER_ID":     5,
	"MESSAGE":     "Системное уведомление",
	"MESSAGE_OUT": "Системное уведомление для email",
	"TAG":         "SYSTEM_EVENT_42",
	"SUB_TAG":     "SYSTEM_EVENT|42",
})
if err != nil {
	return fmt.Errorf("im.notify.system.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/notifications/im-notify-system-add.html