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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: im

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

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

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

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

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

Название
тип

Описание

USER_ID*
integer

Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет result: false.

Получить идентификатор пользователя можно методами user.get, user.search или im.user.get

TYPE
string

Тип уведомления.

Допустимые значения:

  • USER — персональное уведомление от имени текущего пользователя, как в методе im.notify.personal.add
  • SYSTEM — системное уведомление без автора, как в методе im.notify.system.add

Значение по умолчанию — USER. Любое другое значение метод тоже заменяет на USER

MESSAGE*
string

Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку MESSAGE_EMPTY. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений.

Для TYPE: SYSTEM при вызове из приложения первой строкой текста метод добавляет название приложения

MESSAGE_OUT
string

Текст уведомления для внешних каналов, например, почты. Для TYPE: SYSTEM при вызове из приложения первой строкой текста метод добавляет название приложения

TAG
string

Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется.

Тег сохраняется только при вызове из приложения: метод добавляет к нему ключ приложения, поэтому теги разных приложений не пересекаются. При вызове через вебхук параметр игнорируется

SUB_TAG
string

Дополнительный тег уведомления без проверки уникальности. По тегам TAG и SUB_TAG уведомления можно удалить методом im.notify.delete.

Тег сохраняется только при вызове из приложения. При вызове через вебхук параметр игнорируется

ATTACH
array
object
string

Вложение уведомления: массив блоков, объект с ключом BLOCKS или JSON-строка. Размер вложения в JSON — меньше 60 000 символов. Формат блоков описан в разделе Вложения

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"USER_ID":5,"TYPE":"SYSTEM","MESSAGE":"Счет [B]№ 42[/B] оплачен","MESSAGE_OUT":"Счет № 42 оплачен","ATTACH":[{"MESSAGE":"Сумма: 15 000 руб."},{"LINK":{"NAME":"Открыть счет","LINK":"https://example.com/invoice/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":"Счет [B]№ 42[/B] оплачен","MESSAGE_OUT":"Счет № 42 оплачен","ATTACH":[{"MESSAGE":"Сумма: 15 000 руб."},{"LINK":{"NAME":"Открыть счет","LINK":"https://example.com/invoice/42"}}],"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.notify
// 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',
    params: {
      USER_ID: 5,
      TYPE: 'SYSTEM',
      MESSAGE: 'Счет [B]№ 42[/B] оплачен',
      MESSAGE_OUT: 'Счет № 42 оплачен',
      ATTACH: [
        { MESSAGE: 'Сумма: 15 000 руб.' },
        { LINK: { NAME: 'Открыть счет', LINK: 'https://example.com/invoice/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)
}
<!-- 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 sendNotification() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.notify',
        params: {
          USER_ID: 5,
          TYPE: 'SYSTEM',
          MESSAGE: 'Счет [B]№ 42[/B] оплачен',
          MESSAGE_OUT: 'Счет № 42 оплачен',
          ATTACH: [
            { MESSAGE: 'Сумма: 15 000 руб.' },
            { LINK: { NAME: 'Открыть счет', LINK: 'https://example.com/invoice/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', sendNotification)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.notify(
        user_id=5,
        type="SYSTEM",
        message="Счет [B]№ 42[/B] оплачен",
        message_out="Счет № 42 оплачен",
        attach=[
            {"MESSAGE": "Сумма: 15 000 руб."},
            {"LINK": {"NAME": "Открыть счет", "LINK": "https://example.com/invoice/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}")
try {
    $response = $b24Service->core->call(
        'im.notify',
        [
            'USER_ID' => 5,
            'TYPE' => 'SYSTEM',
            'MESSAGE' => 'Счет [B]№ 42[/B] оплачен',
            'MESSAGE_OUT' => 'Счет № 42 оплачен',
            'ATTACH' => [
                ['MESSAGE' => 'Сумма: 15 000 руб.'],
                ['LINK' => ['NAME' => 'Открыть счет', 'LINK' => 'https://example.com/invoice/42']],
            ],
        ]
    );

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

    print_r($result);
} catch (Throwable $exception) {
    echo $exception->getMessage();
}
BX24.callMethod(
    'im.notify',
    {
        USER_ID: 5,
        TYPE: 'SYSTEM',
        MESSAGE: 'Счет [B]№ 42[/B] оплачен',
        MESSAGE_OUT: 'Счет № 42 оплачен',
        ATTACH: [
            { MESSAGE: 'Сумма: 15 000 руб.' },
            { LINK: { NAME: 'Открыть счет', LINK: 'https://example.com/invoice/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' => 'SYSTEM',
        'MESSAGE' => 'Счет [B]№ 42[/B] оплачен',
        'MESSAGE_OUT' => 'Счет № 42 оплачен',
        'ATTACH' => [
            ['MESSAGE' => 'Сумма: 15 000 руб.'],
            ['LINK' => ['NAME' => 'Открыть счет', 'LINK' => 'https://example.com/invoice/42']],
        ],
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} elseif ($result['result'] === false) {
    echo 'Notification not sent';
} else {
    echo 'Notification ID: ' . $result['result'];
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.notify", b24.Params{
	"USER_ID":     5,
	"TYPE":        "SYSTEM",
	"MESSAGE":     "Счет [B]№ 42[/B] оплачен",
	"MESSAGE_OUT": "Счет № 42 оплачен",
	"ATTACH": []map[string]any{
		{"MESSAGE": "Сумма: 15 000 руб."},
		{"LINK": map[string]any{"NAME": "Открыть счет", "LINK": "https://example.com/invoice/42"}},
	},
})
if err != nil {
	return fmt.Errorf("im.notify: %w", err)
}

// result — идентификатор уведомления или false, если уведомление не создано
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("уведомление не создано: %s", res.Result)
}
fmt.Println("идентификатор:", newID)

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

HTTP-статус: 200

{
    "result": 44003,
    "time": {
        "start": 1794317396,
        "finish": 1794317396.101083,
        "duration": 0.10108304023742676,
        "processing": 0,
        "date_start": "2026-11-10T16:29:56+03:00",
        "date_finish": "2026-11-10T16:29:56+03:00",
        "operating_reset_at": 1794317940,
        "operating": 0
    }
}

Если получатель не найден или неактивен, метод возвращает HTTP-статус 200 и false:

{
    "result": false,
    "time": {
        "start": 1794317624,
        "finish": 1794317624.580945,
        "duration": 0.5809450149536133,
        "processing": 0,
        "date_start": "2026-11-10T16:33:44+03:00",
        "date_finish": "2026-11-10T16:33:44+03:00",
        "operating_reset_at": 1794318180,
        "operating": 0
    }
}

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

Название
тип

Описание

result
integer
boolean

Идентификатор созданного уведомления. Передайте его в ID метода im.notify.delete, чтобы удалить уведомление.

Значение false означает, что уведомление не создано: получатель не найден или неактивен

time
time

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

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

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

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

Название
тип

Описание

error
string

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

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Access for this method not allowed by session authorization.

Метод вызван с сессионной авторизацией, для которой он запрещен

400

USER_ID_EMPTY

User ID can't be empty

Параметр USER_ID не передан или его значение не больше 0

400

MESSAGE_EMPTY

Message can't be empty

Параметр MESSAGE не передан, не является строкой или содержит только пробелы

400

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

Размер вложения ATTACH в JSON — 60 000 символов или больше

400

ATTACH_ERROR

Incorrect attach params

Во вложении ATTACH нет ни одного корректного блока или передана строка, которая не является JSON

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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