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

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

Описание метода SDK voximplant.sip.status

Метод voximplant.sip.status является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Returns the current status of the SIP registration (for cloud hosted PBX only).

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

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

public function status(
      int $sipRegistrationId
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода voximplant.sip.status
    $sipRegistrationId = 123;

    // Выполнение запроса через Scope getTelephonyScope и сервис sip
    $result = $serviceBuilder->getTelephonyScope()->sip()->status(
          $sipRegistrationId
      );

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

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

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

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