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

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

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

Метод voximplant.user.deactivatePhone является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. This method disables an indicator of SIP-phone availability. Method checks the availability of the access permissions to modify users.

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

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

public function deactivatePhone(
      int $userId
  ): Result

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

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

<?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.user.deactivatePhone
    $userId = 123;

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

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

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

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

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