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

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

Описание метода SDK telephony.externalcall.show

Метод telephony.externalcall.show является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. The method displays a call ID screen to the user.

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

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

public function show(
      string $callId,
      array $b24UserId
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода telephony.externalcall.show
    $callId = "пример_значения";
    $b24UserId = [];

    // Выполнение запроса через Scope getTelephonyScope и сервис externalcall
    $result = $serviceBuilder->getTelephonyScope()->externalcall()->show(
          $callId,
          $b24UserId
      );

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

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

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

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