Как использовать метод SDK bizproc.activity.log в Битрикс24

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

Описание метода SDK bizproc.activity.log

Метод bizproc.activity.log является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. This method records data in the workflow log.

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

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

public function log(
      string $eventToken,
      string $message
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода bizproc.activity.log
    $eventToken = "пример_значения";
    $message = "пример_значения";

    // Выполнение запроса через Scope getBizProcScope и сервис activity
    $result = $serviceBuilder->getBizProcScope()->activity()->log(
          $eventToken,
          $message
      );

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

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

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

• Официальная REST API документация: https://training.bitrix24.com/rest_help/workflows/app_activities/bizproc_activity_list.php
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk