Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/borsaco/telegrambotapibundle
A symfony wrapper bundle for Telegram Bot API.
https://github.com/borsaco/telegrambotapibundle
symfony telegram telegram-bot
Last synced: 4 days ago
JSON representation
A symfony wrapper bundle for Telegram Bot API.
- Host: GitHub
- URL: https://github.com/borsaco/telegrambotapibundle
- Owner: borsaco
- License: bsd-3-clause
- Created: 2019-07-08T15:47:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-17T15:51:57.000Z (almost 3 years ago)
- Last Synced: 2024-12-11T17:39:48.760Z (12 days ago)
- Topics: symfony, telegram, telegram-bot
- Language: PHP
- Homepage:
- Size: 46.9 KB
- Stars: 56
- Watchers: 3
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TelegramBotApiBundle
===================
A symfony wrapper bundle for [Telegram Bot API](https://core.telegram.org/bots/api).
## Install
Via Composer
``` bash
composer require borsaco/telegram-bot-api-bundle
```
## Configure the bundle
This bundle was designed to just work out of the box. The only thing you have to configure in order to get this bundle up and running is your bot [token](https://core.telegram.org/bots#botfather).
```yaml
# config/packages/telegram.yaml
telegram_bot_api:
# Proxy (optional) :
#proxy: 'socks5h://127.0.0.1:5090' # this is example you have to change this
#async_requests: false
# Development section:
development:
# implement in next version
# Telegram user_id of developers accounts
developers_id: [1234567, 87654321]
# If this mode is enabled, the robot only responds to the developers
maintenance:
text: "The robot is being repaired! Please come back later."
# Bots:
bots:
# The bot name
first:
# Your bot token: (required)
token: 123456789:ABCD1234****4321CBA
maintenance: false
second:
# Your bot token: (required)
token: 123456789:ABCD1234****4321CBA
maintenance: false
# The default bot returned when you call getBot()
default: 'second'
```
## Usage
You can access the bot in the controller with :
```php
use Borsaco\TelegramBotApiBundle\Service\Bot;
...
public function index(Bot $bot)
{
$firstBot = $bot->getBot('first');
$firstBot->getMe();
}
```
## Webhook
In order to receive updates via a Webhook, You first need to tell your webhook URL to Telegram. You can use setWebhook method to specify a url and receive incoming updates via an outgoing webhook or use this commands:.
for get information about webhook of bot:
```bash
$ php bin/console telegram:bot:webhook:info
```
for set webhook url for the bot:
```bash
$ php bin/console telegram:bot:webhook:set
```
for delete webhook of the bot:
```bash
$ php bin/console telegram:bot:webhook:delete
```
Once you set the webhook using the setWebhook method, You can then use the below function to retrieve the updates that are sent to your Webhook URL. The function returns an array of Update objects.
```php
$updateArray = $firstBot()->getWebhookUpdate();
```
## Maintenance
If want to use maintenance of bots you can check `$bot->isMaintenance('bot_name')` in your entry point controller and send response message.
## Next...
Please refer to [Telegram Bot API Official Document](https://core.telegram.org/bots/api) for getting information about available methods and other informations.
## Troubleshooting
If you did all the configurations correctly but still getting errors (Http error 500) even on getMe() method, it might be because of SSL Verification. Please make sure you have up-to-date CA root certificate bundle to be used with cURL.
You can configure you CA root certificate bundle by:
1. Downloading up-to-date cacert.pem file from cURL website and
2. Setting a path to it in your php.ini file, e.g. on Windows:
`curl.cainfo=c:\php\cacert.pem`
You can test your SSL-setup online with this handy webtool on: [SSL Labs](https://www.ssllabs.com/ssltest)
## License
The BSD License. Please see [License File](LICENSE) for more information.