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

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK bizproc.activity.add в Битрикс24», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

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

Метод bizproc.activity.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Adds new activity to a workflow.

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

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

public function add(
      string                                $code,
      string                                $handlerUrl,
      int                                   $b24AuthUserId,
      array                                 $localizedName,
      array                                 $localizedDescription,
      bool                                  $isUseSubscription,
      array                                 $properties,
      bool                                  $isUsePlacement,
      array                                 $returnProperties,
      Workflows\Common\WorkflowDocumentType $documentType,
      array                                 $limitationFilter
  ): Result

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

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

<?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.add
    $code = "пример_значения";
    $handlerUrl = "пример_значения";
    $b24AuthUserId = 123;
    $localizedName = [];
    $localizedDescription = [];
    $isUseSubscription = true;
    $properties = [];
    $isUsePlacement = true;
    $returnProperties = [];
    $documentType = new \Workflows\Common\WorkflowDocumentType();
    $limitationFilter = [];

    // Выполнение запроса через Scope getBizProcScope и сервис activity
    $result = $serviceBuilder->getBizProcScope()->activity()->add(
          $code,
          $handlerUrl,
          $b24AuthUserId,
          $localizedName,
          $localizedDescription,
          $isUseSubscription,
          $properties,
          $isUsePlacement,
          $returnProperties,
          $documentType,
          $limitationFilter
      );

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

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

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

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