Как использовать метод SDK imopenlines.network.message.add в Битрикс24

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

Описание метода SDK imopenlines.network.message.add

Метод imopenlines.network.message.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Sending Open Channel message to selected user

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

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

public function messageAdd(
      string $openLineCode,
      int    $recipientUserId,
      string $message,
      bool   $isMakeUrlPreview = true,
      ?array $attach = null,
      ?array $keyboard = null
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода imopenlines.network.message.add
    $openLineCode = "пример_значения";
    $recipientUserId = 123;
    $message = "пример_значения";
    $isMakeUrlPreview = true;
    $attach = null;
    $keyboard = null;

    // Выполнение запроса через Scope getIMOpenLinesScope и сервис network
    $result = $serviceBuilder->getIMOpenLinesScope()->network()->messageAdd(
          $openLineCode,
          $recipientUserId,
          $message,
          $isMakeUrlPreview,
          $attach,
          $keyboard
      );

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

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

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

• Официальная REST API документация: https://training.bitrix24.com/support/training/course/?COURSE_ID=115&LESSON_ID=25018&LESSON_PATH=9691.9833.20331.25014.25018
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk