https://github.com/thevickypedia/telegram-webhook
Telegram bot implementation using webhook
https://github.com/thevickypedia/telegram-webhook
Last synced: 2 months ago
JSON representation
Telegram bot implementation using webhook
- Host: GitHub
- URL: https://github.com/thevickypedia/telegram-webhook
- Owner: thevickypedia
- License: mit
- Created: 2023-09-10T22:23:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-18T18:10:53.000Z (over 1 year ago)
- Last Synced: 2025-02-12T22:22:45.704Z (4 months ago)
- Language: Python
- Size: 2.02 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram API Webhook
**Telegram bot implementation using webhooks**
This is a POC (Proof Of Concept) for telegram bot automation using webhook integration.
Why webhooks?
| Polling | Webhooks |
|--------------------------------------------------------------------------------|-----------------------------------------------------------|
| Easy to implement | Considerably more complex to implement |
| Polling requests are made by the receiver of the data updates | Webhook requests are made by the source of the data |
| Polling is set up to run at fixed intervals and runs regardless of a new event | Webhooks are automatically triggered when an event occurs |
| System is constantly running to check for new events | System will be on idle until an event is triggered |
GIF credits: [LinkedIn](https://www.linkedin.com/posts/brijpandeyji_in-the-world-of-apis-there-are-two-main-activity-7094640904170295296-QSjr)
## Components
- fastapi
- uvicorn
- ngrok [or] equivalent
## Implementation
Setting up a telegram bot server using webhook
- Create a webhook using FastAPI
- Host the webhook on Ngrok or any other ReverseProxy
- Set the webhook on TelegramAPI
## Get Started
#### Environment Variables
- **BOT_TOKEN** - Telegram authentication token provided by @BotFather
- **NGROK_TOKEN** - Ngrok authentication token to initiate tunneling _(not required if using a
pre-configured **WEBHOOK**)_
**[Optionally]**
- **HOST** - Defaults to `localhost` (`127.0.0.1`)
- **PORT** - Defaults to `8443`
- **ENDPOINT** - Defaults to `/telegram-webhook`
- **WEBHOOK** - Pre-configured webhook
- **CERTIFICATE** - File path to the public certificate _(only required when using self-signed certs)_
> For more information visit https://core.telegram.org/bots/self-signed
- **SECRET_TOKEN** - Secret token sent in a header in every webhook request to ensure that the request comes from a
webhook set by the owner.
- **WEBHOOK_IP** - Fixed IP address to use instead of IP resolved through DNS (webhook) _especially useful when webhook
port forwarded_
- **DROP_PENDING_UPDATES** - Pass `True` to drop all pending updates.
- **MAX_CONNECTIONS** - Maximum number of allowed simultaneous HTTPS connections to the webhook.
- **ALLOWED_UPDATES** - JSON-serialized list of the update types allowed for the bot to receive.
- **DEBUG** - Boolean flag to enable debug level logging.
###### Sample request
If a secret token was set in env var, the header `X-Telegram-Bot-Api-Secret-Token` is required for two-factor
authentication.
> The following code snippet replicates `TelegramAPI` does.
```python
import os
from urllib.parse import urljoin
import requests
from models.config import settings
payload = {'message': {'text': 'hello-world', 'chat': {'id': os.environ.get('CHAT_ID')}}}
public = settings.certificate
private = 'private.pem'
bundle = 'ca_bundle.pem'
with open(public, 'rb') as public_file, open(private, 'rb') as private_file, open(bundle, 'wb') as output_file:
public_data = public_file.read()
private_data = private_file.read()
output_file.write(public_data + private_data)
response = requests.post(url=urljoin(str(settings.webhook), settings.endpoint),
json=payload, cert=(public, private), verify=bundle,
headers={"X-Telegram-Bot-Api-Secret-Token": settings.secret_token}, timeout=5)
print(response.status_code)
print(response.text)
```
#### References
- [Using self-signed certificates](https://core.telegram.org/bots/self-signed)
- [Making webhook requests](https://core.telegram.org/bots/api#making-requests)
- [Certificate as `inputFile` object](https://core.telegram.org/bots/api#inputfile)
- [Guide to webhooks](https://core.telegram.org/bots/webhooks)