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

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Как использовать метод SDK im.notify.read в Битрикс24». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

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

Метод im.notify.read является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. The method cancels notification for read messages.

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

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

public function markAsRead(
      int  $notificationId,
      bool $isOnlyCurrent = true
  ): Result

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

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

<?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.read
    $notificationId = 123;
    $isOnlyCurrent = true;

    // Выполнение запроса через Scope getIMScope и сервис notify
    $result = $serviceBuilder->getIMScope()->notify()->markAsRead(
          $notificationId,
          $isOnlyCurrent
      );

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

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

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

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