README

PHP SDK для отправки сообщений через Bot API Яндекс Мессенджера.

Требования

• PHP >= 8.0
• Composer

Установка

composer require rentceisy/yandex-messenger-bot-sdk

Быстрый старт

<?php

require 'vendor/autoload.php';

use Rentceisy\YandexMessengerBotSdk\YandexMessenger;

$bot = new YandexMessenger('YOUR_BOT_TOKEN');

// Отправка сообщения в групповой чат
$message = $bot->sendMessage([
    'chat_id' => '0/0/4f24b544-***************',
    'text'    => 'Привет, команда!',
]);

echo $message->message_id; // 1647523230504005

Метод sendMessage

Отправляет текстовое сообщение в групповой чат или личный диалог пользователю.

public function sendMessage(array $params): ?\Rentceisy\YandexMessengerBotSdk\Objects\Message

Параметры

* Параметры chat_id и login являются необязательными по отдельности, но необходимо указать хотя бы один из них.

Примеры

Отправка в групповой чат:

$message = $bot->sendMessage([
    'chat_id' => '0/0/4f24b544-***************',
    'text'    => 'Привет!',
]);

Отправка пользователю:

$message = $bot->sendMessage([
    'login' => 'ivan.ivanov',
    'text'  => 'Привет, Иван!',
]);

Ответ на сообщение:

$message = $bot->sendMessage([
    'chat_id'          => '0/0/4f24b544-***************',
    'text'             => 'Это ответ',
    'reply_message_id' => 1647523230504005,
]);

Важное сообщение без уведомления и без превью ссылок:

$message = $bot->sendMessage([
    'chat_id'                  => '0/0/4f24b544-***************',
    'text'                     => 'https://yandex.ru',
    'important'                => true,
    'disable_notification'     => true,
    'disable_web_page_preview' => true,
]);

Идемпотентная отправка (защита от дубликатов):

$message = $bot->sendMessage([
    'chat_id'    => '0/0/4f24b544-***************',
    'text'       => 'Привет!',
    'payload_id' => uniqid('msg_', true),
]);

Возвращаемое значение

При успешной отправке возвращает объект Message, содержащий:

$message = $bot->sendMessage([...]);

echo $message->ok;          // true
echo $message->message_id;  // 1647523230504005

Обработка ошибок

При ошибках API SDK выбрасывает исключения:

use Rentceisy\YandexMessengerBotSdk\Exceptions\YandexMessengerResponseException;
use Rentceisy\YandexMessengerBotSdk\Exceptions\YandexMessengerSDKException;

try {
    $message = $bot->sendMessage([
        'chat_id' => '0/0/invalid',
        'text'    => 'Привет!',
    ]);
} catch (YandexMessengerResponseException $e) {
    // Ошибка от API (например: "Bot is not a member of the chat")
    echo $e->getMessage();
    echo $e->getErrorCode();
} catch (YandexMessengerSDKException $e) {
    // Ошибка SDK или HTTP-клиента
    echo $e->getMessage();
}

Настройка HTTP-клиента

Таймауты

$bot->setTimeOut(30);        // Таймаут запроса (сек)
$bot->setConnectTimeOut(5);  // Таймаут соединения (сек)

Кастомный HTTP-клиент

SDK использует Guzzle по умолчанию, но вы можете подменить реализацию через интерфейс HttpClientInterface:

$bot->setHttpClientHandler($myCustomHttpClient);

Кастомный Base URL

$bot->setBaseBotUrl('https://custom-proxy.example.com/bot/v1');

Лицензия

MIT