метод REST scope: im

im.notify

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

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

Описание

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

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

Параметры

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 необязательный

Вложение уведомления в формате объекта или JSON-строки. Подробнее смотрите в разделе Вложения

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

Идентификатор приложения. Параметр обязателен только при вызове через вебхук: передавайте его вместе с TAG и SUB_TAG

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

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

Ответ

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

Идентификатор созданного уведомления. Если уведомление не создано, может вернуться false

time time

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

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

HTTP-статус: 400

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

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

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