Как использовать метод SDK tasks.flow.Flow.activate в Битрикс24

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

Описание метода SDK tasks.flow.Flow.activate

Метод tasks.flow.Flow.activate является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Enables or disables a flow.

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

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

public function activate(
      int $flowId
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода tasks.flow.Flow.activate
    $flowId = 123;

    // Выполнение запроса через Scope getTaskScope и сервис task
    $result = $serviceBuilder->getTaskScope()->task()->activate(
          $flowId
      );

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

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

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

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-activate.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk