https://github.com/xbot-my/telegram-sdk
PHP SDK for Telegram Bot API
https://github.com/xbot-my/telegram-sdk
laravel-package php-library telegram
Last synced: 5 months ago
JSON representation
PHP SDK for Telegram Bot API
- Host: GitHub
- URL: https://github.com/xbot-my/telegram-sdk
- Owner: xbot-my
- License: mit
- Created: 2025-08-28T07:48:08.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-01-02T10:11:41.000Z (6 months ago)
- Last Synced: 2026-01-20T23:20:33.528Z (5 months ago)
- Topics: laravel-package, php-library, telegram
- Language: PHP
- Homepage: http://telegram-sdk.xbot.my/
- Size: 15.4 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Telegram Bot PHP SDK
一个易于使用的 PHP Telegram Bot API SDK，提供高性能客户端、语义化端点和完善的异常处理机制，并支持 Laravel 集成。
---
## 特性
* 开箱即用
* 异常捕获
* 链式调用
* 响应转换
## 安装
```bash
composer require xbot-my/telegram-sdk
```
### Laravel
```bash
php artisan vendor:publish --provider="XBot\\Telegram\\Providers\\TelegramServiceProvider"
```
## 快速开始
```php
use XBot\\Telegram\\Bot;
$bot = Bot::token('YOUR_BOT_TOKEN');
$me = $bot->getMe()->toArray();
$msg = $bot->sendMessage(123456789, 'Hello')->toArray();
$bot->setWebhook('https://example.com/telegram/webhook');
```
## Webhook 与更新处理
* 在 `.env` 设置 `TELEGRAM_WEBHOOK_SECRET`，可选 `TELEGRAM_WEBHOOK_ROUTE_PREFIX`。
* ServiceProvider 注册默认路由与中间件，校验请求头 `X-Telegram-Bot-Api-Secret-Token`。
* 实现 `UpdateHandler` 或继承 `BaseUpdateHandler`：
```php
class StartHandler extends BaseUpdateHandler {
protected function onMessage(array $u): void {
if ($this->text($u) === '/start') $this->replyText($u, 'Welcome!');
}
}
```
* 命令路由可继承 `CommandRouter`，如 `/start` → `onStart`，`/help foo` → `onHelp`。
## 示例
```php
// WebApp
$bot->answerWebAppQuery($queryId, [...]);
// Boosts
$bot->getUserChatBoosts($chatId, $userId);
// Stars
$bot->refundStarPayment($userId, $chargeId);
// Business
$bot->readBusinessMessage($chatId, $messageId);
```
## Telegram Bot API 9.2 新参数
* `direct_messages_topic_id`：发送至频道话题
* `suggested_post_parameters`：建议帖子
* `reply_parameters.checklist_task_id`：回复清单任务
```php
$bot->sendMessage($chatId, 'Hello', ['direct_messages_topic_id' => 1234]);
```
## 日志
* 环境变量控制：
* `TELEGRAM_LOG_ENABLED`
* `TELEGRAM_LOG_SUPPRESS_INFO`
* `TELEGRAM_LOG_CHANNEL`
* 事件：`telegram.request`、`telegram.response`、`telegram.retry` 等