Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radyakaze/phptelebot
Telegram bot framework written in PHP
https://github.com/radyakaze/phptelebot
bot-api inline-bots php telegram-bot telegram-bot-framework
Last synced: about 1 month ago
JSON representation
Telegram bot framework written in PHP
- Host: GitHub
- URL: https://github.com/radyakaze/phptelebot
- Owner: radyakaze
- License: gpl-3.0
- Created: 2016-11-11T13:18:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-11-19T13:22:03.000Z (almost 4 years ago)
- Last Synced: 2024-07-05T20:30:32.413Z (2 months ago)
- Topics: bot-api, inline-bots, php, telegram-bot, telegram-bot-framework
- Language: PHP
- Size: 32.2 KB
- Stars: 66
- Watchers: 11
- Forks: 64
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bot-telegram-indonesia - PHPTeleBot - - library Telegram untuk PHP (Library & Framework / Tutorial Made)
README
# PHPTelebot
Telegram bot framework written in PHP
## Features
* Simple, easy to use.
* Support Long Polling and Webhook.
## Requirements
- [cURL](http://php.net/manual/en/book.curl.php)
- PHP 5.4+
- Telegram Bot API Token - Talk to [@BotFather](https://telegram.me/@BotFather) and generate one.
## Installation
### Using [Composer](https://getcomposer.org)
To install PHPTelebot with Composer, just add the following to your `composer.json` file:
```json
{
"require": {
"radyakaze/phptelebot": "*"
}
}
```
or by running the following command:
```shell
composer require radyakaze/phptelebot
```
Composer installs autoloader at `./vendor/autoloader.php`. to include the library in your script, add:
```php
require_once 'vendor/autoload.php';
```
### Install from source
Download the PHP library from Github, then include `PHPTelebot.php` in your script:
```php
require_once '/path/to/phptelebot/src/PHPTelebot.php';
```
## Usage
### Creating a simple bot
```php
cmd('*', 'Hi, human! I am a bot.');
// Simple echo command
$bot->cmd('/echo|/say', function ($text) {
if ($text == '') {
$text = 'Command usage: /echo [text] or /say [text]';
}
return Bot::sendMessage($text);
});
// Simple whoami command
$bot->cmd('/whoami|!whoami', function () {
// Get message properties
$message = Bot::message();
$name = $message['from']['first_name'];
$userId = $message['from']['id'];
$text = 'You are '.$name.' and your ID is '.$userId.'';
$options = [
'parse_mode' => 'html',
'reply' => true
];
return Bot::sendMessage($text, $options);
});
$bot->run();
```
Then run
```shell
php file.php
```
You can also see my other [sample](https://github.com/radyakaze/phptelebot/blob/master/sample.php).
*NOTE:*
- If function parameters is more than one, PHPTelebot will split text by space.
- If you don't set chat_id on options bot will send message to current chat.
- If you add option **reply => true**, bot will reply current message (Only work if you don't set custom chat_id and reply_to_mesage_id).
## Commands
Use `$bot->cmd(, )` to handle command.
```php
// simple answer
$bot->cmd('*', 'I am a bot');
// catch multiple commands
$bot->cmd('/start|/help', function () {
// Do something here.
});
// call a function name
function googleSearch($search) {
// Do something here.
}
$bot->cmd('/google', 'googleSearch');
```
Use ***** to catch any command.
#### File upload
This code will send a photo to users when type command **/upload**.
```php
// Simple photo upload
$bot->cmd('/upload', function () {
$file = '/path/to/photo.png'; // File path, file id, or url.
return Bot::sendPhoto($file);
});
```
## Events
Use `$bot->on(, )` to handle all possible PHPTelebot events.
To handle inline message, just add:
```php
$bot->on('inline', function($text) {
$results[] = [
'type' => 'article',
'id' => 'unique_id1',
'title' => $text,
'message_text' => 'Lorem ipsum dolor sit amet',
];
$options = [
'cache_time' => 3600,
];
return Bot::answerInlineQuery($results, $options);
});
```
Also, you can catch multiple events:
```php
$bot->on('sticker|photo|document', function() {
// Do something here.
});
```
## Supported events:
- ***** - any type of message
- **text** – text message
- **audio** – audio file
- **voice** – voice message
- **document** – document file (any kind)
- **photo** – photo
- **sticker** – sticker
- **video** – video file
- **contact** – contact data
- **location** – location data
- **venue** – venue data
- **edited** – edited message
- **pinned_message** – message was pinned
- **new_chat_member** – new member was added
- **left_chat_member** – member was removed
- **new_chat_title** – new chat title
- **new_chat_photo** – new chat photo
- **delete_chat_photo** – chat photo was deleted
- **group_chat_created** – group has been created
- **channel_chat_created** – channel has been created
- **supergroup_chat_created** – supergroup has been created
- **migrate_to_chat_id** – group has been migrated to a supergroup
- **migrate_from_chat_id** – supergroup has been migrated from a group
- **inline** - inline message
- **callback** - callback message
- **game** - game
- **channel** - channel
- **edited_channel** - edited channel post
## Command with custom regex *(advanced)*
Create a command: */regex string number*
```php
$bot->regex('/^\/regex (.*) ([0-9])$/i', function($matches) {
// Do something here.
});
```
## Methods
### PHPTelebot Methods
##### `cmd(, )`
Handle a command.
##### `on(, )`
Handles events.
##### `regex(, )`
Create custom regex for command.
##### `Bot::type()`
Return [message event](#supported-events) type.
##### `Bot::message()`
Get [message properties](https://core.telegram.org/bots/api#message).
### Telegram Methods
PHPTelebot use standard [Telegram Bot API](https://core.telegram.org/bots/api#available-methods) method names.
##### `Bot::getMe()` [?](https://core.telegram.org/bots/api#getme)
A simple method for testing your bot's auth token.
##### `Bot::sendMessage(, )` [?](https://core.telegram.org/bots/api#sendmessage)
Use this method to send text messages.
##### `Bot::forwardMessage()` [?](https://core.telegram.org/bots/api#forwardmessage)
Use this method to forward messages of any kind.
##### `Bot::sendPhoto(, )` [?](https://core.telegram.org/bots/api#sendphoto)
Use this method to send a photo.
##### `Bot::sendVideo(, )` [?](https://core.telegram.org/bots/api#sendvideo)
Use this method to send a video.
##### `Bot::sendAudio(, )` [?](https://core.telegram.org/bots/api#sendaudio)
Use this method to send a audio.
##### `Bot::sendVoice(, )` [?](https://core.telegram.org/bots/api#sendvoice)
Use this method to send a voice message.
##### `Bot::sendDocument(, )` [?](https://core.telegram.org/bots/api#senddocument)
Use this method to send a document.
##### `Bot::sendSticker(, )` [?](https://core.telegram.org/bots/api#sendsticker)
Use this method to send a sticker.
##### `Bot::sendLocation()` [?](https://core.telegram.org/bots/api#sendlocation)
Use this method to send point on the map.
##### `Bot::sendVenue()` [?](https://core.telegram.org/bots/api#sendvenue)
Use this method to send information about a venue.
##### `Bot::sendContact()` [?](https://core.telegram.org/bots/api#sendcontact)
Use this method to send phone contacts.
##### `Bot::sendChatAction(, )` [?](https://core.telegram.org/bots/api#sendchataction)
Use this method when you need to tell the user that something is happening on the bot's side.
##### `Bot::getUserProfilePhotos(, )` [?](https://core.telegram.org/bots/api#getuserprofilephotos)
Use this method to get a list of profile pictures for a user.
##### `Bot::getFile()` [?](https://core.telegram.org/bots/api#getfile)
Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size.
##### `Bot::answerInlineQuery(, )` [?](https://core.telegram.org/bots/api#answerinlinequery)
Use this method to send answers to an inline query.
##### `Bot::answerCallbackQuery(, )` [?](https://core.telegram.org/bots/api#answercallbackquery)
Use this method to send answers to callback queries sent from inline keyboards.
##### `Bot::getChat()` [?](https://core.telegram.org/bots/api#getchat)
Use this method to get up to date information about the chat.
##### `Bot::leaveChat()` [?](https://core.telegram.org/bots/api#leavechat)
Use this method for your bot to leave a group, supergroup or channel.
##### `Bot::getChatAdministrators()` [?](https://core.telegram.org/bots/api#getchatadministrators)
Use this method to get a list of administrators in a chat.
##### `Bot::getChatMembersCount()` [?](https://core.telegram.org/bots/api#getchatmemberscount)
Use this method to get the number of members in a chat.
##### `Bot::getChatMember()` [?](https://core.telegram.org/bots/api#getchatmember)
Use this method to get information about a member of a chat.
##### `Bot::kickChatMember()` [?](https://core.telegram.org/bots/api#kickchatmember)
Use this method to kick a user from a group or a supergroup.
##### `Bot::unbanChatMember()` [?](https://core.telegram.org/bots/api#unbanchatmember)
Use this method to unban a previously kicked user in a supergroup.
##### `Bot::editMessageText()` [?](https://core.telegram.org/bots/api#editmessagetext)
Use this method to edit text messages sent by the bot or via the bot (for inline bots).
##### `Bot::editMessageCaption()` [?](https://core.telegram.org/bots/api#editmessagecaption)
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
##### `Bot::editMessageReplyMarkup()` [?](https://core.telegram.org/bots/api#editmessagereplymarkup)
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).
##### `Bot::sendGame(, )` [?](https://core.telegram.org/bots/api#sendgame)
Use this method to send a game.
##### `Bot::setGameScore()` [?](https://core.telegram.org/bots/api#setgamescore)
Use this method to set the score of the specified user in a game.
##### `Bot::getGameHighScores(, )` [?](https://core.telegram.org/bots/api#getgamehighscores)
Use this method to get data for high score tables.
## Webhook installation
Open via browser `https://api.telegram.org/bot/setWebhook?url=https://yourdomain.com/your_bot.php`