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

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

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

Метод bizproc.robot.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Registers new automation rule.

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

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

public function add(
      string $code,
      string $handlerUrl,
      int    $b24AuthUserId,
      array  $localizedRobotName,
      bool   $isUseSubscription,
      array  $properties,
      bool   $isUsePlacement,
      array  $returnProperties
  ): 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.robot.add
    $code = "пример_значения";
    $handlerUrl = "пример_значения";
    $b24AuthUserId = 123;
    $localizedRobotName = [];
    $isUseSubscription = true;
    $properties = [];
    $isUsePlacement = true;
    $returnProperties = [];

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

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

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

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

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