Как использовать метод SDK im.notify.personal.add в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK im.notify.personal.add в Битрикс24», проанализируем лучшие практики и покажем, как правильно использовать im.notify.personal.add в реальных задачах.

Описание метода SDK im.notify.personal.add

Метод im.notify.personal.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Sending personal notification

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\IM\Notify\Service\Notify со следующей сигнатурой:

public function fromPersonal(
      int     $userId,
      string  $message,
      ?string $forEmailChannelMessage = null,
      ?string $notificationTag = null,
      ?string $subTag = null,
      ?array  $attachment = null
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод fromPersonal:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода im.notify.personal.add
    $userId = 123;
    $message = "пример_значения";
    $forEmailChannelMessage = null;
    $notificationTag = null;
    $subTag = null;
    $attachment = null;

    // Выполнение запроса через Scope getIMScope и сервис notify
    $result = $serviceBuilder->getIMScope()->notify()->fromPersonal(
          $userId,
          $message,
          $forEmailChannelMessage,
          $notificationTag,
          $subTag,
          $attachment
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода im.notify.personal.add: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://training.bitrix24.com/support/training/course/index.php?COURSE_ID=115&LESSON_ID=23904&LESSON_PATH=9691.9805.11585.23904
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk