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

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

Описание метода SDK voximplant.infocall.startwithtext

Метод voximplant.infocall.startwithtext является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. method performs the call to the specified number with automatic voiceover of specified text

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

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

public function startWithText(
      string $lineId,
      string $toNumber,
      string $text,
      ?string $voiceCode = null
  ): Result

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

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

<?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.infocall.startwithtext
    $lineId = "пример_значения";
    $toNumber = "пример_значения";
    $text = "пример_значения";
    $voiceCode = null;

    // Выполнение запроса через Scope getTelephonyScope и сервис infocall
    $result = $serviceBuilder->getTelephonyScope()->infocall()->startWithText(
          $lineId,
          $toNumber,
          $text,
          $voiceCode
      );

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

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

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

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