Как использовать метод SDK crm.dealcategory.stage.list в Битрикс24

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Как использовать метод SDK crm.dealcategory.stage.list в Битрикс24». Вы узнаете экспертные методики работы с crm.dealcategory.stage.list и научитесь избегать типичных ошибок начинающих разработчиков.

Описание метода SDK crm.dealcategory.stage.list

Метод crm.dealcategory.stage.list является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Returns list of deal stages for category by the ID. Equivalent to calling crm.status.list method with parameter ENTITY_ID equal to the result of calling crm.dealcategory.status method.

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

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

public function list(
      int $categoryId
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода crm.dealcategory.stage.list
    $categoryId = 123;

    // Выполнение запроса через Scope getCRMScope и сервис deal
    $result = $serviceBuilder->getCRMScope()->deal()->list(
          $categoryId
      );

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

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

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

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