py-telegram-bot-client 6.1
A Telegram Bot API Python Client
Requires Python: >=3.5

# Telegram Bot API Client

A telegram bot API client is written in python 3.5+ and currently compatible with Telegram Bot API 5.3 and later.
The reason for writing this bot utility is that I wish to run multi telegram bots which could have same or different business logic **(route policy)** in one process.
I reckon it is lightweight, fast, full implement and only **urllib3** dependent.

## Update 6.1
Update for Telegram Bot API 6.1

## Update 6.0
Update for Telegram Bot API 6.0

## Update 5.7.0
Update for Telegram Bot API 5.7
Fix bugs

## Update 5.6.0
Update for Telegram Bot API 5.6
using loop.run_in_executor for synchronous functions

## Update 5.5.11
fix bugs

## Update 5.5.10
fix bugs

## Update 5.5.9
fix bugs

## Update 5.5.8
fix bugs

## Update 5.5.7
1. code optimization
2. fix bugs
3. add group method where methods for InlineKeyboard. more detail is in example.callback_query
4. change bot.get_file_bytes(file_path, chunk_size) into bot.get_file_bytes(file_obj)

## Update 5.5.6
add remove and where methods for InlineKeyboard. more detail is in example.callback_query

## Update 5.5.5
modify router.message_handler(fields) to router.message_handler(*fields)

## Update 5.5.4
1. code optimization
2. get_updates returns a iter

## Update 5.5.3
fix a bug for force reply

## Update 5.5.2
Remove TelegramRouter from TelegramBot.
Do a update dispatch as the update's coming.
Have a chance to use yourself route policy on incoming updates.

## Update 5.5.1
1. change cmds of CommandHandler into *cmds
2. change errors of ErrorHandler into *errors

## Update 5.5
Update for the telegram bot api 5.5.
Actually, I did nothing on codes. It is compatible with the telegram bot api 5.5.

## Update 5.4.2
1. change a list of regex patterns of regex_match into *args of regex patterns
2. add a example/regex_match.py for regex_match's usage

## Update  5.4.1
Fix bugs

## Update 5.4
Update for Telegram Bot API 5.4

## Update 5.3.7.5
1. HOT FIX remove "__del__()" from MongoDBStorage

## Update 5.3.7.4
1. check and add storage.__del__() for storages

## Update 5.3.7.3
1. rewrite force_reply. see detail in example.force_reply
2. rewrite callback_query. see detail in example.callback_query
3. add bot.clear_session method

## Update 5.3.7.2
 too silly to fix bugs right

## Update 5.3.7.1
 fix bugs

## Update 5.3.7
1. remove UIHelper
2. fix bugs

## Update 5.3.6.4
1. fix bugs

## Update 5.3.6.3
1. optimize codes

## Update 5.3.6.2
1. remove ui stack
2. fix bugs

## Update 5.3.6.1

1. add add_lines in ReplyKeyboard. see example/keyboard.py
2. fix bugs

## Update 5.3.6

1. update ReplyKeyboard in ui. see example/keyboard.py
2. update UIHelper in ui. see example/select.py

## Update 5.3.5.7

fix bugs and give the bot a get_file_bytes method to download a file. see example/document.py

## Update 5.3.5.6

optimize codes and remove setup_webhook

## Update 5.3.5.5

Fix bugs on ErrorHandler

## Update 5.3.5.4

1. compose keyboards see example/keyboard.py
2. fix bugs

## Update 5.3.5.3

Fix bugs

## Update 5.3.5.2

Fix bugs and add router.remove_handler. see example/dynamic_handler.py

## Update 5.3.5.1

1. Refacted and faster than before.

2. Provide a UIHelper in ui for buttons.

## Update 5.3.5

A large update. I do not write too many details because no one is using it except myself.

## Update 5.3.4

Add: add get_file_url function in bot

## Update 5.3.3

Fix bugs and update: support multi emojis for UI buttons

## Update 5.3.2

Fix bugs and update: add a UI stack for be back to ahead UI, see example.ui_stack.py

## Update 5.3.1

Change: delete multi keys in session using delete function

# Update 5.3

Add BotCommandScope Support

## Update 5.2.5.1

Fix bugs... correct get_file_bytes in TelegramBotAPI

## Update 5.2.5

Optimize: add a context manager on session implement

## Update 5.2.4.1

Fix bugs... correct TelegramBotAPIException

## Update 5.2.4

Optimize: make define your local API host easy, and your API host can use 'http://'

## Update 5.2.3

Optimize: make all bots call same one TelegramBotAPI instance

## Update 5.2.2

Add a confirm in ui

## Quick to go

This is a simple echo bot.


	from telegrambotclient import bot_client
	from telegrambotclient.base import MessageField, ParseMode

	# define a default router named "default"
	router = bot_client.router()

	# decorate a handler callback on incoming message updates that have a text field
	@router.message_handler(MessageField.TEXT)
	def on_text_message(bot, message):
	    # receive and reply
	    sent_message = bot.send_message(
		        chat_id=message.chat.id,
		        text="I receive: <strong>{0}</strong>".format(message.text),
		        parse_mode=ParseMode.HTML,
		    )
	    # pin the sent message
	    bot.pin_chat_message(chat_id=message.chat.id, message_id=sent_message.message_id)
	    return bot.stop_call

	# define a callback for incoming updates
	async def on_update(bot, update):
	    await router.dispatch(bot, update)

	# define a bot
	bot = bot_client.create_bot(token=<BOT_TOKEN>)
	# delete webhook if did or not
	bot.delete_webhook(drop_pending_updates=True)
	# run polling to fetch updates in every 10s
	bot.run_polling(on_update, timeout=10)


