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

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

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

Метод user.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Invites a user. Available only for users with invitation permissions, usually an administrator. Sends a standard account invitation to the user on success.

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

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

public function add(
      array $fields,
      string $messageText = ''
  ): 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 {
    // Подготовка параметров для вызова метода user.add
    $fields = [];
    $messageText = "пример_значения";

    // Выполнение запроса через Scope getUserScope и сервис user
    $result = $serviceBuilder->getUserScope()->user()->add(
          $fields,
          $messageText
      );

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

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

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

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