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

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

Описание метода SDK telephony.externalCall.searchCrmEntities

Метод telephony.externalCall.searchCrmEntities является частью официального 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 searchCrmEntities(
      string $phoneNumber
  ): Result

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

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

<?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.searchCrmEntities
    $phoneNumber = "пример_значения";

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

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

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

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

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