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

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

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

Метод telephony.externalcall.finish является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. This method allows to retrieve information about a client from CRM by a telephone number via single request.

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

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

public function finishForUserPhoneInner(
      string                  $callId,
      string                  $userInnerPhoneNumber,
      int                     $duration,
      Money                   $money,
      TelephonyCallStatusCode $telephonyCallStatusCode,
      bool                    $isAddCallToChat = false,
      ?string                 $failedReason = null,
      ?int                    $userVote = null
  ): Result

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

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

<?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.finish
    $callId = "пример_значения";
    $userInnerPhoneNumber = "пример_значения";
    $duration = 123;
    $money = new \Bitrix24\SDK\Services\Telephony\ExternalCall\Service\Money();
    $telephonyCallStatusCode = new \Bitrix24\SDK\Services\Telephony\ExternalCall\Service\TelephonyCallStatusCode();
    $isAddCallToChat = true;
    $failedReason = null;
    $userVote = null;

    // Выполнение запроса через Scope getTelephonyScope и сервис externalcall
    $result = $serviceBuilder->getTelephonyScope()->externalcall()->finishForUserPhoneInner(
          $callId,
          $userInnerPhoneNumber,
          $duration,
          $money,
          $telephonyCallStatusCode,
          $isAddCallToChat,
          $failedReason,
          $userVote
      );

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

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

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

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