otajonov/televel

一个高度可定制的Laravel库,用于管理Telegram机器人

1.1 2024-06-28 03:20 UTC

This package is auto-updated.

Last update: 2024-09-29 00:52:18 UTC


README

Laravel的Televel包

Laravel的Televel包

简介

Televel是一个为简化在Laravel应用程序中设置和管理Telegram机器人而设计的Laravel包。它提供命令来设置、管理和通过webhooks与Telegram机器人交互。

安装

要安装Televel,请按照以下步骤操作

  1. 通过Composer安装包

    composer require otajonov/televel

  2. 发布包配置和Provider文件

    php artisan vendor:publish --provider="Televel\TelevelServiceProvider" --tag="config"

这将发布配置文件到config/televel.php,您可以在其中配置您的Telegram机器人。

  1. 确保您的.env文件中的APP_URL设置正确,并且是https

  2. 运行php artisan televel:setup并提供您的Bot Token

  3. 恭喜。您的机器人应该已经运行了。/start它并享受编码!

命令

设置命令

设置命令(televel:setup)或(televel:setup botname)允许您在Laravel应用程序中配置一个新的Telegram机器人。它提示输入机器人名称和令牌,并设置必要的webhook URL以接收Telegram更新。

示例用法

php artisan televel:setup

列表命令

列表命令(televel:list)列出所有配置的Telegram机器人及其令牌和webhook URL。

示例用法

php artisan televel:list

删除命令

删除命令(televel:remove)从Laravel应用程序中删除配置的Telegram机器人。它删除webhook,删除配置条目,并删除相关文件。

示例用法

php artisan televel:remove

重置命令

重置命令(televel:reset)重置配置的Telegram机器人的webhook URL。它删除现有的webhook,使用新的令牌设置一个新的,并更新配置。

示例用法

php artisan televel:reset

用法

控制器

设置完成后,来自Telegram的传入更新将由您在app/Http/Controllers文件夹中新生成的YourBotController.php文件中的webhook方法处理。

扩展Televel类

您可以通过扩展Televel类并添加处理特定机器人功能的方法来进一步自定义您的Telegram机器人。

<?php

namespace App\Http\Televels;

use Televel\Bot\Televel; // Import Televel if needed

class EchoBotTelevel extends Televel
{
    /**
     * Example method to send a message using the bot.
     *
     * @param int $chatId The chat ID where the message should be sent.
     * @param string $message The message to send.
     * @return object Response from Telegram API.
     */
    public function sendMessage($chatId, $message)
    {
        // Implement your custom logic here to send messages via Telegram API
        // Example: return $this->post('sendMessage', ['chat_id' => $chatId, 'text' => $message]);
    }
}

许可证

此包是开源软件,许可协议为MIT。

如果您想为此项目做出贡献,请随时这么做。