Отправить уведомление im.notify

Scope: im

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

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

Метод доступен только при вызове через приложение.

Параметры метода

Обязательные параметры отмечены *

Название `Тип`	Описание
USER_ID* `integer`	Идентификатор пользователя-получателя уведомления. Получить идентификатор пользователя можно методами user.get или user.search
TYPE `string`	Тип уведомления. Допустимые значения: `USER` — персональное уведомление `SYSTEM` — системное уведомление Значение по умолчанию — `USER`
MESSAGE* `string`	Текст уведомления. Метод удаляет пробелы по краям строки перед отправкой
MESSAGE_OUT `string`	Текст уведомления для внешних каналов, например, почты
TAG `string`	Уникальный тег уведомления в рамках приложения. При добавлении уведомления с существующим тегом другие уведомления будут удалены. Передавайте с `CLIENT_ID` при вызове через вебхук
SUB_TAG `string`	Дополнительный тег уведомления без проверки уникальности. Передавайте с `CLIENT_ID` при вызове через вебхук
ATTACH `object` `string`	Вложение уведомления в формате объекта или JSON-строки. Подробнее смотрите в разделе Вложения

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_ID":5,"TYPE":"USER","MESSAGE":"Напоминание","MESSAGE_OUT":"Напоминание (email)","TAG":"TASK_42","SUB_TAG":"TASK|42"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_ID":5,"TYPE":"SYSTEM","MESSAGE":"Системное сообщение","MESSAGE_OUT":"Системное сообщение (email)","TAG":"SYSTEM_42","SUB_TAG":"SYSTEM|42","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.notify

try {
          const response = await $b24.callMethod('im.notify', {
            USER_ID: 5,
            TYPE: 'USER',
            MESSAGE: 'Напоминание',
            MESSAGE_OUT: 'Напоминание (email)',
            TAG: 'TASK_42',
            SUB_TAG: 'TASK|42',
          });
        
          const { result } = response.getData();
          console.log('Notification ID:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service->core->call(
                'im.notify',
                [
                    'USER_ID' => 5,
                    'TYPE' => 'USER',
                    'MESSAGE' => 'Напоминание',
                    'MESSAGE_OUT' => 'Напоминание (email)',
                    'TAG' => 'TASK_42',
                    'SUB_TAG' => 'TASK|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.callMethod(
            'im.notify',
            {
                USER_ID: 5,
                TYPE: 'USER',
                MESSAGE: 'Напоминание',
                MESSAGE_OUT: 'Напоминание (email)',
                TAG: 'TASK_42',
                SUB_TAG: 'TASK|42',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.notify',
            [
                'USER_ID' => 5,
                'TYPE' => 'USER',
                'MESSAGE' => 'Напоминание',
                'MESSAGE_OUT' => 'Напоминание (email)',
                'TAG' => 'TASK_42',
                'SUB_TAG' => 'TASK|42',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Notification ID: ' . $result['result'];
        }

Обработка ответа

HTTP-код: 200

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

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

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

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

HTTP-статус: 400, 403

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`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` — 30 кб
`ATTACH_ERROR`	Incorrect attach params	Передан некорректный формат вложения `ATTACH`

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Отправить персональное уведомление

Отправить уведомление im.notify

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение