Отправить уведомление im.notify
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imКто может выполнять метод: любой пользователь
Метод im.notify отправляет уведомление пользователю.
Метод нельзя вызвать с сессионной авторизацией — он вернет ошибку WRONG_AUTH_TYPE. Вызывайте его через вебхук или с токеном приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
USER_ID* |
Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет Получить идентификатор пользователя можно методами user.get, user.search или im.user.get |
|
TYPE |
Тип уведомления. Допустимые значения:
Значение по умолчанию — |
|
MESSAGE* |
Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку Для |
|
MESSAGE_OUT |
Текст уведомления для внешних каналов, например, почты. Для |
|
TAG |
Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется. Тег сохраняется только при вызове из приложения: метод добавляет к нему ключ приложения, поэтому теги разных приложений не пересекаются. При вызове через вебхук параметр игнорируется |
|
SUB_TAG |
Дополнительный тег уведомления без проверки уникальности. По тегам Тег сохраняется только при вызове из приложения. При вызове через вебхук параметр игнорируется |
|
Вложение уведомления: массив блоков, объект с ключом |
Примеры кода
Как использовать примеры в документации
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
}
}
Возвращаемые данные
|
Название |
Описание |
|
Идентификатор созданного уведомления. Передайте его в Значение |
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "USER_ID_EMPTY",
"error_description": "User ID can't be empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access for this method not allowed by session authorization. |
Метод вызван с сессионной авторизацией, для которой он запрещен |
|
|
|
User ID can't be empty |
Параметр |
|
|
|
Message can't be empty |
Параметр |
|
|
|
You have exceeded the maximum allowable size of attach |
Размер вложения |
|
|
|
Incorrect attach params |
Во вложении |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Отправить персональное уведомление im.notify.personal.add
- Отправить системное уведомление im.notify.system.add
- Получить уведомления im.notify.get
- Получить схему типов уведомлений im.notify.schema.get
- Прочитать список уведомлений im.notify.read.list
- Прочитать или вернуть непрочитанным уведомление im.notify.read
- Прочитать все уведомления im.notify.read.all
- Ответить на уведомление с быстрым ответом im.notify.answer
- Взаимодействовать с кнопками уведомлений im.notify.confirm
- Удалить уведомление im.notify.delete
- Поиск по истории уведомлений im.notify.history.search