davtur19 / turibot
A simple way to communicate with Telegram APIs in PHP.
Installs: 10 035
Dependents: 0
Suggesters: 0
Security: 0
Stars: 120
Watchers: 8
Forks: 32
Open Issues: 0
Type:project
Requires
- php: ^8.1
- ext-json: *
- amphp/file: ^v3.0@dev
- amphp/http-client: ^v5.0@dev
- dev-master
- 2.12
- 2.11
- 2.10
- 2.9
- 2.8.1
- 2.8
- 2.7
- 2.6
- 2.5
- 2.4
- 2.3
- 2.2
- 2.1
- 2.0
- 1.30
- 1.29
- 1.28
- 1.27
- 1.26.1
- 1.26
- 1.25
- 1.24
- 1.23
- 1.22
- 1.21
- 1.20
- 1.19
- 1.18
- 1.17
- 1.16
- 1.15
- 1.14
- 1.13.2
- 1.13.1
- 1.13
- 1.12
- 1.11
- 1.10
- 1.9
- 1.8
- 1.7
- 1.6.1
- 1.6
- 1.5
- 1.4
- 1.3.2
- 1.3.0
- 1.2.0
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-async
This package is auto-updated.
Last update: 2024-11-14 14:41:22 UTC
README
TuriBot is a simple way to communicate with Telegram APIs in PHP
Requirements
Stable
PHP 8.0 or higher with curl extension
Beta (Async)
PHP 8.1 or higher, you need to install amp from composer
Installation
Stable
composer require davtur19/turibot 1.x
Beta (Async)
composer init --name=your.name/yourbot --no-interaction composer config minimum-stability dev composer require davtur19/turibot 2.x
Webhook
Setup recommended: open setupWebhook.php in your browser and follow the setup wizard.
Manual setup: set webhook to the file webhook.php, and as parameter GET "api" set your token.
Example for manual setup:
curl https://api.telegram.org/botTOKEN/setWebhook?url=https://WEBSITE/DIR/webhook.php?api=TOKEN
Alternatively if you don't want to use GET, just change this piece of code.
GetUpdates
Usage
- Look at the examples (webhook.php and getUpdates.php), it's very simple if you know PHP and OOP
- All methods have the parameters in the same order as the BotAPIs
- The
reply_markup,permissions,commands,entitiesand parameters that require arrays, already have a json_encode in the functions, you just need to pass arrays
Security
https://github.com/php-telegram-bot/core/wiki/Securing-&-Hardening-your-Telegram-Bot
Custom endpoint
With the Bot API 5.0 it is now possible to self host your own Bot API, here is an example of how to add your own endpoint
//token, json_payload, endpoint $client = new Client("1234:AAbbccdd", false, "http://endpoint/bot");
Json payload
Only works with webhooks, for more info: https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates
I do not recommend using it as it may need a particular configuration to the webserver for flushing and you cannot get a response from the Bot API
Generator
https://github.com/davtur19/TuriBotGen
Contributors
Old version
I don't recommend its use, but it could be useful for those unfamiliar with OOP and would like to start learning how PHP and Telegram Bot Api work.