https://github.com/vjik/telegram-bot-api
PHP library to interact with Telegram Bot API
https://github.com/vjik/telegram-bot-api
telegam-bot-api telegram telegram-bot
Last synced: 3 months ago
JSON representation
PHP library to interact with Telegram Bot API
- Host: GitHub
- URL: https://github.com/vjik/telegram-bot-api
- Owner: vjik
- License: bsd-3-clause
- Created: 2024-05-29T19:49:46.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-23T14:55:03.000Z (3 months ago)
- Last Synced: 2025-03-24T09:51:38.648Z (3 months ago)
- Topics: telegam-bot-api, telegram, telegram-bot
- Language: PHP
- Homepage:
- Size: 1.08 MB
- Stars: 60
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Telegram Bot API for PHP
[](https://packagist.org/packages/vjik/telegram-bot-api)
[](https://packagist.org/packages/vjik/telegram-bot-api)
[](https://github.com/vjik/telegram-bot-api/actions/workflows/build.yml)
[](https://coveralls.io/github/vjik/telegram-bot-api)
[](https://dashboard.stryker-mutator.io/reports/github.com/vjik/telegram-bot-api/master)
[](https://github.com/vjik/telegram-bot-api/actions/workflows/static.yml?query=branch%3Amaster)
The package provides a simple and convenient way to interact with the Telegram Bot API.
✔️ Telegram Bot API 8.3 (February 12, 2025) is **fully supported**.
## Requirements
- PHP 8.2 or higher.
## Installation
The package can be installed with [Composer](https://getcomposer.org/download/):
```shell
composer require vjik/telegram-bot-api
```
## General usage
To make requests to the Telegram Bot API, you need to create an instance of the `TelegramBotApi` class.
```php
use Vjik\TelegramBot\Api\TelegramBotApi;
// API
$api = new TelegramBotApi(
// Telegram bot authentication token
'110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw',
);
```
Now you can use the `$api` instance to interact with the Telegram Bot API. Method names are the same as in
the [Telegram Bot API documentation](https://core.telegram.org/bots/api). For example:
```php
use Vjik\TelegramBot\Api\Type\InputFile
// Specify a URL for outgoing webhook
$api->setWebhook('https://example.com/webhook');
// Send text message
$api->sendMessage(
chatId: 22351,
text: 'Hello, world!',
);
// Send local photo
$api->sendPhoto(
chatId: 22351,
photo: InputFile::fromLocalFile('/path/to/photo.jpg'),
);
```
The result will be either a `FailResult` instance (occurring on an error) or an object of the corresponding type
(occurring on success). For example:
```php
// Result is an array of `Vjik\TelegramBot\Api\Update\Update` objects
$updates = $api->getUpdates();
```
## Documentation
### `TelegramBotApi`
`TelegramBotApi` constructor parameters:
- `$token` (required) — Telegram bot authentication token;
- `$baseUrl` — the base URL for Telegram Bot API requests (default `https://api.telegram.org`).
- `$transport` — the [transport](docs/transport.md) to make requests to Telegram Bot API (cURL will be used by default).
- `$logger` — the [PSR-3](https://www.php-fig.org/psr/psr-3/) compatible logger to log requests to Telegram Bot API and
response handling errors. See [logging](docs/logging.md) for more information.
Method names are the same as in the [Telegram Bot API documentation](https://core.telegram.org/bots/api).
### Files
#### File URL
Use `TelegramBotApi::makeFileUrl()` method to make a URL for downloading a file from the Telegram server. For example:
```php
/**
* @var \Vjik\TelegramBot\Api\TelegramBotApi $api
* @var \Vjik\TelegramBot\Api\Type\File $file
*/
// By `File` instance
$url = $api->makeFileUrl($file);
// By file path is taken from the Telegram response
$url = $api->makeFileUrl('photos/file_2');
```
#### File downloading
Use `TelegramBotApi::downloadFile()` and `TelegramBotApi::downloadFileTo()` methods to download a file from the Telegram
server. For example:
```php
/**
* @var \Vjik\TelegramBot\Api\TelegramBotApi $api
* @var \Vjik\TelegramBot\Api\Type\File $file
*/
// Get file content by `File` instance
$fileContent = $api->downloadFile($file);
// Get file content by file path
$fileContent = $api->downloadFile('photos/file_2');
// Download and save file by `File` instance
$fileContent = $api->downloadFileTo($file, '/local/path/to/file.jpg');
// Download and save file by file path
$fileContent = $api->downloadFileTo('photos/file_2', '/local/path/to/file.jpg');
```
### Guides
- [Transport](docs/transport.md)
- [Logging](docs/logging.md)
- [Webhook handling](docs/webhook-handling.md)
- [Custom requests](docs/custom-requests.md)
- [Internals](docs/internals.md)
If you have any questions or problems with this package, use [author telegram chat](https://t.me/predvoditelev_chat) for communication.
## License
The `vjik/telegram-bot-api` is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
## Credits
The package is inspired by [Botasis](https://github.com/botasis) code originally created
by [Viktor Babanov](https://github.com/viktorprogger).