Telegram Bot API - PHP SDK

Telegram Bot PHP SDK 让您轻松地用 PHP 开发 Telegram 机器人！开箱即用，支持 Laravel。

Telegram Bot API 是一个基于 HTTP 的接口，专为希望为 Telegram 构建机器人的开发者设计。

如需了解更多关于 Telegram Bot API 的信息，请参阅官方 Telegram 网站上的 机器人简介 和 机器人常见问题解答。

要开始使用本 SDK 编写您的机器人，请参阅 文档。

支持的版本

我们仅支持最新发布的 SDK 版本。为了便于升级，我们很少进行不兼容的更改。

版本	支持情况	文档
2.x	❌	✅ 文档
3.x	✅（当前版本）	🚧 文档
4.x	✅（开发中）	❌

文档

SDK 的文档可以在 网站 上找到。

您是否正在使用 Telegram Bot SDK？

如果您正在使用此 SDK 构建 Telegram 机器人，或者有一个与此 SDK 相关的项目，我们非常乐意了解并将其分享给全世界。

请访问 Awesome Telegram Bots 来分享、发现和了解更多。

其他信息

如有任何问题、反馈、建议或疑问，请使用此处的 问题追踪器。

贡献

感谢您考虑为本项目做出贡献。在提交任何拉取请求之前，请先阅读 CONTRIBUTING 指南。

致谢

• Irfaq Syed
• 所有贡献者

感谢

感谢以下公司提供其产品，这些产品在开发本 SDK 时非常有帮助。请务必去看看它们！

免责声明

本项目及其作者与 Telegram 无任何关联或隶属关系。 更多详情请参阅 许可证。

许可证

本项目采用 BSD 3-Clause 许可证发布。

telegram-bot-sdk 快速上手指南

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 系统要求：Linux, macOS, Windows (需配置 PHP 环境)
• PHP 版本：建议 PHP 7.4 或更高版本（具体取决于 SDK 版本，当前稳定版为 3.x）
• 前置依赖：
  • Composer (PHP 依赖管理工具)
  • 一个已注册的 Telegram Bot Token (通过 @BotFather 获取)
  • (可选) Laravel 框架 (该 SDK 原生支持 Laravel)

注意：国内开发者若访问 Packagist 源较慢，可配置阿里云镜像加速：

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

安装步骤

使用 Composer 将 SDK 安装到你的项目中。目前推荐使用稳定的 3.x 版本。

在项目根目录下运行以下命令：

composer require irazasyed/telegram-bot-sdk:^3.0

如果你使用的是 Laravel 项目，安装完成后无需额外配置即可直接使用（SDK 会自动注册服务提供者）。

基本使用

以下是一个最基础的示例，展示如何初始化机器人并接收消息。

1. 初始化机器人

创建一个 PHP 文件（例如 bot.php），引入自动加载文件并实例化 Bot 类：

require 'vendor/autoload.php';

use Telegram\Bot\Api;

$telegram = new Api('YOUR_BOT_TOKEN');

// 获取更新信息 (轮询模式示例)
$updates = $telegram->getUpdates();

2. 处理消息

遍历获取到的更新信息，提取消息内容并做出响应：

foreach ($updates as $update) {
    $chatId = $update->getMessage()->getChat()->getId();
    $text = $update->getMessage()->getText();

    // 简单的回声回复
    $telegram->sendMessage([
        'chat_id' => $chatId,
        'text' => "你发送了: " . $text,
    ]);
}

3. 运行测试

在终端运行脚本：

php bot.php

向你的机器人发送任意消息，它将自动回复你发送的内容。

提示：生产环境建议使用 Webhook 模式而非轮询 (getUpdates)，具体配置请参考官方文档。