muaath5/simple-bot-api

PHP中的简单易用的Telegram机器人API

v5.4 2021-12-10 10:34 UTC

This package is auto-updated.

Last update: 2024-09-17 18:41:32 UTC


README

Licence: GPL v3.0 Bot API Version: 5.6 PHP Unit Tests

这是一个简单的PHP Telegram机器人API库。此库应该支持所有版本更新的机器人API方法。我创建这个库是为了让创建机器人更加简单,今天以后不再需要一大堆类和对象了!

功能

  • 始终支持所有机器人API方法
  • 自动处理洪水和聊天ID迁移错误
  • 使用stdClass进行更新
  • 使用面向对象编程(OOP)
  • 每个机器人的可选设置可以保存为JSON
  • 基于cURL以提高速度
  • 通过composer下载
  • 通过GitHub Actions进行测试
  • 包含工作机器人的示例
  • 将Telegram错误作为PHP异常处理
  • 保持最新
  • 已记录

安装

安装指南

简单用法

创建机器人

use SimpleBotAPI/TelegramBot;
use SimpleBotAPI/BotSettings;

$Bot = new TelegramBot('bot_token');

更多文档这里

使用方法

它应该是这个格式

$Result = $Bot->{methodName}([
    '{paramName}' => {value1},
    '{paramName2}' => {value2}
]);

像这样

$Bot->SendMessage([
    'chat_id' => '@MuaathBots',
    'text' => 'This post was sent by the bot..'
]);

$my_channel_info = $Bot->getChat([
    'chat_id' => '@MuaathBots',
]);
echo "Your channel (@{$my_channel_info->username}) ID: {$my_channel_info->id}";

注意:如果methodName是大写或小写,没有问题。

贡献

您可以通过以下方式贡献

  • 报告错误。
  • 建议功能。
  • 改进代码风格。
  • 完成待办事项列表。
  • examples/添加更多示例。
  • docs/中记录未记录的主题。
  • 如果需要,更新库以适应下一个版本的机器人API。
  • test/文件夹中添加更多测试。

联系我

@Muaath_5 on Telegram muaath1428@hotmail.com

示例

目前,examples/文件夹中有三个示例

  • 回声机器人,它会发送与您发送的内容相同
  • 欢迎机器人,它会发送欢迎信息和加入群组的用户的ID
  • 联系我机器人,它是一个与您相同的机器人,您将收到消息并回复
  • FAQ机器人,它有一条消息和按钮,可以在问题之间切换,您可以看到答案。

您可以在这里看到一个完整的示例

所有这些示例都不需要任何数据库或文件存储,只需设置文件即可。

待办事项列表

  • 通过webhooks方法使用HTTP响应进行API调用
  • 为异常使用命名空间
  • 记录发送带有回复标记的消息
  • 添加webhook授权
  • 自动存储机器人用户
  • 添加JSON存储,机器人可以使用
  • 向所有机器人用户发布消息的方法
  • 添加日志记录
  • 添加DB存储,机器人可以使用
  • 记录遗漏的事项

许可证

Licence: GPL v3.0 GPL-3.0,在LICENCE文件中。