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

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

Описание метода SDK bizproc.workflow.terminate

Метод bizproc.workflow.terminate является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Stops an active workflow.

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

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

public function terminate(
      string $workflowId,
      string $message
  ): Result

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

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

<?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.workflow.terminate
    $workflowId = "пример_значения";
    $message = "пример_значения";

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

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

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

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

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