## Call telegram bot APIs

telegrambotclient has same parameter signatures with the official Telegram Bot APIs. Please see [official Telegram Bot API document](https://core.telegram.org/bots/api) when calling telegram bot APIs.

### Quick to reply

For send_message api, it provides a shortcut.

	sent_message = bot.reply_message(
	        message,
	        text="I receive: <strong>{0}</strong>".format(message.text),
	        parse_mode=ParseMode.HTML,
	    )
## Serving on webhook

In my case, I use [fastapi](https://fastapi.tiangolo.com/) and [uvicron](https://www.uvicorn.org/) to provide a HTTP interface to receive updates from the official Telegram Bot Server. For development and testing, [ngrok](https://ngrok.com/) give a HTTPs URL on my localhost server with a real-time HTTP traffic tunnel.


	# run in terminal and get a https tunnel on port 8000 in Austrlia
	ngrok http 8000 --region=au

source code:

  	from fastapi import FastAPI, Request, status
	from telegrambotclient import bot_client
  	from telegrambotclient.base import MessageField, ParseMode
    	# from ngrok's https url, replace it with yours
  	WEBHOOK_URL = "https://5f9d0f13b9fb.au.ngrok.io/bot/{0}"

	bot_token = "<BOT_TOKEN>"
    	# define a router
  	router = bot_client.router()
	@router.message_handler(MessageField.TEXT)
	def on_text_message(bot, message):
	    bot.reply_message(message, text="I receive: <strong>{0}</strong> from bot1".format(message.text), parse_mode=ParseMode.HTML)
	    return bot.stop_call

	app = FastAPI()

	# waiting for incoming updates and dispatch them
	@app.post("/bot/{bot_token}", status_code=status.HTTP_200_OK)
	async def process_telegram_update(bot_token: str, request: Request):
	    bot = bot_client.bots.get(bot_token, None)
	    if bot:
		await router.dispatch(bot, TelegramObject(**await request.json()))
	    return "OK"

	bot = bot_client.create_bot(token=bot_token)
	bot.setup_webhook(WEBHOOK_URL.format(bot_token))



## Serving with multi bots and routers on webhook

	from fastapi import FastAPI, Request, status
	from telegrambotclient import bot_client
	from telegrambotclient.base import Message, MessageField, ParseMode
	# from ngrok's https url, replace it with yours
	WEBHOOK_URL = "https://5f9d0f13b9fb.au.ngrok.io/bot/{0}"

	bot_token_1 = "<BOT_TOKEN_1>"
	bot_token_2 = "<BOT_TOKEN_2>"

    	# define 2 default routers
	router1 = bot_client.router(bot_token_1)
	router2 = bot_client.router(bot_token_2)

	# bind a handler on router1
	@router1.message_handler(MessageField.TEXT)
	def on_router1_message(bot, message):
	    bot.reply_message(
	        message,
	        text="I receive: <strong>{0}</strong> from router1".format(message.text),
	        parse_mode=ParseMode.HTML,
	    )

	# bind a handler on router2
	@router2.message_handler(MessageField.TEXT)
	def on_router2_message(bot, message):
	    bot.reply_message(
	        message,
	        text="I receive: <strong>{0}</strong> from router2".format(message.text),
	        parse_mode=ParseMode.HTML,
	    )

	app = FastAPI()

	# waiting for incoming updates and dispatch them
	@app.post("/bot/{bot_token}", status_code=status.HTTP_200_OK)
	async def serve_update(bot_token: str, request: Request):
	    bot = bot_client.bots.get(bot_token, None)
	    if bot:
		router = bot_client.routers.get(bot_token, None)
		if router:
	  	    await router.dispatch(bot, TelegramObject(**await request.json()))
	    return "OK"

	bot1 = bot_client.create_bot(token=bot_token_1)
	bot1.setup_webhook(WEBHOOK_URL.format(bot_token_1))

	bot2 = bot_client.create_bot(token=bot_token_2)
	bot2.setup_webhook(WEBHOOK_URL.format(bot_token_2))


##  Register handlers

### decorator
	@router.message_handler(MessageField.TEXT)
	def on_message(bot, message):
		pass

### function
a good way to register one callback on multi routers

	def on_message(bot, message):
	    pass

	router1.register_message_handler(on_message, MessageField.TEXT)
	router2.register_message_handler(on_message, MessageField.TEXT)

### serve for multi message fields

	# callback for a animation message that includes 'animation' AND 'document' fields
	@router.message_handler(MessageField.ANIMATION, MessageField.DOCUMENT)
	def on_animation(bot, message: Message):
	    pass

## [Please try examples for more detail](https://github.com/songdi/py-telegram-bot-client/tree/main/example)