Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Отправить системное уведомление im.notify.system.add». Вы узнаете экспертные методики работы с im.notify.system.add и научитесь избегать типичных ошибок начинающих разработчиков.

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

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• отсутствуют примеры
• не прописаны ссылки на несозданные ещё страницы

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

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

Практические примеры использования в коде

• PHP

    $result = restCommand(
        'im.notify.system.add',
        Array(
            'USER_ID' => 1,
            'MESSAGE' => 'Системное уведомление',
            'MESSAGE_OUT' => 'Текст системного уведомления для почты',
            'TAG' => 'TEST',
            'SUB_TAG' => 'SUB|TEST',
            'ATTACH' => 'Array()'
        ),
        $_REQUEST[
            "auth"
        ]
    );

• PHP (B24PhpSdk)

    try {
        $result = $serviceBuilder->getIMScope()
            ->notify()
            ->fromSystem(
                123, // $userId
                'This is a test message.', // $message
                null, // $forEmailChannelMessage
                null, // $notificationTag
                null, // $subTag
                null // $attachment
            );

        print($result->getId());
    } catch (Throwable $e) {
        // Handle exception
        print('Error: ' . $e->getMessage());
    }

Ответ в случае успеха

{
    "result": 123
}

Результат выполнения: идентификатор уведомления ID или ошибка.

Ответ в случае ошибки

{
    "error": "USER_ID_EMPTY",
    "error_description": "Идентификатор получателя не задан"
}

Описание ключей

• error – код возникшей ошибки
• error_description – краткое описание возникшей ошибки

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

Ссылки по теме

• [](../messages/attachments/index)