mirror/pyTelegramBotAPI
1
0
Fork 0
mirror of https://github.com/eternnoir/pyTelegramBotAPI.git synced 2023-08-10 21:12:57 +03:00
Code Releases Activity
ebfbfb2dfc
pyTelegramBotAPI/telebot/async_telebot.py

6185 lines
289 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# -*- coding: utf-8 -*-
from datetime import datetime
import logging
import re
import traceback
from typing import Any, Awaitable, Callable, List, Optional, Union
import sys
# this imports are used to avoid circular import error
import telebot.util
import telebot.types
# storages
from telebot.asyncio_storage import StateMemoryStorage, StatePickleStorage, StateStorageBase
from telebot.asyncio_handler_backends import BaseMiddleware, CancelUpdate, SkipHandler, State, ContinueHandling
from inspect import signature, iscoroutinefunction
from telebot import util, types, asyncio_helper
import asyncio
from telebot import asyncio_filters
logger = logging.getLogger('TeleBot')
REPLY_MARKUP_TYPES = Union[
types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup,
types.ReplyKeyboardRemove, types.ForceReply]
import string
import random
import ssl
"""
Module : telebot
"""
class Handler:
"""
Class for (next step|reply) handlers
"""
def __init__(self, callback, *args, **kwargs):
self.callback = callback
self.args = args
self.kwargs = kwargs
def __getitem__(self, item):
return getattr(self, item)
class ExceptionHandler:
"""
Class for handling exceptions while Polling
"""
# noinspection PyMethodMayBeStatic,PyUnusedLocal
def handle(self, exception):
return False
class AsyncTeleBot:
"""
This is the main asynchronous class for Bot.
It allows you to add handlers for different kind of updates.
Usage:
.. code-block:: python3
:caption: Using asynchronous implementation of TeleBot.
from telebot.async_telebot import AsyncTeleBot
bot = AsyncTeleBot('token') # get token from @BotFather
# now you can register other handlers/update listeners,
# and use bot methods.
# Remember to use async/await keywords when necessary.
See more examples in examples/ directory:
https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples
.. note::
Install coloredlogs module to specify colorful_logs=True
:param token: Token of a bot, obtained from @BotFather
:type token: :obj:`str`
:param parse_mode: Default parse mode, defaults to None
:type parse_mode: :obj:`str`, optional
:param offset: Offset used in get_updates, defaults to None
:type offset: :obj:`int`, optional
:param exception_handler: Exception handler, which will handle the exception occured, defaults to None
:type exception_handler: Optional[ExceptionHandler], optional
:param state_storage: Storage for states, defaults to StateMemoryStorage()
:type state_storage: :class:`telebot.asyncio_storage.StateMemoryStorage`, optional
:param disable_web_page_preview: Default value for disable_web_page_preview, defaults to None
:type disable_web_page_preview: :obj:`bool`, optional
:param disable_notification: Default value for disable_notification, defaults to None
:type disable_notification: :obj:`bool`, optional
:param protect_content: Default value for protect_content, defaults to None
:type protect_content: :obj:`bool`, optional
:param allow_sending_without_reply: Default value for allow_sending_without_reply, defaults to None
:type allow_sending_without_reply: :obj:`bool`, optional
:param colorful_logs: Outputs colorful logs
:type colorful_logs: :obj:`bool`, optional
"""
def __init__(self, token: str, parse_mode: Optional[str]=None, offset: Optional[int]=None,
exception_handler: Optional[ExceptionHandler]=None,
state_storage: Optional[StateStorageBase]=StateMemoryStorage(),
disable_web_page_preview: Optional[bool]=None,
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
allow_sending_without_reply: Optional[bool]=None,
colorful_logs: Optional[bool]=False) -> None:
# update-related
self.token = token
self.offset = offset
# logs-related
if colorful_logs:
try:
import coloredlogs
coloredlogs.install(logger=logger, level=logger.level)
except ImportError:
raise ImportError(
'Install coloredlogs module to use colorful_logs option.'
)
# properties
self.parse_mode = parse_mode
self.disable_web_page_preview = disable_web_page_preview
self.disable_notification = disable_notification
self.protect_content = protect_content
self.allow_sending_without_reply = allow_sending_without_reply
# states
self.current_states = state_storage
# handlers
self.update_listener = []
self.exception_handler = exception_handler
self.message_handlers = []
self.edited_message_handlers = []
self.channel_post_handlers = []
self.edited_channel_post_handlers = []
self.inline_handlers = []
self.chosen_inline_handlers = []
self.callback_query_handlers = []
self.shipping_query_handlers = []
self.pre_checkout_query_handlers = []
self.poll_handlers = []
self.poll_answer_handlers = []
self.my_chat_member_handlers = []
self.chat_member_handlers = []
self.chat_join_request_handlers = []
self.custom_filters = {}
self.state_handlers = []
self.middlewares = []
self._user = None # set during polling
@property
def user(self):
return self._user
async def close_session(self):
"""
Closes existing session of aiohttp.
Use this function if you stop polling/webhooks.
"""
await asyncio_helper.session_manager.session.close()
async def get_updates(self, offset: Optional[int]=None, limit: Optional[int]=None,
timeout: Optional[int]=20, allowed_updates: Optional[List]=None, request_timeout: Optional[int]=None) -> List[types.Update]:
"""
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
Telegram documentation: https://core.telegram.org/bots/api#getupdates
:param offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates.
By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset
higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue.
All previous updates will forgotten.
:type offset: :obj:`int`, optional
:param limit: Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
:type limit: :obj:`int`, optional
:param timeout: Request connection timeout
:type timeout: :obj:`int`, optional
:param allowed_updates: Array of string. List the types of updates you want your bot to receive.
:type allowed_updates: :obj:`list`, optional
:param request_timeout: Timeout in seconds for request.
:type request_timeout: :obj:`int`, optional
:return: An Array of Update objects is returned.
:rtype: :obj:`list` of :class:`telebot.types.Update`
"""
json_updates = await asyncio_helper.get_updates(self.token, offset, limit, timeout, allowed_updates, request_timeout)
return [types.Update.de_json(ju) for ju in json_updates]
def _setup_change_detector(self, path_to_watch: str) -> None:
try:
from watchdog.observers import Observer
from telebot.ext.reloader import EventHandler
except ImportError:
raise ImportError(
'Please install watchdog and psutil before using restart_on_change option.'
)
self.event_handler = EventHandler()
path = path_to_watch if path_to_watch else None
if path is None:
# Make it possible to specify --path argument to the script
path = sys.argv[sys.argv.index('--path') + 1] if '--path' in sys.argv else '.'
self.event_observer = Observer()
self.event_observer.schedule(self.event_handler, path, recursive=True)
self.event_observer.start()
async def polling(self, non_stop: bool=False, skip_pending=False, interval: int=0, timeout: int=20,
request_timeout: Optional[int]=None, allowed_updates: Optional[List[str]]=None,
none_stop: Optional[bool]=None, restart_on_change: Optional[bool]=False, path_to_watch: Optional[str]=None):
"""
Runs bot in long-polling mode in a main loop.
This allows the bot to retrieve Updates automagically and notify listeners and message handlers accordingly.
Warning: Do not call this function more than once!
Always gets updates.
.. note::
Set non_stop=True if you want your bot to continue receiving updates
if there is an error.
.. note::
Install watchdog and psutil before using restart_on_change option.
:param non_stop: Do not stop polling when an ApiException occurs.
:type non_stop: :obj:`bool`
:param skip_pending: skip old updates
:type skip_pending: :obj:`bool`
:param interval: Delay between two update retrivals
:type interval: :obj:`int`
:param timeout: Request connection timeout
:type timeout: :obj:`int`
:param request_timeout: Timeout in seconds for get_updates(Defaults to None)
:type request_timeout: :obj:`int`
:param allowed_updates: A list of the update types you want your bot to receive.
For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types.
See util.update_types for a complete list of available update types.
Specify an empty list to receive all update types except chat_member (default).
If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the get_updates,
so unwanted updates may be received for a short period of time.
:type allowed_updates: :obj:`list` of :obj:`str`
:param none_stop: Deprecated, use non_stop. Old typo, kept for backward compatibility.
:type none_stop: :obj:`bool`
:param restart_on_change: Restart a file on file(s) change. Defaults to False.
:type restart_on_change: :obj:`bool`
:param path_to_watch: Path to watch for changes. Defaults to current directory
:type path_to_watch: :obj:`str`
:return:
"""
if none_stop is not None:
logger.warning('The parameter "none_stop" is deprecated. Use "non_stop" instead.')
non_stop = none_stop
if skip_pending:
await self.skip_updates()
if restart_on_change:
self._setup_change_detector(path_to_watch)
await self._process_polling(non_stop, interval, timeout, request_timeout, allowed_updates)
async def infinity_polling(self, timeout: Optional[int]=20, skip_pending: Optional[bool]=False, request_timeout: Optional[int]=None,
logger_level: Optional[int]=logging.ERROR, allowed_updates: Optional[List[str]]=None,
restart_on_change: Optional[bool]=False, path_to_watch: Optional[str]=None, *args, **kwargs):
"""
Wrap polling with infinite loop and exception handling to avoid bot stops polling.
.. note::
Install watchdog and psutil before using restart_on_change option.
:param timeout: Timeout in seconds for get_updates(Defaults to None)
:type timeout: :obj:`int`
:param skip_pending: skip old updates
:type skip_pending: :obj:`bool`
:param request_timeout: Aiohttp's request timeout. Defaults to 5 minutes(aiohttp.ClientTimeout).
:type request_timeout: :obj:`int`
:param logger_level: Custom logging level for infinity_polling logging.
Use logger levels from logging as a value. None/NOTSET = no error logging
:type logger_level: :obj:`int`
:param allowed_updates: A list of the update types you want your bot to receive.
For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types.
See util.update_types for a complete list of available update types.
Specify an empty list to receive all update types except chat_member (default).
If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the get_updates,
so unwanted updates may be received for a short period of time.
:type allowed_updates: :obj:`list` of :obj:`str`
:param restart_on_change: Restart a file on file(s) change. Defaults to False
:type restart_on_change: :obj:`bool`
:param path_to_watch: Path to watch for changes. Defaults to current directory
:type path_to_watch: :obj:`str`
:return: None
"""
if skip_pending:
await self.skip_updates()
self._polling = True
if restart_on_change:
self._setup_change_detector(path_to_watch)
while self._polling:
try:
await self._process_polling(non_stop=True, timeout=timeout, request_timeout=request_timeout,
allowed_updates=allowed_updates, *args, **kwargs)
except Exception as e:
if logger_level and logger_level >= logging.ERROR:
logger.error("Infinity polling exception: %s", str(e))
if logger_level and logger_level >= logging.DEBUG:
logger.error("Exception traceback:\n%s", traceback.format_exc())
await asyncio.sleep(3)
continue
if logger_level and logger_level >= logging.INFO:
logger.error("Infinity polling: polling exited")
if logger_level and logger_level >= logging.INFO:
logger.error("Break infinity polling")
async def _process_polling(self, non_stop: bool=False, interval: int=0, timeout: int=20,
request_timeout: int=None, allowed_updates: Optional[List[str]]=None):
"""
Function to process polling.
:param non_stop: Do not stop polling when an ApiException occurs.
:param interval: Delay between two update retrivals
:param timeout: Request connection timeout
:param request_timeout: Timeout in seconds for long polling (see API docs)
:param allowed_updates: A list of the update types you want your bot to receive.
For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types.
See util.update_types for a complete list of available update types.
Specify an empty list to receive all update types except chat_member (default).
If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the get_updates,
so unwanted updates may be received for a short period of time.
:return:
"""
if not non_stop:
# show warning
logger.warning("Setting non_stop to False will stop polling on API and system exceptions.")
self._user = await self.get_me()
logger.info('Starting your bot with username: [@%s]', self.user.username)
self._polling = True
try:
while self._polling:
try:
updates = await self.get_updates(offset=self.offset, allowed_updates=allowed_updates, timeout=timeout, request_timeout=request_timeout)
if updates:
self.offset = updates[-1].update_id + 1
asyncio.create_task(self.process_new_updates(updates)) # Seperate task for processing updates
if interval: await asyncio.sleep(interval)
except KeyboardInterrupt:
return
except asyncio.CancelledError:
return
except asyncio_helper.RequestTimeout as e:
handled = False
if self.exception_handler:
self.exception_handler.handle(e)
handled = True
if not handled:
logger.error('Unhandled exception (full traceback for debug level): %s', str(e))
logger.debug(traceback.format_exc())
if non_stop or handled:
await asyncio.sleep(2)
continue
else:
return
except asyncio_helper.ApiException as e:
handled = False
if self.exception_handler:
self.exception_handler.handle(e)
handled = True
if not handled:
logger.error('Unhandled exception (full traceback for debug level): %s', str(e))
logger.debug(traceback.format_exc())
if non_stop or handled:
continue
else:
break
except Exception as e:
handled = False
if self.exception_handler:
self.exception_handler.handle(e)
handled = True
if not handled:
logger.error('Unhandled exception (full traceback for debug level): %s', str(e))
logger.debug(traceback.format_exc())
if non_stop or handled:
continue
else:
break
finally:
self._polling = False
await self.close_session()
logger.warning('Polling is stopped.')
@staticmethod
def _loop_create_task(coro):
return asyncio.create_task(coro)
async def _process_updates(self, handlers, messages, update_type):
"""
Process updates.
:param handlers:
:param messages:
:return:
"""
tasks = []
middlewares = await self._get_middlewares(update_type)
for message in messages:
tasks.append(self._run_middlewares_and_handlers(message, handlers, middlewares, update_type))
await asyncio.gather(*tasks)
async def _run_middlewares_and_handlers(self, message, handlers, middlewares, update_type):
"""
This method is made to run handlers and middlewares in queue.
:param message: received message (update part) to process with handlers and/or middlewares
:param handlers: all created handlers (not filtered)
:param middlewares: middlewares that should be executed (already filtered)
:param update_type: handler/update type (Update field name)
:return:
"""
handler_error = None
data = {}
skip_handlers = False
if middlewares:
for middleware in middlewares:
if middleware.update_sensitive:
if hasattr(middleware, f'pre_process_{update_type}'):
middleware_result = await getattr(middleware, f'pre_process_{update_type}')(message, data)
else:
logger.error('Middleware {} does not have pre_process_{} method. pre_process function execution was skipped.'.format(middleware.__class__.__name__, update_type))
middleware_result = None
else:
middleware_result = await middleware.pre_process(message, data)
if isinstance(middleware_result, CancelUpdate):
return
elif isinstance(middleware_result, SkipHandler):
await middleware.post_process(message, data, handler_error)
skip_handlers = True
if handlers and not(skip_handlers):
try:
for handler in handlers:
params = []
process_update = await self._test_message_handler(handler, message)
if not process_update: continue
for i in signature(handler['function']).parameters:
params.append(i)
if len(params) == 1:
result = await handler['function'](message)
elif "data" in params:
if len(params) == 2:
result = await handler['function'](message, data)
elif len(params) == 3:
result = await handler['function'](message, data=data, bot=self)
else:
logger.error("It is not allowed to pass data and values inside data to the handler. Check your handler: {}".format(handler['function']))
return
else:
data_copy = data.copy()
for key in list(data_copy):
# remove data from data_copy if handler does not accept it
if key not in params:
del data_copy[key]
if handler.get('pass_bot'):
data_copy["bot"] = self
if len(data_copy) > len(params) - 1: # remove the message parameter
logger.error("You are passing more data than the handler needs. Check your handler: {}".format(handler['function']))
return
result = await handler["function"](message, **data_copy)
if not isinstance(result, ContinueHandling):
break
except Exception as e:
handler_error = e
if self.exception_handler:
self.exception_handler.handle(e)
else:
logger.error(str(e))
logger.debug("Exception traceback:\n%s", traceback.format_exc())
if middlewares:
for middleware in middlewares:
if middleware.update_sensitive:
if hasattr(middleware, f'post_process_{update_type}'):
await getattr(middleware, f'post_process_{update_type}')(message, data, handler_error)
else:
logger.error('Middleware {} does not have post_process_{} method. post_process function execution was skipped.'.format(middleware.__class__.__name__, update_type))
else: await middleware.post_process(message, data, handler_error)
async def process_new_updates(self, updates: List[types.Update]):
"""
Process new updates.
Just pass list of updates - each update should be
instance of Update object.
:param updates: list of updates
:type updates: :obj:`list` of :obj:`telebot.types.Update`
:return: None
"""
upd_count = len(updates)
logger.info('Received {0} new updates'.format(upd_count))
if upd_count == 0: return
new_messages = None
new_edited_messages = None
new_channel_posts = None
new_edited_channel_posts = None
new_inline_queries = None
new_chosen_inline_results = None
new_callback_queries = None
new_shipping_queries = None
new_pre_checkout_queries = None
new_polls = None
new_poll_answers = None
new_my_chat_members = None
new_chat_members = None
chat_join_request = None
for update in updates:
logger.debug('Processing updates: {0}'.format(update))
if update.message:
if new_messages is None: new_messages = []
new_messages.append(update.message)
if update.edited_message:
if new_edited_messages is None: new_edited_messages = []
new_edited_messages.append(update.edited_message)
if update.channel_post:
if new_channel_posts is None: new_channel_posts = []
new_channel_posts.append(update.channel_post)
if update.edited_channel_post:
if new_edited_channel_posts is None: new_edited_channel_posts = []
new_edited_channel_posts.append(update.edited_channel_post)
if update.inline_query:
if new_inline_queries is None: new_inline_queries = []
new_inline_queries.append(update.inline_query)
if update.chosen_inline_result:
if new_chosen_inline_results is None: new_chosen_inline_results = []
new_chosen_inline_results.append(update.chosen_inline_result)
if update.callback_query:
if new_callback_queries is None: new_callback_queries = []
new_callback_queries.append(update.callback_query)
if update.shipping_query:
if new_shipping_queries is None: new_shipping_queries = []
new_shipping_queries.append(update.shipping_query)
if update.pre_checkout_query:
if new_pre_checkout_queries is None: new_pre_checkout_queries = []
new_pre_checkout_queries.append(update.pre_checkout_query)
if update.poll:
if new_polls is None: new_polls = []
new_polls.append(update.poll)
if update.poll_answer:
if new_poll_answers is None: new_poll_answers = []
new_poll_answers.append(update.poll_answer)
if update.my_chat_member:
if new_my_chat_members is None: new_my_chat_members = []
new_my_chat_members.append(update.my_chat_member)
if update.chat_member:
if new_chat_members is None: new_chat_members = []
new_chat_members.append(update.chat_member)
if update.chat_join_request:
if chat_join_request is None: chat_join_request = []
chat_join_request.append(update.chat_join_request)
if new_messages:
await self.process_new_messages(new_messages)
if new_edited_messages:
await self.process_new_edited_messages(new_edited_messages)
if new_channel_posts:
await self.process_new_channel_posts(new_channel_posts)
if new_edited_channel_posts:
await self.process_new_edited_channel_posts(new_edited_channel_posts)
if new_inline_queries:
await self.process_new_inline_query(new_inline_queries)
if new_chosen_inline_results:
await self.process_new_chosen_inline_query(new_chosen_inline_results)
if new_callback_queries:
await self.process_new_callback_query(new_callback_queries)
if new_shipping_queries:
await self.process_new_shipping_query(new_shipping_queries)
if new_pre_checkout_queries:
await self.process_new_pre_checkout_query(new_pre_checkout_queries)
if new_polls:
await self.process_new_poll(new_polls)
if new_poll_answers:
await self.process_new_poll_answer(new_poll_answers)
if new_my_chat_members:
await self.process_new_my_chat_member(new_my_chat_members)
if new_chat_members:
await self.process_new_chat_member(new_chat_members)
if chat_join_request:
await self.process_chat_join_request(chat_join_request)
async def process_new_messages(self, new_messages):
"""
:meta private:
"""
await self.__notify_update(new_messages)
await self._process_updates(self.message_handlers, new_messages, 'message')
async def process_new_edited_messages(self, edited_message):
"""
:meta private:
"""
await self._process_updates(self.edited_message_handlers, edited_message, 'edited_message')
async def process_new_channel_posts(self, channel_post):
"""
:meta private:
"""
await self._process_updates(self.channel_post_handlers, channel_post , 'channel_post')
async def process_new_edited_channel_posts(self, edited_channel_post):
"""
:meta private:
"""
await self._process_updates(self.edited_channel_post_handlers, edited_channel_post, 'edited_channel_post')
async def process_new_inline_query(self, new_inline_queries):
"""
:meta private:
"""
await self._process_updates(self.inline_handlers, new_inline_queries, 'inline_query')
async def process_new_chosen_inline_query(self, new_chosen_inline_queries):
"""
:meta private:
"""
await self._process_updates(self.chosen_inline_handlers, new_chosen_inline_queries, 'chosen_inline_query')
async def process_new_callback_query(self, new_callback_queries):
"""
:meta private:
"""
await self._process_updates(self.callback_query_handlers, new_callback_queries, 'callback_query')
async def process_new_shipping_query(self, new_shipping_queries):
"""
:meta private:
"""
await self._process_updates(self.shipping_query_handlers, new_shipping_queries, 'shipping_query')
async def process_new_pre_checkout_query(self, pre_checkout_queries):
"""
:meta private:
"""
await self._process_updates(self.pre_checkout_query_handlers, pre_checkout_queries, 'pre_checkout_query')
async def process_new_poll(self, polls):
"""
:meta private:
"""
await self._process_updates(self.poll_handlers, polls, 'poll')
async def process_new_poll_answer(self, poll_answers):
"""
:meta private:
"""
await self._process_updates(self.poll_answer_handlers, poll_answers, 'poll_answer')
async def process_new_my_chat_member(self, my_chat_members):
"""
:meta private:
"""
await self._process_updates(self.my_chat_member_handlers, my_chat_members, 'my_chat_member')
async def process_new_chat_member(self, chat_members):
"""
:meta private:
"""
await self._process_updates(self.chat_member_handlers, chat_members, 'chat_member')
async def process_chat_join_request(self, chat_join_request):
"""
:meta private:
"""
await self._process_updates(self.chat_join_request_handlers, chat_join_request, 'chat_join_request')
async def _get_middlewares(self, update_type):
"""
:meta private:
"""
if self.middlewares:
middlewares = [middleware for middleware in self.middlewares if update_type in middleware.update_types]
return middlewares
return None
async def __notify_update(self, new_messages):
if len(self.update_listener) == 0:
return
for listener in self.update_listener:
self._loop_create_task(listener(new_messages))
async def _test_message_handler(self, message_handler, message):
"""
Test message handler.
:param message_handler:
:param message:
:return:
"""
for message_filter, filter_value in message_handler['filters'].items():
if filter_value is None:
continue
if not await self._test_filter(message_filter, filter_value, message):
return False
return True
def set_update_listener(self, func: Awaitable):
"""
Update listener is a function that gets any update.
:param func: function that should get update.
:type func: :obj:`Awaitable`
.. code-block:: python3
:caption: Example on asynchronous update listeners.
async def update_listener(new_messages):
for message in new_messages:
print(message.text) # Prints message text
bot.set_update_listener(update_listener)
:return: None
"""
self.update_listener.append(func)
def add_custom_filter(self, custom_filter: Union[asyncio_filters.SimpleCustomFilter, asyncio_filters.AdvancedCustomFilter]):
"""
Create custom filter.
.. code-block:: python3
:caption: Example on checking the text of a message
class TextMatchFilter(AdvancedCustomFilter):
key = 'text'
async def check(self, message, text):
return text == message.text
:param custom_filter: Class with check(message) method.
:type custom_filter: :class:`telebot.asyncio_filters.SimpleCustomFilter` or :class:`telebot.asyncio_filters.AdvancedCustomFilter`
:return: None
"""
self.custom_filters[custom_filter.key] = custom_filter
async def _test_filter(self, message_filter, filter_value, message):
"""
Test filters.
:param message_filter: Filter type passed in handler
:param filter_value: Filter value passed in handler
:param message: Message to test
:return: True if filter conforms
"""
# test_cases = {
# 'content_types': lambda msg: msg.content_type in filter_value,
# 'regexp': lambda msg: msg.content_type == 'text' and re.search(filter_value, msg.text, re.IGNORECASE),
# 'commands': lambda msg: msg.content_type == 'text' and util.extract_command(msg.text) in filter_value,
# 'func': lambda msg: filter_value(msg)
# }
# return test_cases.get(message_filter, lambda msg: False)(message)
if message_filter == 'content_types':
return message.content_type in filter_value
elif message_filter == 'regexp':
return message.content_type == 'text' and re.search(filter_value, message.text, re.IGNORECASE)
elif message_filter == 'commands':
return message.content_type == 'text' and util.extract_command(message.text) in filter_value
elif message_filter == 'chat_types':
return message.chat.type in filter_value
elif message_filter == 'func':
if iscoroutinefunction(filter_value):
return await filter_value(message)
return filter_value(message)
elif self.custom_filters and message_filter in self.custom_filters:
return await self._check_filter(message_filter,filter_value,message)
else:
return False
async def _check_filter(self, message_filter, filter_value, message):
"""
Check up the filter.
:param message_filter:
:param filter_value:
:param message:
:return:
"""
filter_check = self.custom_filters.get(message_filter)
if not filter_check:
return False
elif isinstance(filter_check, asyncio_filters.SimpleCustomFilter):
return filter_value == await filter_check.check(message)
elif isinstance(filter_check, asyncio_filters.AdvancedCustomFilter):
return await filter_check.check(message, filter_value)
else:
logger.error("Custom filter: wrong type. Should be SimpleCustomFilter or AdvancedCustomFilter.")
return False
def setup_middleware(self, middleware: BaseMiddleware):
"""
Setup middleware.
.. note::
Take a look at the :class:`telebot.asyncio_handler_backends.BaseMiddleware` section for more.
:param middleware: Middleware-class.
:type middleware: :class:`telebot.asyncio_handler_backends.BaseMiddleware`
:return: None
"""
if not hasattr(middleware, 'update_types'):
logger.error('Middleware has no update_types parameter. Please add list of updates to handle.')
return
if not hasattr(middleware, 'update_sensitive'):
logger.warning('Middleware has no update_sensitive parameter. Parameter was set to False.')
middleware.update_sensitive = False
self.middlewares.append(middleware)
def message_handler(self, commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs):
"""
Handles ew incoming message of any kind - text, photo, sticker, etc.
As a parameter to the decorator function, it passes :class:`telebot.types.Message` object.
All message handlers are tested in the order they were added.
Example:
.. code-block:: python3
:caption: Usage of message_handler
bot = TeleBot('TOKEN')
# Handles all messages which text matches regexp.
@bot.message_handler(regexp='someregexp')
async def command_help(message):
await bot.send_message(message.chat.id, 'Did someone call for help?')
# Handles messages in private chat
@bot.message_handler(chat_types=['private']) # You can add more chat types
async def command_help(message):
await bot.send_message(message.chat.id, 'Private chat detected, sir!')
# Handle all sent documents of type 'text/plain'.
@bot.message_handler(func=lambda message: message.document.mime_type == 'text/plain',
content_types=['document'])
async def command_handle_document(message):
await bot.send_message(message.chat.id, 'Document received, sir!')
# Handle all other messages.
@bot.message_handler(func=lambda message: True, content_types=['audio', 'photo', 'voice', 'video', 'document',
'text', 'location', 'contact', 'sticker'])
async def default_command(message):
await bot.send_message(message.chat.id, "This is the default command handler.")
:param commands: Optional list of strings (commands to handle).
:type commands: :obj:`list` of :obj:`str`
:param regexp: Optional regular expression.
:type regexp: :obj:`str`
:param func: Optional lambda function. The lambda receives the message to test as the first parameter.
It must return True if the command should handle the message.
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param chat_types: list of chat types
:type chat_types: :obj:`list` of :obj:`str`
:param kwargs: Optional keyword arguments(custom filters)
:return: decorated function
"""
if content_types is None:
content_types = ["text"]
if isinstance(commands, str):
logger.warning("message_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("message_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
def decorator(handler):
handler_dict = self._build_handler_dict(handler,
chat_types=chat_types,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
**kwargs)
self.add_message_handler(handler_dict)
return handler
return decorator
def add_message_handler(self, handler_dict):
"""
Adds a message handler.
Note that you should use register_message_handler to add message_handler.
:meta private:
:param handler_dict:
:return:
"""
self.message_handlers.append(handler_dict)
def register_message_handler(self, callback: Callable[[Any], Awaitable], content_types: Optional[List[str]]=None, commands: Optional[List[str]]=None,
regexp: Optional[str]=None, func: Optional[Callable]=None, chat_types: Optional[List[str]]=None, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers message handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param commands: list of commands
:type commands: :obj:`list` of :obj:`str`
:param regexp:
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param chat_types: List of chat types
:type chat_types: :obj:`list` of :obj:`str`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
if content_types is None:
content_types = ["text"]
if isinstance(commands, str):
logger.warning("register_message_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("register_message_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
handler_dict = self._build_handler_dict(callback,
chat_types=chat_types,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
pass_bot=pass_bot,
**kwargs)
self.add_message_handler(handler_dict)
def edited_message_handler(self, commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs):
"""
Handles new version of a message that is known to the bot and was edited.
As a parameter to the decorator function, it passes :class:`telebot.types.Message` object.
:param commands: Optional list of strings (commands to handle).
:type commands: :obj:`list` of :obj:`str`
:param regexp: Optional regular expression.
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param chat_types: list of chat types
:type chat_types: :obj:`list` of :obj:`str`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
if content_types is None:
content_types = ["text"]
if isinstance(commands, str):
logger.warning("edited_message_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("edited_message_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
def decorator(handler):
handler_dict = self._build_handler_dict(handler,
chat_types=chat_types,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
**kwargs)
self.add_edited_message_handler(handler_dict)
return handler
return decorator
def add_edited_message_handler(self, handler_dict):
"""
Adds the edit message handler.
Note that you should use register_edited_message_handler to add edited_message_handler.
:meta private:
:param handler_dict:
:return:
"""
self.edited_message_handlers.append(handler_dict)
def register_edited_message_handler(self, callback: Callable[[Any], Awaitable], content_types: Optional[List[str]]=None,
commands: Optional[List[str]]=None, regexp: Optional[str]=None, func: Optional[Callable]=None,
chat_types: Optional[List[str]]=None, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers edited message handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param commands: list of commands
:type commands: :obj:`list` of :obj:`str`
:param regexp: Regular expression
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param chat_types: True for private chat
:type chat_types: :obj:`bool`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
if isinstance(commands, str):
logger.warning("register_edited_message_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("register_edited_message_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
handler_dict = self._build_handler_dict(callback,
chat_types=chat_types,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
pass_bot=pass_bot,
**kwargs)
self.add_edited_message_handler(handler_dict)
def channel_post_handler(self, commands=None, regexp=None, func=None, content_types=None, **kwargs):
"""
Handles new incoming channel post of any kind - text, photo, sticker, etc.
As a parameter to the decorator function, it passes :class:`telebot.types.Message` object.
:param commands: Optional list of strings (commands to handle).
:type commands: :obj:`list` of :obj:`str`
:param regexp: Optional regular expression.
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
if content_types is None:
content_types = ["text"]
if isinstance(commands, str):
logger.warning("channel_post_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("channel_post_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
def decorator(handler):
handler_dict = self._build_handler_dict(handler,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
**kwargs)
self.add_channel_post_handler(handler_dict)
return handler
return decorator
def add_channel_post_handler(self, handler_dict):
"""
Adds channel post handler.
Note that you should use register_channel_post_handler to add channel_post_handler.
:meta private:
:param handler_dict:
:return:
"""
self.channel_post_handlers.append(handler_dict)
def register_channel_post_handler(self, callback: Callable[[Any], Awaitable], content_types: Optional[List[str]]=None, commands: Optional[List[str]]=None,
regexp: Optional[str]=None, func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers channel post message handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param commands: list of commands
:type commands: :obj:`list` of :obj:`str`
:param regexp: Regular expression
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
if isinstance(commands, str):
logger.warning("register_channel_post_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("register_channel_post_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
handler_dict = self._build_handler_dict(callback,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
pass_bot=pass_bot,
**kwargs)
self.add_channel_post_handler(handler_dict)
def edited_channel_post_handler(self, commands=None, regexp=None, func=None, content_types=None, **kwargs):
"""
Handles new version of a channel post that is known to the bot and was edited.
As a parameter to the decorator function, it passes :class:`telebot.types.Message` object.
:param commands: Optional list of strings (commands to handle).
:type commands: :obj:`list` of :obj:`str`
:param regexp: Optional regular expression.
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param kwargs: Optional keyword arguments(custom filters)
:return:
"""
if content_types is None:
content_types = ["text"]
if isinstance(commands, str):
logger.warning("edited_channel_post_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("edited_channel_post_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
def decorator(handler):
handler_dict = self._build_handler_dict(handler,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
**kwargs)
self.add_edited_channel_post_handler(handler_dict)
return handler
return decorator
def add_edited_channel_post_handler(self, handler_dict):
"""
Adds the edit channel post handler.
Note that you should use register_edited_channel_post_handler to add edited_channel_post_handler.
:meta private:
:param handler_dict:
:return:
"""
self.edited_channel_post_handlers.append(handler_dict)
def register_edited_channel_post_handler(self, callback: Callable[[Any], Awaitable], content_types: Optional[List[str]]=None,
commands: Optional[List[str]]=None, regexp: Optional[str]=None, func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers edited channel post message handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param content_types: Supported message content types. Must be a list. Defaults to ['text'].
:type content_types: :obj:`list` of :obj:`str`
:param commands: list of commands
:type commands: :obj:`list` of :obj:`str`
:param regexp: Regular expression
:type regexp: :obj:`str`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: decorated function
"""
if isinstance(commands, str):
logger.warning("register_edited_channel_post_handler: 'commands' filter should be List of strings (commands), not string.")
commands = [commands]
if isinstance(content_types, str):
logger.warning("register_edited_channel_post_handler: 'content_types' filter should be List of strings (content types), not string.")
content_types = [content_types]
handler_dict = self._build_handler_dict(callback,
content_types=content_types,
commands=commands,
regexp=regexp,
func=func,
pass_bot=pass_bot,
**kwargs)
self.add_edited_channel_post_handler(handler_dict)
def inline_handler(self, func, **kwargs):
"""
Handles new incoming inline query.
As a parameter to the decorator function, it passes :class:`telebot.types.InlineQuery` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_inline_handler(handler_dict)
return handler
return decorator
def add_inline_handler(self, handler_dict):
"""
Adds inline call handler.
Note that you should use register_inline_handler to add inline_handler.
:meta private:
:param handler_dict:
:return:
"""
self.inline_handlers.append(handler_dict)
def register_inline_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers inline handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: decorated function
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_inline_handler(handler_dict)
def chosen_inline_handler(self, func, **kwargs):
"""
The result of an inline query that was chosen by a user and sent to their chat partner.
Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
As a parameter to the decorator function, it passes :class:`telebot.types.ChosenInlineResult` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_chosen_inline_handler(handler_dict)
return handler
return decorator
def add_chosen_inline_handler(self, handler_dict):
"""
Description: TBD
Note that you should use register_chosen_inline_handler to add chosen_inline_handler.
:meta private:
:param handler_dict:
:return:
"""
self.chosen_inline_handlers.append(handler_dict)
def register_chosen_inline_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers chosen inline handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_chosen_inline_handler(handler_dict)
def callback_query_handler(self, func, **kwargs):
"""
Handles new incoming callback query.
As a parameter to the decorator function, it passes :class:`telebot.types.CallbackQuery` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_callback_query_handler(handler_dict)
return handler
return decorator
def add_callback_query_handler(self, handler_dict):
"""
Adds a callback request handler.
Note that you should use register_callback_query_handler to add callback_query_handler.
:meta private:
:param handler_dict:
:return:
"""
self.callback_query_handlers.append(handler_dict)
def register_callback_query_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers callback query handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_callback_query_handler(handler_dict)
def shipping_query_handler(self, func, **kwargs):
"""
Handles new incoming shipping query. Only for invoices with flexible price.
As a parameter to the decorator function, it passes :class:`telebot.types.ShippingQuery` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_shipping_query_handler(handler_dict)
return handler
return decorator
def add_shipping_query_handler(self, handler_dict):
"""
Adds a shipping request handler.
Note that you should use register_shipping_query_handler to add shipping_query_handler.
:meta private:
:param handler_dict:
:return:
"""
self.shipping_query_handlers.append(handler_dict)
def register_shipping_query_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers shipping query handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_shipping_query_handler(handler_dict)
def pre_checkout_query_handler(self, func, **kwargs):
"""
New incoming pre-checkout query. Contains full information about checkout.
As a parameter to the decorator function, it passes :class:`telebot.types.PreCheckoutQuery` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_pre_checkout_query_handler(handler_dict)
return handler
return decorator
def add_pre_checkout_query_handler(self, handler_dict):
"""
Adds a pre-checkout request handler.
Note that you should use register_pre_checkout_query_handler to add pre_checkout_query_handler.
:meta private:
:param handler_dict:
:return:
"""
self.pre_checkout_query_handlers.append(handler_dict)
def register_pre_checkout_query_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers pre-checkout request handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: decorated function
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_pre_checkout_query_handler(handler_dict)
def poll_handler(self, func, **kwargs):
"""
Handles new state of a poll. Bots receive only updates about stopped polls and polls, which are sent by the bot
As a parameter to the decorator function, it passes :class:`telebot.types.Poll` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_poll_handler(handler_dict)
return handler
return decorator
def add_poll_handler(self, handler_dict):
"""
Adds a poll request handler.
Note that you should use register_poll_handler to add poll_handler.
:meta private:
:param handler_dict:
:return:
"""
self.poll_handlers.append(handler_dict)
def register_poll_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers poll handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_poll_handler(handler_dict)
def poll_answer_handler(self, func=None, **kwargs):
"""
Handles change of user's answer in a non-anonymous poll(when user changes the vote).
Bots receive new votes only in polls that were sent by the bot itself.
As a parameter to the decorator function, it passes :class:`telebot.types.PollAnswer` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_poll_answer_handler(handler_dict)
return handler
return decorator
def add_poll_answer_handler(self, handler_dict):
"""
Adds a poll_answer request handler.
Note that you should use register_poll_answer_handler to add poll_answer_handler.
:meta private:
:param handler_dict:
:return:
"""
self.poll_answer_handlers.append(handler_dict)
def register_poll_answer_handler(self, callback: Callable[[Any], Awaitable], func: Callable, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers poll answer handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_poll_answer_handler(handler_dict)
def my_chat_member_handler(self, func=None, **kwargs):
"""
Handles update in a status of a bot. For private chats,
this update is received only when the bot is blocked or unblocked by the user.
As a parameter to the decorator function, it passes :class:`telebot.types.ChatMemberUpdated` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_my_chat_member_handler(handler_dict)
return handler
return decorator
def add_my_chat_member_handler(self, handler_dict):
"""
Adds a my_chat_member handler.
Note that you should use register_my_chat_member_handler to add my_chat_member_handler.
:meta private:
:param handler_dict:
:return:
"""
self.my_chat_member_handlers.append(handler_dict)
def register_my_chat_member_handler(self, callback: Callable[[Any], Awaitable], func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers my chat member handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_my_chat_member_handler(handler_dict)
def chat_member_handler(self, func=None, **kwargs):
"""
Handles update in a status of a user in a chat.
The bot must be an administrator in the chat and must explicitly specify “chat_member”
in the list of allowed_updates to receive these updates.
As a parameter to the decorator function, it passes :class:`telebot.types.ChatMemberUpdated` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_chat_member_handler(handler_dict)
return handler
return decorator
def add_chat_member_handler(self, handler_dict):
"""
Adds a chat_member handler.
Note that you should use register_chat_member_handler to add chat_member_handler.
:meta private:
:param handler_dict:
:return:
"""
self.chat_member_handlers.append(handler_dict)
def register_chat_member_handler(self, callback: Callable[[Any], Awaitable], func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs):
"""
Registers chat member handler.
:param callback: function to be called
:type callback: :obj:`Awaitable``
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return:None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_chat_member_handler(handler_dict)
def chat_join_request_handler(self, func=None, **kwargs):
"""
Handles a request to join the chat has been sent. The bot must have the can_invite_users
administrator right in the chat to receive these updates.
As a parameter to the decorator function, it passes :class:`telebot.types.ChatJoinRequest` object.
:param func: Function executed as a filter
:type func: :obj:`function`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
def decorator(handler):
handler_dict = self._build_handler_dict(handler, func=func, **kwargs)
self.add_chat_join_request_handler(handler_dict)
return handler
return decorator
def add_chat_join_request_handler(self, handler_dict):
"""
Adds a chat_join_request handler.
Note that you should use register_chat_join_request_handler to add chat_join_request_handler.
:meta private:
:param handler_dict:
:return:
"""
self.chat_join_request_handlers.append(handler_dict)
def register_chat_join_request_handler(self, callback: Callable[[Any], Awaitable], func: Optional[Callable]=None, pass_bot:Optional[bool]=False, **kwargs):
"""
Registers chat join request handler.
:param callback: function to be called
:type callback: :obj:`Awaitable`
:param func: Function executed as a filter
:type func: :obj:`function`
:param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
:type pass_bot: :obj:`bool`
:param kwargs: Optional keyword arguments(custom filters)
:return: None
"""
handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs)
self.add_chat_join_request_handler(handler_dict)
@staticmethod
def _build_handler_dict(handler, pass_bot=False, **filters):
"""
Builds a dictionary for a handler.
:param handler:
:param filters:
:return:
"""
return {
'function': handler,
'pass_bot': pass_bot,
'filters': {ftype: fvalue for ftype, fvalue in filters.items() if fvalue is not None}
# Remove None values, they are skipped in _test_filter anyway
#'filters': filters
}
async def skip_updates(self):
"""
Skip existing updates.
Only last update will remain on server.
"""
await self.get_updates(-1)
return True
# all methods begin here
async def get_me(self) -> types.User:
"""
Returns basic information about the bot in form of a User object.
Telegram documentation: https://core.telegram.org/bots/api#getme
"""
result = await asyncio_helper.get_me(self.token)
return types.User.de_json(result)
async def get_file(self, file_id: Optional[str]) -> types.File:
"""
Use this method to get basic info about a file and prepare it for downloading.
For the moment, bots can download files of up to 20MB in size.
On success, a File object is returned.
It is guaranteed that the link will be valid for at least 1 hour.
When the link expires, a new one can be requested by calling get_file again.
Telegram documentation: https://core.telegram.org/bots/api#getfile
:param file_id: File identifier
:type file_id: :obj:`str`
:return: :class:`telebot.types.File`
"""
return types.File.de_json(await asyncio_helper.get_file(self.token, file_id))
async def get_file_url(self, file_id: Optional[str]) -> str:
"""
Get a valid URL for downloading a file.
:param file_id: File identifier to get download URL for.
:type file_id: :obj:`str`
:return: URL for downloading the file.
:rtype: :obj:`str`
"""
return await asyncio_helper.get_file_url(self.token, file_id)
async def download_file(self, file_path: Optional[str]) -> bytes:
"""
Downloads file.
:param file_path: Path where the file should be downloaded.
:type file_path: str
:return: bytes
:rtype: :obj:`bytes`
"""
return await asyncio_helper.download_file(self.token, file_path)
async def log_out(self) -> bool:
"""
Use this method to log out from the cloud Bot API server before launching the bot locally.
You MUST log out the bot before running it locally, otherwise there is no guarantee
that the bot will receive updates.
After a successful call, you can immediately log in on a local server,
but will not be able to log in back to the cloud Bot API server for 10 minutes.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#logout
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.log_out(self.token)
async def close(self) -> bool:
"""
Use this method to close the bot instance before moving it from one local server to another.
You need to delete the webhook before calling this method to ensure that the bot isn't launched again
after server restart.
The method will return error 429 in the first 10 minutes after the bot is launched.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#close
:return: :obj:`bool`
"""
return await asyncio_helper.close(self.token)
def enable_saving_states(self, filename="./.state-save/states.pkl"):
"""
Enable saving states (by default saving disabled)
.. note::
It is recommended to pass a :class:`~telebot.asyncio_storage.StatePickleStorage` instance as state_storage
to TeleBot class.
:param filename: Filename of saving file, defaults to "./.state-save/states.pkl"
:type filename: :obj:`str`, optional
"""
self.current_states = StatePickleStorage(file_path=filename)
async def set_webhook(self, url: Optional[str]=None, certificate: Optional[Union[str, Any]]=None, max_connections: Optional[int]=None,
allowed_updates: Optional[List[str]]=None, ip_address: Optional[str]=None,
drop_pending_updates: Optional[bool] = None, timeout: Optional[int]=None,
secret_token: Optional[str]=None) -> bool:
"""
Use this method to specify a URL and receive incoming updates via an outgoing webhook.
Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL,
containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after
a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token.
If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
Telegram Documentation: https://core.telegram.org/bots/api#setwebhook
:param url: HTTPS URL to send updates to. Use an empty string to remove webhook integration, defaults to None
:type url: :obj:`str`, optional
:param certificate: Upload your public key certificate so that the root certificate in use can be checked, defaults to None
:type certificate: :class:`str`, optional
:param max_connections: The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100.
Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput,
defaults to None
:type max_connections: :obj:`int`, optional
:param allowed_updates: A JSON-serialized list of the update types you want your bot to receive. For example,
specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update
for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default).
If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received
for a short period of time. Defaults to None
:type allowed_updates: :obj:`list`, optional
:param ip_address: The fixed IP address which will be used to send webhook requests instead of the IP address
resolved through DNS, defaults to None
:type ip_address: :obj:`str`, optional
:param drop_pending_updates: Pass True to drop all pending updates, defaults to None
:type drop_pending_updates: :obj:`bool`, optional
:param timeout: Timeout of a request, defaults to None
:type timeout: :obj:`int`, optional
:param secret_token: A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. Defaults to None
:type secret_token: :obj:`str`, optional
:return: True on success.
:rtype: :obj:`bool` if the request was successful.
"""
return await asyncio_helper.set_webhook(self.token, url, certificate, max_connections, allowed_updates, ip_address,
drop_pending_updates, timeout, secret_token)
async def run_webhooks(self,
listen: Optional[str]="127.0.0.1",
port: Optional[int]=443,
url_path: Optional[str]=None,
certificate: Optional[str]=None,
certificate_key: Optional[str]=None,
webhook_url: Optional[str]=None,
max_connections: Optional[int]=None,
allowed_updates: Optional[List]=None,
ip_address: Optional[str]=None,
drop_pending_updates: Optional[bool] = None,
timeout: Optional[int]=None,
secret_token: Optional[str]=None,
secret_token_length: Optional[int]=20,
debug: Optional[bool]=False):
"""
This class sets webhooks and listens to a given url and port.
:param listen: IP address to listen to. Defaults to 0.0.0.0
:param port: A port which will be used to listen to webhooks.
:param url_path: Path to the webhook. Defaults to /token
:param certificate: Path to the certificate file.
:param certificate_key: Path to the certificate key file.
:param webhook_url: Webhook URL.
:param max_connections: Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
:param allowed_updates: A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.
:param ip_address: The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
:param drop_pending_updates: Pass True to drop all pending updates
:param timeout: Integer. Request connection timeout
:param secret_token: Secret token to be used to verify the webhook request.
:param secret_token_length: Length of a secret token, defaults to 20
:param debug: Debug mode, defaults to False
:return:
"""
# generate secret token if not set
if not secret_token:
secret_token = ''.join(random.choices(string.ascii_uppercase + string.digits, k=secret_token_length))
if not url_path:
url_path = self.token + '/'
if url_path[-1] != '/': url_path += '/'
protocol = "https" if certificate else "http"
if not webhook_url:
webhook_url = "{}://{}:{}/{}".format(protocol, listen, port, url_path)
if certificate and certificate_key:
ssl_ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
ssl_ctx.load_cert_chain(certificate, certificate_key)
# open certificate if it exists
cert_file = open(certificate, 'rb') if certificate else None
await self.set_webhook(
url=webhook_url,
certificate=cert_file,
max_connections=max_connections,
allowed_updates=allowed_updates,
ip_address=ip_address,
drop_pending_updates=drop_pending_updates,
timeout=timeout,
secret_token=secret_token
)
if cert_file: cert_file.close()
ssl_context = (certificate, certificate_key) if certificate else (None, None)
# for webhooks
try:
from telebot.ext.aio import AsyncWebhookListener
except (NameError, ImportError):
raise ImportError("Please install uvicorn and fastapi in order to use `run_webhooks` method.")
self.webhook_listener = AsyncWebhookListener(bot=self, secret_token=secret_token, host=listen, port=port, ssl_context=ssl_context, url_path='/'+url_path)
await self.webhook_listener.run_app()
async def delete_webhook(self, drop_pending_updates: Optional[bool]=None, timeout: Optional[int]=None) -> bool:
"""
Use this method to remove webhook integration if you decide to switch back to getUpdates.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#deletewebhook
:param drop_pending_updates: Pass True to drop all pending updates, defaults to None
:type drop_pending_updates: :obj: `bool`, optional
:param timeout: Request connection timeout, defaults to None
:type timeout: :obj:`int`, optional
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_webhook(self.token, drop_pending_updates, timeout)
async def remove_webhook(self) -> bool:
"""
Alternative for delete_webhook but uses set_webhook
"""
result = await self.set_webhook()
return result
async def get_webhook_info(self, timeout: Optional[int]=None) -> types.WebhookInfo:
"""
Use this method to get current webhook status. Requires no parameters.
On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
Telegram documentation: https://core.telegram.org/bots/api#getwebhookinfo
:param timeout: Request connection timeout
:type timeout: :obj:`int`, optional
:return: On success, returns a WebhookInfo object.
:rtype: :class:`telebot.types.WebhookInfo`
"""
result = await asyncio_helper.get_webhook_info(self.token, timeout)
return types.WebhookInfo.de_json(result)
async def get_user_profile_photos(self, user_id: int, offset: Optional[int]=None,
limit: Optional[int]=None) -> types.UserProfilePhotos:
"""
Use this method to get a list of profile pictures for a user.
Returns a :class:`telebot.types.UserProfilePhotos` object.
Telegram documentation: https://core.telegram.org/bots/api#getuserprofilephotos
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:param offset: Sequential number of the first photo to be returned. By default, all photos are returned.
:type offset: :obj:`int`
:param limit: Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.
:type limit: :obj:`int`
:return: `UserProfilePhotos <https://core.telegram.org/bots/api#userprofilephotos>`_
:rtype: :class:`telebot.types.UserProfilePhotos`
"""
result = await asyncio_helper.get_user_profile_photos(self.token, user_id, offset, limit)
return types.UserProfilePhotos.de_json(result)
async def get_chat(self, chat_id: Union[int, str]) -> types.Chat:
"""
Use this method to get up to date information about the chat (current name of the user for one-on-one
conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
Telegram documentation: https://core.telegram.org/bots/api#getchat
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: Chat information
:rtype: :class:`telebot.types.Chat`
"""
result = await asyncio_helper.get_chat(self.token, chat_id)
return types.Chat.de_json(result)
async def leave_chat(self, chat_id: Union[int, str]) -> bool:
"""
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#leavechat
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: :obj:`bool`
"""
result = await asyncio_helper.leave_chat(self.token, chat_id)
return result
async def get_chat_administrators(self, chat_id: Union[int, str]) -> List[types.ChatMember]:
"""
Use this method to get a list of administrators in a chat.
On success, returns an Array of ChatMember objects that contains
information about all chat administrators except other bots.
Telegram documentation: https://core.telegram.org/bots/api#getchatadministrators
:param chat_id: Unique identifier for the target chat or username
of the target supergroup or channel (in the format @channelusername)
:return: List made of ChatMember objects.
:rtype: :obj:`list` of :class:`telebot.types.ChatMember`
"""
result = await asyncio_helper.get_chat_administrators(self.token, chat_id)
return [types.ChatMember.de_json(r) for r in result]
@util.deprecated(deprecation_text="Use get_chat_member_count instead")
async def get_chat_members_count(self, chat_id: Union[int, str]) -> int:
"""
This function is deprecated. Use `get_chat_member_count` instead.
.. deprecated:: 4.0.0
This function is deprecated. Use `get_chat_member_count` instead.
Use this method to get the number of members in a chat.
Telegram documentation: https://core.telegram.org/bots/api#getchatmembercount
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: Number of members in the chat.
:rtype: :obj:`int`
"""
result = await asyncio_helper.get_chat_member_count(self.token, chat_id)
return result
async def get_chat_member_count(self, chat_id: Union[int, str]) -> int:
"""
Use this method to get the number of members in a chat.
Telegram documentation: https://core.telegram.org/bots/api#getchatmembercount
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: Number of members in the chat.
:rtype: :obj:`int`
"""
result = await asyncio_helper.get_chat_member_count(self.token, chat_id)
return result
async def set_chat_sticker_set(self, chat_id: Union[int, str], sticker_set_name: str) -> types.StickerSet:
"""
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat
for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned
in getChat requests to check if the bot can use this method. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setchatstickerset
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:param sticker_set_name: Name of the sticker set to be set as the group sticker set
:type sticker_set_name: :obj:`str`
:return: StickerSet object
:rtype: :class:`telebot.types.StickerSet`
"""
result = await asyncio_helper.set_chat_sticker_set(self.token, chat_id, sticker_set_name)
return result
async def delete_chat_sticker_set(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat
for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set
optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#deletechatstickerset
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
result = await asyncio_helper.delete_chat_sticker_set(self.token, chat_id)
return result
async def answer_web_app_query(self, web_app_query_id: str, result: types.InlineQueryResultBase) -> types.SentWebAppMessage:
"""
Use this method to set the result of an interaction with a Web App and
send a corresponding message on behalf of the user to the chat from which
the query originated.
On success, a SentWebAppMessage object is returned.
Telegram Documentation: https://core.telegram.org/bots/api#answerwebappquery
:param web_app_query_id: Unique identifier for the query to be answered
:type web_app_query_id: :obj:`str`
:param result: A JSON-serialized object describing the message to be sent
:type result: :class:`telebot.types.InlineQueryResultBase`
:return: On success, a SentWebAppMessage object is returned.
:rtype: :class:`telebot.types.SentWebAppMessage`
"""
return await asyncio_helper.answer_web_app_query(self.token, web_app_query_id, result)
async def get_chat_member(self, chat_id: Union[int, str], user_id: int) -> types.ChatMember:
"""
Use this method to get information about a member of a chat. Returns a ChatMember object on success.
Telegram documentation: https://core.telegram.org/bots/api#getchatmember
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:return: Returns ChatMember object on success.
:rtype: :class:`telebot.types.ChatMember`
"""
result = await asyncio_helper.get_chat_member(self.token, chat_id, user_id)
return types.ChatMember.de_json(result)
async def send_message(
self, chat_id: Union[int, str], text: str,
parse_mode: Optional[str]=None,
entities: Optional[List[types.MessageEntity]]=None,
disable_web_page_preview: Optional[bool]=None,
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send text messages.
Warning: Do not send more than about 4096 characters each message, otherwise you'll risk an HTTP 414 error.
If you must send more than 4096 characters,
use the `split_string` or `smart_split` function in util.py.
Telegram documentation: https://core.telegram.org/bots/api#sendmessage
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param text: Text of the message to be sent
:type text: :obj:`str`
:param parse_mode: Mode for parsing entities in the message text.
:type parse_mode: :obj:`str`
:param entities: List of special entities that appear in message text, which can be specified instead of parse_mode
:type entities: Array of :class:`telebot.types.MessageEntity`
:param disable_web_page_preview: Disables link previews for links in this message
:type disable_web_page_preview: :obj:`bool`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param protect_content: If True, the message content will be hidden for all users except for the target user
:type protect_content: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_web_page_preview = self.disable_web_page_preview if (disable_web_page_preview is None) else disable_web_page_preview
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_message(
self.token, chat_id, text, disable_web_page_preview, reply_to_message_id,
reply_markup, parse_mode, disable_notification, timeout,
entities, allow_sending_without_reply, protect_content, message_thread_id))
async def forward_message(
self, chat_id: Union[int, str], from_chat_id: Union[int, str],
message_id: int, disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
timeout: Optional[int]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to forward messages of any kind.
Telegram documentation: https://core.telegram.org/bots/api#forwardmessage
:param disable_notification: Sends the message silently. Users will receive a notification with no sound
:type disable_notification: :obj:`bool`
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
:type from_chat_id: :obj:`int` or :obj:`str`
:param message_id: Message identifier in the chat specified in from_chat_id
:type message_id: :obj:`int`
:param protect_content: Protects the contents of the forwarded message from forwarding and saving
:type protect_content: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
return types.Message.de_json(
await asyncio_helper.forward_message(self.token, chat_id, from_chat_id, message_id, disable_notification, timeout, protect_content,
message_thread_id))
async def copy_message(
self, chat_id: Union[int, str],
from_chat_id: Union[int, str],
message_id: int,
caption: Optional[str]=None,
parse_mode: Optional[str]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
message_thread_id: Optional[int]=None) -> types.MessageID:
"""
Use this method to copy messages of any kind.
Telegram documentation: https://core.telegram.org/bots/api#copymessage
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
:type from_chat_id: :obj:`int` or :obj:`str`
:param message_id: Message identifier in the chat specified in from_chat_id
:type message_id: :obj:`int`
:param caption: New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept
:type caption: :obj:`str`
:param parse_mode: Mode for parsing entities in the new caption.
:type parse_mode: :obj:`str`
:param caption_entities: A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode
:type caption_entities: Array of :class:`telebot.types.MessageEntity`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.MessageID.de_json(
await asyncio_helper.copy_message(self.token, chat_id, from_chat_id, message_id, caption, parse_mode, caption_entities,
disable_notification, reply_to_message_id, allow_sending_without_reply, reply_markup,
timeout, protect_content, message_thread_id))
async def delete_message(self, chat_id: Union[int, str], message_id: int,
timeout: Optional[int]=None) -> bool:
"""
Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#deletemessage
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Identifier of the message to delete
:type message_id: :obj:`int`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_message(self.token, chat_id, message_id, timeout)
async def send_dice(
self, chat_id: Union[int, str],
emoji: Optional[str]=None, disable_notification: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#senddice
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param emoji: Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”.
Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”
:type emoji: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
to remove reply keyboard or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding
:type protect_content: :obj:`bool`
:param message_thread_id: The identifier of a message thread, unique within the chat to which the message with the thread identifier belongs
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_dice(
self.token, chat_id, emoji, disable_notification, reply_to_message_id,
reply_markup, timeout, allow_sending_without_reply, protect_content, message_thread_id)
)
async def send_photo(
self, chat_id: Union[int, str], photo: Union[Any, str],
caption: Optional[str]=None, parse_mode: Optional[str]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
message_thread_id: Optional[int]=None,
has_spoiler: Optional[bool]=None) -> types.Message:
"""
Use this method to send photos. On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendphoto
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended),
pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data.
The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20.
:type photo: :obj:`str` or :class:`telebot.types.InputFile`
:param caption: Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param parse_mode: Mode for parsing entities in the photo caption.
:type parse_mode: :obj:`str`
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
to remove reply keyboard or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:param has_spoiler: Pass True, if the photo should be sent as a spoiler
:type has_spoiler: :obj:`bool`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_photo(
self.token, chat_id, photo, caption, reply_to_message_id, reply_markup,
parse_mode, disable_notification, timeout, caption_entities,
allow_sending_without_reply, protect_content, message_thread_id, has_spoiler))
async def send_audio(
self, chat_id: Union[int, str], audio: Union[Any, str],
caption: Optional[str]=None, duration: Optional[int]=None,
performer: Optional[str]=None, title: Optional[str]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
parse_mode: Optional[str]=None,
disable_notification: Optional[bool]=None,
timeout: Optional[int]=None,
thumbnail: Optional[Union[Any, str]]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None,
thumb: Optional[Union[Any, str]]=None) -> types.Message:
"""
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size,
this limit may be changed in the future.
For sending voice messages, use the send_voice method instead.
Telegram documentation: https://core.telegram.org/bots/api#sendaudio
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param audio: Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended),
pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data.
Audio must be in the .MP3 or .M4A format.
:type audio: :obj:`str` or :class:`telebot.types.InputFile`
:param caption: Audio caption, 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param duration: Duration of the audio in seconds
:type duration: :obj:`int`
:param performer: Performer
:type performer: :obj:`str`
:param title: Track name
:type title: :obj:`str`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup:
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param parse_mode: Mode for parsing entities in the audio caption. See formatting options for more details.
:type parse_mode: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320.
Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file,
so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>
:type thumbnail: :obj:`str` or :class:`telebot.types.InputFile`
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:param thumb: Deprecated. Use thumbnail instead
:type thumb: :obj:`str` or :class:`telebot.types.InputFile`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
if thumb is not None and thumbnail is None:
thumbnail = thumb
logger.warning('The parameter "thumb" is deprecated, use "thumbnail" instead')
return types.Message.de_json(
await asyncio_helper.send_audio(
self.token, chat_id, audio, caption, duration, performer, title, reply_to_message_id,
reply_markup, parse_mode, disable_notification, timeout, thumbnail,
caption_entities, allow_sending_without_reply, protect_content, message_thread_id))
async def send_voice(
self, chat_id: Union[int, str], voice: Union[Any, str],
caption: Optional[str]=None, duration: Optional[int]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
parse_mode: Optional[str]=None,
disable_notification: Optional[bool]=None,
timeout: Optional[int]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document).
On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Telegram documentation: https://core.telegram.org/bots/api#sendvoice
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param voice: Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended),
pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
:type voice: :obj:`str` or :class:`telebot.types.InputFile`
:param caption: Voice message caption, 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param duration: Duration of the voice message in seconds
:type duration: :obj:`int`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
to remove reply keyboard or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param parse_mode: Mode for parsing entities in the voice message caption. See formatting options for more details.
:type parse_mode: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_voice(
self.token, chat_id, voice, caption, duration, reply_to_message_id, reply_markup,
parse_mode, disable_notification, timeout, caption_entities,
allow_sending_without_reply, protect_content, message_thread_id))
async def send_document(
self, chat_id: Union[int, str], document: Union[Any, str],
reply_to_message_id: Optional[int]=None,
caption: Optional[str]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
parse_mode: Optional[str]=None,
disable_notification: Optional[bool]=None,
timeout: Optional[int]=None,
thumbnail: Optional[Union[Any, str]]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
allow_sending_without_reply: Optional[bool]=None,
visible_file_name: Optional[str]=None,
disable_content_type_detection: Optional[bool]=None,
data: Optional[Union[Any, str]]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None,
thumb: Optional[Union[Any, str]]=None) -> types.Message:
"""
Use this method to send general files.
Telegram documentation: https://core.telegram.org/bots/api#senddocument
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param document: (document) File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a
String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data
:type document: :obj:`str` or :class:`telebot.types.InputFile`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param caption: Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param parse_mode: Mode for parsing entities in the document caption
:type parse_mode: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param thumbnail: InputFile or String : Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>
:type thumbnail: :obj:`str` or :class:`telebot.types.InputFile`
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param visible_file_name: allows to define file name that will be visible in the Telegram instead of original file name
:type visible_file_name: :obj:`str`
:param disable_content_type_detection: Disables automatic server-side content type detection for files uploaded using multipart/form-data
:type disable_content_type_detection: :obj:`bool`
:param data: function typo miss compatibility: do not use it
:type data: :obj:`str`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:param thumb: Deprecated. Use thumbnail instead
:type thumb: :obj:`str` or :class:`telebot.types.InputFile`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
if data and not(document):
# function typo miss compatibility
logger.warning('The parameter "data" is deprecated. Use "document" instead.')
document = data
if thumb is not None and thumbnail is None:
thumbnail = thumb
logger.warning('The parameter "thumb" is deprecated. Use "thumbnail" instead.')
return types.Message.de_json(
await asyncio_helper.send_data(
self.token, chat_id, document, 'document',
reply_to_message_id = reply_to_message_id, reply_markup = reply_markup, parse_mode = parse_mode,
disable_notification = disable_notification, timeout = timeout, caption = caption, thumbnail= thumbnail,
caption_entities = caption_entities, allow_sending_without_reply = allow_sending_without_reply,
disable_content_type_detection = disable_content_type_detection, visible_file_name = visible_file_name, protect_content = protect_content,
message_thread_id = message_thread_id))
async def send_sticker(
self, chat_id: Union[int, str], sticker: Union[Any, str],
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
disable_notification: Optional[bool]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
data: Union[Any, str]=None,
message_thread_id: Optional[int]=None,
emoji: Optional[str]=None) -> types.Message:
"""
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers.
On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendsticker
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL
as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data.
:type sticker: :obj:`str` or :class:`telebot.types.InputFile`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param disable_notification: to disable the notification
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param data: function typo miss compatibility: do not use it
:type data: :obj:`str`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:param emoji: Emoji associated with the sticker; only for just uploaded stickers
:type emoji: :obj:`str`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
if data and not(sticker):
# function typo miss compatibility
logger.warning('The parameter "data" is deprecated. Use "sticker" instead.')
sticker = data
return types.Message.de_json(
await asyncio_helper.send_data(
self.token, chat_id, sticker, 'sticker',
reply_to_message_id=reply_to_message_id, reply_markup=reply_markup,
disable_notification=disable_notification, timeout=timeout,
allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content,
message_thread_id=message_thread_id, emoji=emoji))
async def send_video(
self, chat_id: Union[int, str], video: Union[Any, str],
duration: Optional[int]=None,
width: Optional[int]=None,
height: Optional[int]=None,
thumbnail: Optional[Union[Any, str]]=None,
caption: Optional[str]=None,
parse_mode: Optional[str]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
supports_streaming: Optional[bool]=None,
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
data: Optional[Union[Any, str]]=None,
message_thread_id: Optional[int]=None,
has_spoiler: Optional[bool]=None,
thumb: Optional[Union[Any, str]]=None) -> types.Message:
"""
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
Telegram documentation: https://core.telegram.org/bots/api#sendvideo
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param video: Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data.
:type video: :obj:`str` or :class:`telebot.types.InputFile`
:param duration: Duration of sent video in seconds
:type duration: :obj:`int`
:param width: Video width
:type width: :obj:`int`
:param height: Video height
:type height: :obj:`int`
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
:type thumbnail: :obj:`str` or :class:`telebot.types.InputFile`
:param caption: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param parse_mode: Mode for parsing entities in the video caption
:type parse_mode: :obj:`str`
:param caption_entities: List of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity`
:param supports_streaming: Pass True, if the uploaded video is suitable for streaming
:type supports_streaming: :obj:`bool`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param data: function typo miss compatibility: do not use it
:type data: :obj:`str`
:param message_thread_id: Identifier of a message thread, in which the video will be sent
:type message_thread_id: :obj:`int`
:param has_spoiler: Pass True, if the video should be sent as a spoiler
:type has_spoiler: :obj:`bool`
:param thumb: Deprecated. Use thumbnail instead
:type thumb: :obj:`str` or :class:`telebot.types.InputFile`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
if data and not(video):
# function typo miss compatibility
logger.warning('The parameter "data" is deprecated. Use "video" instead.')
video = data
if thumb and not(thumbnail):
logger.warning('The parameter "thumb" is deprecated. Use "thumbnail" instead.')
thumbnail = thumb
return types.Message.de_json(
await asyncio_helper.send_video(
self.token, chat_id, video, duration, caption, reply_to_message_id, reply_markup,
parse_mode, supports_streaming, disable_notification, timeout, thumbnail, width, height,
caption_entities, allow_sending_without_reply, protect_content, message_thread_id, has_spoiler))
async def send_animation(
self, chat_id: Union[int, str], animation: Union[Any, str],
duration: Optional[int]=None,
width: Optional[int]=None,
height: Optional[int]=None,
thumbnail: Optional[Union[Any, str]]=None,
caption: Optional[str]=None,
parse_mode: Optional[str]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
message_thread_id: Optional[int]=None,
has_spoiler: Optional[bool]=None,
thumb: Optional[Union[Any, str]]=None) -> types.Message:
"""
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
Telegram documentation: https://core.telegram.org/bots/api#sendanimation
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param animation: Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended),
pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data.
:type animation: :obj:`str` or :class:`telebot.types.InputFile`
:param duration: Duration of sent animation in seconds
:type duration: :obj:`int`
:param width: Animation width
:type width: :obj:`int`
:param height: Animation height
:type height: :obj:`int`
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320.
Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file,
so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
:type thumbnail: :obj:`str` or :class:`telebot.types.InputFile`
:param caption: Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param parse_mode: Mode for parsing entities in the animation caption
:type parse_mode: :obj:`str`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param caption_entities: List of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the video will be sent
:type message_thread_id: :obj:`int`
:param has_spoiler: Pass True, if the animation should be sent as a spoiler
:type has_spoiler: :obj:`bool`
:param thumb: Deprecated. Use thumbnail instead
:type thumb: :obj:`str` or :class:`telebot.types.InputFile`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
if thumb is not None and thumbnail is None:
thumbnail = thumb
logger.warning('The parameter "thumb" is deprecated. Use "thumbnail" instead.')
return types.Message.de_json(
await asyncio_helper.send_animation(
self.token, chat_id, animation, duration, caption, reply_to_message_id,
reply_markup, parse_mode, disable_notification, timeout, thumbnail,
caption_entities, allow_sending_without_reply, width, height, protect_content, message_thread_id, has_spoiler))
async def send_video_note(
self, chat_id: Union[int, str], data: Union[Any, str],
duration: Optional[int]=None,
length: Optional[int]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
disable_notification: Optional[bool]=None,
timeout: Optional[int]=None,
thumbnail: Optional[Union[Any, str]]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None,
thumb: Optional[Union[Any, str]]=None) -> types.Message:
"""
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long.
Use this method to send video messages. On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendvideonote
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param data: Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended)
or upload a new video using multipart/form-data. Sending video notes by a URL is currently unsupported
:type data: :obj:`str` or :class:`telebot.types.InputFile`
:param duration: Duration of sent video in seconds
:type duration: :obj:`int`
:param length: Video width and height, i.e. diameter of the video message
:type length: :obj:`int`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320.
Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file,
so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
:type thumbnail: :obj:`str` or :class:`telebot.types.InputFile`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the video note will be sent
:type message_thread_id: :obj:`int`
:param thumb: Deprecated. Use thumbnail instead
:type thumb: :obj:`str` or :class:`telebot.types.InputFile`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
if thumb is not None and thumbnail is None:
thumbnail = thumb
logger.warning('The parameter "thumb" is deprecated. Use "thumbnail" instead.')
return types.Message.de_json(
await asyncio_helper.send_video_note(
self.token, chat_id, data, duration, length, reply_to_message_id, reply_markup,
disable_notification, timeout, thumbnail, allow_sending_without_reply, protect_content, message_thread_id))
async def send_media_group(
self, chat_id: Union[int, str],
media: List[Union[
types.InputMediaAudio, types.InputMediaDocument,
types.InputMediaPhoto, types.InputMediaVideo]],
disable_notification: Optional[bool]=None,
protect_content: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> List[types.Message]:
"""
Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files
can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendmediagroup
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param media: A JSON-serialized array describing messages to be sent, must include 2-10 items
:type media: :obj:`list` of :obj:`types.InputMedia`
:param disable_notification: Sends the messages silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the messages will be sent
:type message_thread_id: :obj:`int`
:return: On success, an array of Messages that were sent is returned.
:rtype: List[types.Message]
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
result = await asyncio_helper.send_media_group(
self.token, chat_id, media, disable_notification, reply_to_message_id, timeout,
allow_sending_without_reply, protect_content, message_thread_id)
return [types.Message.de_json(msg) for msg in result]
async def send_location(
self, chat_id: Union[int, str],
latitude: float, longitude: float,
live_period: Optional[int]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
disable_notification: Optional[bool]=None,
timeout: Optional[int]=None,
horizontal_accuracy: Optional[float]=None,
heading: Optional[int]=None,
proximity_alert_radius: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send point on the map. On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendlocation
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param latitude: Latitude of the location
:type latitude: :obj:`float`
:param longitude: Longitude of the location
:type longitude: :obj:`float`
:param live_period: Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.
:type live_period: :obj:`int`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500
:type horizontal_accuracy: :obj:`float`
:param heading: For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
:type heading: :obj:`int`
:param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
:type proximity_alert_radius: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: Identifier of a message thread, in which the message will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_location(
self.token, chat_id, latitude, longitude, live_period,
reply_to_message_id, reply_markup, disable_notification, timeout,
horizontal_accuracy, heading, proximity_alert_radius,
allow_sending_without_reply, protect_content, message_thread_id))
async def edit_message_live_location(
self, latitude: float, longitude: float,
chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
reply_markup: Optional[types.InlineKeyboardMarkup]=None,
timeout: Optional[int]=None,
horizontal_accuracy: Optional[float]=None,
heading: Optional[int]=None,
proximity_alert_radius: Optional[int]=None) -> types.Message:
"""
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly
disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message
is returned, otherwise True is returned.
Telegram documentation: https://core.telegram.org/bots/api#editmessagelivelocation
:param latitude: Latitude of new location
:type latitude: :obj:`float`
:param longitude: Longitude of new location
:type longitude: :obj:`float`
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the message to edit
:type message_id: :obj:`int`
:param reply_markup: A JSON-serialized object for a new inline keyboard.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message
:type inline_message_id: :obj:`str`
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500
:type horizontal_accuracy: :obj:`float`
:param heading: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
:type heading: :obj:`int`
:param proximity_alert_radius: The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
:type proximity_alert_radius: :obj:`int`
:return: On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
:rtype: :class:`telebot.types.Message` or bool
"""
return types.Message.de_json(
await asyncio_helper.edit_message_live_location(
self.token, latitude, longitude, chat_id, message_id,
inline_message_id, reply_markup, timeout,
horizontal_accuracy, heading, proximity_alert_radius))
async def stop_message_live_location(
self, chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
reply_markup: Optional[types.InlineKeyboardMarkup]=None,
timeout: Optional[int]=None) -> types.Message:
"""
Use this method to stop updating a live location message before live_period expires.
On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
Telegram documentation: https://core.telegram.org/bots/api#stopmessagelivelocation
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the message with live location to stop
:type message_id: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message with live location to stop
:type inline_message_id: :obj:`str`
:param reply_markup: A JSON-serialized object for a new inline keyboard.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:return: On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
:rtype: :class:`telebot.types.Message` or bool
"""
return types.Message.de_json(
await asyncio_helper.stop_message_live_location(
self.token, chat_id, message_id, inline_message_id, reply_markup, timeout))
async def send_venue(
self, chat_id: Union[int, str],
latitude: float, longitude: float,
title: str, address: str,
foursquare_id: Optional[str]=None,
foursquare_type: Optional[str]=None,
disable_notification: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
google_place_id: Optional[str]=None,
google_place_type: Optional[str]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send information about a venue. On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendvenue
:param chat_id: Unique identifier for the target chat or username of the target channel
:type chat_id: :obj:`int` or :obj:`str`
:param latitude: Latitude of the venue
:type latitude: :obj:`float`
:param longitude: Longitude of the venue
:type longitude: :obj:`float`
:param title: Name of the venue
:type title: :obj:`str`
:param address: Address of the venue
:type address: :obj:`str`
:param foursquare_id: Foursquare identifier of the venue
:type foursquare_id: :obj:`str`
:param foursquare_type: Foursquare type of the venue, if known. (For example, “arts_entertainment/default”,
“arts_entertainment/aquarium” or “food/icecream”.)
:type foursquare_type: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard,
custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if one of the specified
replied-to messages is not found.
:type allow_sending_without_reply: :obj:`bool`
:param google_place_id: Google Places identifier of the venue
:type google_place_id: :obj:`str`
:param google_place_type: Google Places type of the venue.
:type google_place_type: :obj:`str`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: The thread to which the message will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_venue(
self.token, chat_id, latitude, longitude, title, address, foursquare_id, foursquare_type,
disable_notification, reply_to_message_id, reply_markup, timeout,
allow_sending_without_reply, google_place_id, google_place_type, protect_content, message_thread_id)
)
async def send_contact(
self, chat_id: Union[int, str], phone_number: str,
first_name: str, last_name: Optional[str]=None,
vcard: Optional[str]=None,
disable_notification: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send phone contacts. On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendcontact
:param chat_id: Unique identifier for the target chat or username of the target channel
:type chat_id: :obj:`int` or :obj:`str`
:param phone_number: Contact's phone number
:type phone_number: :obj:`str`
:param first_name: Contact's first name
:type first_name: :obj:`str`
:param last_name: Contact's last name
:type last_name: :obj:`str`
:param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes
:type vcard: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard,
custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
:type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove`
or :class:`telebot.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if one of the specified
replied-to messages is not found.
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: The thread to which the message will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
return types.Message.de_json(
await asyncio_helper.send_contact(
self.token, chat_id, phone_number, first_name, last_name, vcard,
disable_notification, reply_to_message_id, reply_markup, timeout,
allow_sending_without_reply, protect_content, message_thread_id)
)
async def send_chat_action(
self, chat_id: Union[int, str], action: str, timeout: Optional[int]=None, message_thread_id: Optional[int]=None) -> bool:
"""
Use this method when you need to tell the user that something is happening on the bot's side.
The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).
Returns True on success.
Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of
“Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
Telegram documentation: https://core.telegram.org/bots/api#sendchataction
:param chat_id: Unique identifier for the target chat or username of the target channel
:type chat_id: :obj:`int` or :obj:`str`
:param action: Type of action to broadcast. Choose one, depending on what the user is about
to receive: typing for text messages, upload_photo for photos, record_video or upload_video
for videos, record_voice or upload_voice for voice notes, upload_document for general files,
choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
:type action: :obj:`str`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param message_thread_id: The thread to which the message will be sent(supergroups only)
:type message_thread_id: :obj:`int`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.send_chat_action(self.token, chat_id, action, timeout, message_thread_id)
async def kick_chat_member(
self, chat_id: Union[int, str], user_id: int,
until_date:Optional[Union[int, datetime]]=None,
revoke_messages: Optional[bool]=None) -> bool:
"""
This function is deprecated. Use `ban_chat_member` instead
"""
logger.info('kick_chat_member is deprecated. Use ban_chat_member instead.')
return await asyncio_helper.ban_chat_member(self.token, chat_id, user_id, until_date, revoke_messages)
async def ban_chat_member(
self, chat_id: Union[int, str], user_id: int,
until_date:Optional[Union[int, datetime]]=None,
revoke_messages: Optional[bool]=None) -> bool:
"""
Use this method to ban a user in a group, a supergroup or a channel.
In the case of supergroups and channels, the user will not be able to return to the chat on their
own using invite links, etc., unless unbanned first.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#banchatmember
:param chat_id: Unique identifier for the target group or username of the target supergroup
or channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:param until_date: Date when the user will be unbanned, unix time. If user is banned for more than 366 days or
less than 30 seconds from the current time they are considered to be banned forever
:type until_date: :obj:`int` or :obj:`datetime`
:param revoke_messages: Bool: Pass True to delete all messages from the chat for the user that is being removed.
If False, the user will be able to see messages in the group that were sent before the user was removed.
Always True for supergroups and channels.
:type revoke_messages: :obj:`bool`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.ban_chat_member(self.token, chat_id, user_id, until_date, revoke_messages)
async def unban_chat_member(
self, chat_id: Union[int, str], user_id: int,
only_if_banned: Optional[bool]=False) -> bool:
"""
Use this method to unban a previously kicked user in a supergroup or channel.
The user will not return to the group or channel automatically, but will be able to join via link, etc.
The bot must be an administrator for this to work. By default, this method guarantees that after the call
the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat
they will also be removed from the chat. If you don't want this, use the parameter only_if_banned.
Telegram documentation: https://core.telegram.org/bots/api#unbanchatmember
:param chat_id: Unique identifier for the target group or username of the target supergroup or channel
(in the format @username)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:param only_if_banned: Do nothing if the user is not banned
:type only_if_banned: :obj:`bool`
:return: True on success
:rtype: :obj:`bool`
"""
return await asyncio_helper.unban_chat_member(self.token, chat_id, user_id, only_if_banned)
async def restrict_chat_member(
self, chat_id: Union[int, str], user_id: int,
until_date: Optional[Union[int, datetime]]=None,
can_send_messages: Optional[bool]=None,
can_send_media_messages: Optional[bool]=None,
can_send_polls: Optional[bool]=None,
can_send_other_messages: Optional[bool]=None,
can_add_web_page_previews: Optional[bool]=None,
can_change_info: Optional[bool]=None,
can_invite_users: Optional[bool]=None,
can_pin_messages: Optional[bool]=None,
permissions: Optional[types.ChatPermissions]=None,
use_independent_chat_permissions: Optional[bool]=None) -> bool:
"""
Use this method to restrict a user in a supergroup.
The bot must be an administrator in the supergroup for this to work and must have
the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user.
Telegram documentation: https://core.telegram.org/bots/api#restrictchatmember
.. warning::
Individual parameters are deprecated and will be removed, use 'permissions' instead
:param chat_id: Unique identifier for the target group or username of the target supergroup
or channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:param until_date: Date when restrictions will be lifted for the user, unix time.
If user is restricted for more than 366 days or less than 30 seconds from the current time,
they are considered to be restricted forever
:type until_date: :obj:`int` or :obj:`datetime`
:param can_send_messages: Pass True, if the user can send text messages, contacts, locations and venues
:type can_send_messages: :obj:`bool`
:param can_send_media_messages: Pass True, if the user can send audios, documents, photos, videos, video notes
and voice notes, implies can_send_messages
:type can_send_media_messages: :obj:`bool`
:param can_send_polls: Pass True, if the user is allowed to send polls, implies can_send_messages
:type can_send_polls: :obj:`bool`
:param can_send_other_messages: Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages
:type can_send_other_messages: :obj:`bool`
:param can_add_web_page_previews: Pass True, if the user may add web page previews to their messages,
implies can_send_media_messages
:type can_add_web_page_previews: :obj:`bool`
:param can_change_info: Pass True, if the user is allowed to change the chat title, photo and other settings.
Ignored in public supergroups
:type can_change_info: :obj:`bool`
:param can_invite_users: Pass True, if the user is allowed to invite new users to the chat,
implies can_invite_users
:type can_invite_users: :obj:`bool`
:param can_pin_messages: Pass True, if the user is allowed to pin messages. Ignored in public supergroups
:type can_pin_messages: :obj:`bool`
:param use_independent_chat_permissions: Pass True if chat permissions are set independently. Otherwise,
the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages,
can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and
can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
:type use_independent_chat_permissions: :obj:`bool`
:param permissions: Pass ChatPermissions object to set all permissions at once. Use this parameter instead of
passing all boolean parameters to avoid backward compatibility problems in future.
:type permissions: :obj:`types.ChatPermissions`
:return: True on success
:rtype: :obj:`bool`
"""
if permissions is None:
permissions = types.ChatPermissions(
can_send_messages=can_send_messages,
can_send_media_messages=can_send_media_messages,
can_send_polls=can_send_polls,
can_send_other_messages=can_send_other_messages,
can_add_web_page_previews=can_add_web_page_previews,
can_change_info=can_change_info,
can_invite_users=can_invite_users,
can_pin_messages=can_pin_messages
)
logger.warning('The parameters "can_..." are deprecated, use "permissions" instead.')
return await asyncio_helper.restrict_chat_member(
self.token, chat_id, user_id, permissions, until_date, use_independent_chat_permissions)
async def promote_chat_member(
self, chat_id: Union[int, str], user_id: int,
can_change_info: Optional[bool]=None,
can_post_messages: Optional[bool]=None,
can_edit_messages: Optional[bool]=None,
can_delete_messages: Optional[bool]=None,
can_invite_users: Optional[bool]=None,
can_restrict_members: Optional[bool]=None,
can_pin_messages: Optional[bool]=None,
can_promote_members: Optional[bool]=None,
is_anonymous: Optional[bool]=None,
can_manage_chat: Optional[bool]=None,
can_manage_video_chats: Optional[bool]=None,
can_manage_voice_chats: Optional[bool]=None,
can_manage_topics: Optional[bool]=None) -> bool:
"""
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Pass False for all boolean parameters to demote a user.
Telegram documentation: https://core.telegram.org/bots/api#promotechatmember
:param chat_id: Unique identifier for the target chat or username of the target channel (
in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:param can_change_info: Pass True, if the administrator can change chat title, photo and other settings
:type can_change_info: :obj:`bool`
:param can_post_messages: Pass True, if the administrator can create channel posts, channels only
:type can_post_messages: :obj:`bool`
:param can_edit_messages: Pass True, if the administrator can edit messages of other users, channels only
:type can_edit_messages: :obj:`bool`
:param can_delete_messages: Pass True, if the administrator can delete messages of other users
:type can_delete_messages: :obj:`bool`
:param can_invite_users: Pass True, if the administrator can invite new users to the chat
:type can_invite_users: :obj:`bool`
:param can_restrict_members: Pass True, if the administrator can restrict, ban or unban chat members
:type can_restrict_members: :obj:`bool`
:param can_pin_messages: Pass True, if the administrator can pin messages, supergroups only
:type can_pin_messages: :obj:`bool`
:param can_promote_members: Pass True, if the administrator can add new administrators with a subset
of his own privileges or demote administrators that he has promoted, directly or indirectly
(promoted by administrators that were appointed by him)
:type can_promote_members: :obj:`bool`
:param is_anonymous: Pass True, if the administrator's presence in the chat is hidden
:type is_anonymous: :obj:`bool`
:param can_manage_chat: Pass True, if the administrator can access the chat event log, chat statistics,
message statistics in channels, see channel members,
see anonymous administrators in supergroups and ignore slow mode.
Implied by any other administrator privilege
:type can_manage_chat: :obj:`bool`
:param can_manage_video_chats: Pass True, if the administrator can manage voice chats
For now, bots can use this privilege only for passing to other administrators.
:type can_manage_video_chats: :obj:`bool`
:param can_manage_voice_chats: Deprecated, use can_manage_video_chats.
:type can_manage_voice_chats: :obj:`bool`
:param can_manage_topics: Pass True if the user is allowed to create, rename, close,
and reopen forum topics, supergroups only
:type can_manage_topics: :obj:`bool`
:return: True on success.
:rtype: :obj:`bool`
"""
if can_manage_voice_chats is not None:
logger.warning('The parameter "can_manage_voice_chats" is deprecated. Use "can_manage_video_chats" instead.')
if can_manage_video_chats is None:
can_manage_video_chats = can_manage_voice_chats
return await asyncio_helper.promote_chat_member(
self.token, chat_id, user_id, can_change_info, can_post_messages,
can_edit_messages, can_delete_messages, can_invite_users,
can_restrict_members, can_pin_messages, can_promote_members,
is_anonymous, can_manage_chat, can_manage_video_chats, can_manage_topics)
async def set_chat_administrator_custom_title(
self, chat_id: Union[int, str], user_id: int, custom_title: str) -> bool:
"""
Use this method to set a custom title for an administrator in a supergroup promoted by the bot.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setchatadministratorcustomtitle
:param chat_id: Unique identifier for the target chat or username of the target supergroup
(in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int`
:param custom_title: New custom title for the administrator;
0-16 characters, emoji are not allowed
:type custom_title: :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_chat_administrator_custom_title(self.token, chat_id, user_id, custom_title)
async def ban_chat_sender_chat(self, chat_id: Union[int, str], sender_chat_id: Union[int, str]) -> bool:
"""
Use this method to ban a channel chat in a supergroup or a channel.
The owner of the chat will not be able to send messages and join live
streams on behalf of the chat, unless it is unbanned first.
The bot must be an administrator in the supergroup or channel
for this to work and must have the appropriate administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#banchatsenderchat
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param sender_chat_id: Unique identifier of the target sender chat
:type sender_chat_id: :obj:`int` or :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.ban_chat_sender_chat(self.token, chat_id, sender_chat_id)
async def unban_chat_sender_chat(self, chat_id: Union[int, str], sender_chat_id: Union[int, str]) -> bool:
"""
Use this method to unban a previously banned channel chat in a supergroup or channel.
The bot must be an administrator for this to work and must have the appropriate
administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#unbanchatsenderchat
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param sender_chat_id: Unique identifier of the target sender chat.
:type sender_chat_id: :obj:`int` or :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.unban_chat_sender_chat(self.token, chat_id, sender_chat_id)
async def set_chat_permissions(
self, chat_id: Union[int, str], permissions: types.ChatPermissions,
use_independent_chat_permissions: Optional[bool]=None) -> bool:
"""
Use this method to set default chat permissions for all members.
The bot must be an administrator in the group or a supergroup for this to work
and must have the can_restrict_members admin rights.
Telegram documentation: https://core.telegram.org/bots/api#setchatpermissions
:param chat_id: Unique identifier for the target chat or username of the target supergroup
(in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:param permissions: New default chat permissions
:type permissions: :class:`telebot.types..ChatPermissions`
:param use_independent_chat_permissions: Pass True if chat permissions are set independently. Otherwise,
the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages,
can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and
can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
:type use_independent_chat_permissions: :obj:`bool`
:return: True on success
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_chat_permissions(self.token, chat_id, permissions, use_independent_chat_permissions)
async def create_chat_invite_link(
self, chat_id: Union[int, str],
name: Optional[str]=None,
expire_date: Optional[Union[int, datetime]]=None,
member_limit: Optional[int]=None,
creates_join_request: Optional[bool]=None) -> types.ChatInviteLink:
"""
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and
must have the appropriate administrator rights.
The link can be revoked using the method revokeChatInviteLink.
Returns the new invite link as ChatInviteLink object.
Telegram documentation: https://core.telegram.org/bots/api#createchatinvitelink
:param chat_id: Id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param name: Invite link name; 0-32 characters
:type name: :obj:`str`
:param expire_date: Point in time (Unix timestamp) when the link will expire
:type expire_date: :obj:`int` or :obj:`datetime`
:param member_limit: Maximum number of users that can be members of the chat simultaneously
:type member_limit: :obj:`int`
:param creates_join_request: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified
:type creates_join_request: :obj:`bool`
:return: Returns the new invite link as ChatInviteLink object.
:rtype: :class:`telebot.types.ChatInviteLink`
"""
return types.ChatInviteLink.de_json(
await asyncio_helper.create_chat_invite_link(self.token, chat_id, name, expire_date, member_limit, creates_join_request)
)
async def edit_chat_invite_link(
self, chat_id: Union[int, str],
invite_link: Optional[str] = None,
name: Optional[str]=None,
expire_date: Optional[Union[int, datetime]]=None,
member_limit: Optional[int]=None,
creates_join_request: Optional[bool]=None) -> types.ChatInviteLink:
"""
Use this method to edit a non-primary invite link created by the bot.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Telegram documentation: https://core.telegram.org/bots/api#editchatinvitelink
:param chat_id: Id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param name: Invite link name; 0-32 characters
:type name: :obj:`str`
:param invite_link: The invite link to edit
:type invite_link: :obj:`str`
:param expire_date: Point in time (Unix timestamp) when the link will expire
:type expire_date: :obj:`int` or :obj:`datetime`
:param member_limit: Maximum number of users that can be members of the chat simultaneously
:type member_limit: :obj:`int`
:param creates_join_request: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified
:type creates_join_request: :obj:`bool`
:return: Returns the new invite link as ChatInviteLink object.
:rtype: :class:`telebot.types.ChatInviteLink`
"""
return types.ChatInviteLink.de_json(
await asyncio_helper.edit_chat_invite_link(self.token, chat_id, invite_link, name, expire_date, member_limit, creates_join_request)
)
async def revoke_chat_invite_link(
self, chat_id: Union[int, str], invite_link: str) -> types.ChatInviteLink:
"""
Use this method to revoke an invite link created by the bot.
Note: If the primary link is revoked, a new link is automatically generated The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Telegram documentation: https://core.telegram.org/bots/api#revokechatinvitelink
:param chat_id: Id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param invite_link: The invite link to revoke
:type invite_link: :obj:`str`
:return: Returns the new invite link as ChatInviteLink object.
:rtype: :class:`telebot.types.ChatInviteLink`
"""
return types.ChatInviteLink.de_json(
await asyncio_helper.revoke_chat_invite_link(self.token, chat_id, invite_link)
)
async def export_chat_invite_link(self, chat_id: Union[int, str]) -> str:
"""
Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Telegram documentation: https://core.telegram.org/bots/api#exportchatinvitelink
:param chat_id: Id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: exported invite link as String on success.
:rtype: :obj:`str`
"""
return await asyncio_helper.export_chat_invite_link(self.token, chat_id)
async def approve_chat_join_request(self, chat_id: Union[str, int], user_id: Union[int, str]) -> bool:
"""
Use this method to approve a chat join request.
The bot must be an administrator in the chat for this to work and must have
the can_invite_users administrator right. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#approvechatjoinrequest
:param chat_id: Unique identifier for the target chat or username of the target supergroup
(in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int` or :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.approve_chat_join_request(self.token, chat_id, user_id)
async def decline_chat_join_request(self, chat_id: Union[str, int], user_id: Union[int, str]) -> bool:
"""
Use this method to decline a chat join request.
The bot must be an administrator in the chat for this to work and must have
the can_invite_users administrator right. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#declinechatjoinrequest
:param chat_id: Unique identifier for the target chat or username of the target supergroup
(in the format @supergroupusername)
:type chat_id: :obj:`int` or :obj:`str`
:param user_id: Unique identifier of the target user
:type user_id: :obj:`int` or :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.decline_chat_join_request(self.token, chat_id, user_id)
async def set_chat_photo(self, chat_id: Union[int, str], photo: Any) -> bool:
"""
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’
setting is off in the target group.
Telegram documentation: https://core.telegram.org/bots/api#setchatphoto
:param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param photo: InputFile: New chat photo, uploaded using multipart/form-data
:type photo: :obj:`typing.Union[file_like, str]`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_chat_photo(self.token, chat_id, photo)
async def delete_chat_photo(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to delete a chat photo. Photos can't be changed for private chats.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.
Telegram documentation: https://core.telegram.org/bots/api#deletechatphoto
:param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_chat_photo(self.token, chat_id)
async def set_my_description(self, description: Optional[str]=None, language_code: Optional[str]=None):
"""
Use this method to change the bot's description, which is shown in
the chat with the bot if the chat is empty.
Returns True on success.
:param description: New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
:type description: :obj:`str`
:param language_code: A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for
whose language there is no dedicated description.
:type language_code: :obj:`str`
:return: True on success.
"""
return await asyncio_helper.set_my_description(self.token, description, language_code)
async def get_my_description(self, language_code: Optional[str]=None):
"""
Use this method to get the current bot description for the given user language.
Returns BotDescription on success.
:param language_code: A two-letter ISO 639-1 language code or an empty string
:type language_code: :obj:`str`
:return: :class:`telebot.types.BotDescription`
"""
result = await asyncio_helper.get_my_description(self.token, language_code)
return types.BotDescription.de_json(result)
async def set_my_short_description(self, short_description:Optional[str]=None, language_code:Optional[str]=None):
"""
Use this method to change the bot's short description, which is shown on the bot's profile page and
is sent together with the link when users share the bot.
Returns True on success.
:param short_description: New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
:type short_description: :obj:`str`
:param language_code: A two-letter ISO 639-1 language code.
If empty, the short description will be applied to all users for whose language there is no dedicated short description.
:type language_code: :obj:`str`
:return: True on success.
"""
return await asyncio_helper.set_my_short_description(self.token, short_description, language_code)
async def get_my_short_description(self, language_code: Optional[str]=None):
"""
Use this method to get the current bot short description for the given user language.
Returns BotShortDescription on success.
:param language_code: A two-letter ISO 639-1 language code or an empty string
:type language_code: :obj:`str`
:return: :class:`telebot.types.BotShortDescription`
"""
result = await asyncio_helper.get_my_short_description(self.token, language_code)
return types.BotShortDescription.de_json(result)
async def get_my_commands(self, scope: Optional[types.BotCommandScope],
language_code: Optional[str]) -> List[types.BotCommand]:
"""
Use this method to get the current list of the bot's commands.
Returns List of BotCommand on success.
Telegram documentation: https://core.telegram.org/bots/api#getmycommands
:param scope: The scope of users for which the commands are relevant.
Defaults to BotCommandScopeDefault.
:type scope: :class:`telebot.types.BotCommandScope`
:param language_code: A two-letter ISO 639-1 language code. If empty,
commands will be applied to all users from the given scope,
for whose language there are no dedicated commands
:type language_code: :obj:`str`
:return: List of BotCommand on success.
:rtype: :obj:`list` of :class:`telebot.types.BotCommand`
"""
result = await asyncio_helper.get_my_commands(self.token, scope, language_code)
return [types.BotCommand.de_json(cmd) for cmd in result]
async def set_my_name(self, name: Optional[str]=None, language_code: Optional[str]=None):
"""
Use this method to change the bot's name. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setmyname
:param name: Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.
:type name: :obj:`str`
:param language_code: Optional. A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose
language there is no dedicated name.
:type language_code: :obj:`str`
:return: True on success.
"""
return await asyncio_helper.set_my_name(self.token, name, language_code)
async def get_my_name(self, language_code: Optional[str]=None):
"""
Use this method to get the current bot name for the given user language.
Returns BotName on success.
Telegram documentation: https://core.telegram.org/bots/api#getmyname
:param language_code: Optional. A two-letter ISO 639-1 language code or an empty string
:type language_code: :obj:`str`
:return: :class:`telebot.types.BotName`
"""
result = await asyncio_helper.get_my_name(self.token, language_code)
return types.BotName.de_json(result)
async def set_chat_menu_button(self, chat_id: Union[int, str]=None,
menu_button: types.MenuButton=None) -> bool:
"""
Use this method to change the bot's menu button in a private chat,
or the default menu button.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setchatmenubutton
:param chat_id: Unique identifier for the target private chat.
If not specified, default bot's menu button will be changed.
:type chat_id: :obj:`int` or :obj:`str`
:param menu_button: A JSON-serialized object for the new bot's menu button. Defaults to MenuButtonDefault
:type menu_button: :class:`telebot.types.MenuButton`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_chat_menu_button(self.token, chat_id, menu_button)
async def get_chat_menu_button(self, chat_id: Union[int, str]=None) -> types.MenuButton:
"""
Use this method to get the current value of the bot's menu button
in a private chat, or the default menu button.
Returns MenuButton on success.
Telegram Documentation: https://core.telegram.org/bots/api#getchatmenubutton
:param chat_id: Unique identifier for the target private chat.
If not specified, default bot's menu button will be returned.
:type chat_id: :obj:`int` or :obj:`str`
:return: types.MenuButton
:rtype: :class:`telebot.types.MenuButton`
"""
return types.MenuButton.de_json(await asyncio_helper.get_chat_menu_button(self.token, chat_id))
async def set_my_default_administrator_rights(self, rights: types.ChatAdministratorRights=None,
for_channels: bool=None) -> bool:
"""
Use this method to change the default administrator rights requested by the bot
when it's added as an administrator to groups or channels.
These rights will be suggested to users, but they are are free to modify
the list before adding the bot.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setmydefaultadministratorrights
:param rights: A JSON-serialized object describing new default administrator rights. If not specified,
the default administrator rights will be cleared.
:type rights: :class:`telebot.types.ChatAdministratorRights`
:param for_channels: Pass True to change the default administrator rights of the bot in channels.
Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
:type for_channels: :obj:`bool`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_my_default_administrator_rights(self.token, rights, for_channels)
async def get_my_default_administrator_rights(self, for_channels: bool=None) -> types.ChatAdministratorRights:
"""
Use this method to get the current default administrator rights of the bot.
Returns ChatAdministratorRights on success.
Telegram documentation: https://core.telegram.org/bots/api#getmydefaultadministratorrights
:param for_channels: Pass True to get the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be returned.
:type for_channels: :obj:`bool`
:return: Returns ChatAdministratorRights on success.
:rtype: :class:`telebot.types.ChatAdministratorRights`
"""
return types.ChatAdministratorRights.de_json(await asyncio_helper.get_my_default_administrator_rights(self.token, for_channels))
async def set_my_commands(self, commands: List[types.BotCommand],
scope: Optional[types.BotCommandScope]=None,
language_code: Optional[str]=None) -> bool:
"""
Use this method to change the list of the bot's commands.
Telegram documentation: https://core.telegram.org/bots/api#setmycommands
:param commands: List of BotCommand. At most 100 commands can be specified.
:type commands: :obj:`list` of :class:`telebot.types.BotCommand`
:param scope: The scope of users for which the commands are relevant.
Defaults to BotCommandScopeDefault.
:type scope: :class:`telebot.types.BotCommandScope`
:param language_code: A two-letter ISO 639-1 language code. If empty,
commands will be applied to all users from the given scope,
for whose language there are no dedicated commands
:type language_code: :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_my_commands(self.token, commands, scope, language_code)
async def delete_my_commands(self, scope: Optional[types.BotCommandScope]=None,
language_code: Optional[int]=None) -> bool:
"""
Use this method to delete the list of the bot's commands for the given scope and user language.
After deletion, higher level commands will be shown to affected users.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#deletemycommands
:param scope: The scope of users for which the commands are relevant.
Defaults to BotCommandScopeDefault.
:type scope: :class:`telebot.types.BotCommandScope`
:param language_code: A two-letter ISO 639-1 language code. If empty,
commands will be applied to all users from the given scope,
for whose language there are no dedicated commands
:type language_code: :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_my_commands(self.token, scope, language_code)
async def set_chat_title(self, chat_id: Union[int, str], title: str) -> bool:
"""
Use this method to change the title of a chat. Titles can't be changed for private chats.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’
setting is off in the target group.
Telegram documentation: https://core.telegram.org/bots/api#setchattitle
:param chat_id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param title: New chat title, 1-255 characters
:type title: :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_chat_title(self.token, chat_id, title)
async def set_chat_description(self, chat_id: Union[int, str], description: Optional[str]=None) -> bool:
"""
Use this method to change the description of a supergroup or a channel.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Telegram documentation: https://core.telegram.org/bots/api#setchatdescription
:param chat_id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param description: Str: New chat description, 0-255 characters
:type description: :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_chat_description(self.token, chat_id, description)
async def pin_chat_message(
self, chat_id: Union[int, str], message_id: int,
disable_notification: Optional[bool]=False) -> bool:
"""
Use this method to pin a message in a supergroup.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#pinchatmessage
:param chat_id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Identifier of a message to pin
:type message_id: :obj:`int`
:param disable_notification: Pass True, if it is not necessary to send a notification
to all group members about the new pinned message
:type disable_notification: :obj:`bool`
:return: True on success.
:rtype: :obj:`bool`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
return await asyncio_helper.pin_chat_message(self.token, chat_id, message_id, disable_notification)
async def unpin_chat_message(self, chat_id: Union[int, str], message_id: Optional[int]=None) -> bool:
"""
Use this method to unpin specific pinned message in a supergroup chat.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#unpinchatmessage
:param chat_id: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Int: Identifier of a message to unpin
:type message_id: :obj:`int`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.unpin_chat_message(self.token, chat_id, message_id)
async def unpin_all_chat_messages(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to unpin a all pinned messages in a supergroup chat.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#unpinallchatmessages
:param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:return: True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.unpin_all_chat_messages(self.token, chat_id)
async def edit_message_text(
self, text: str,
chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
parse_mode: Optional[str]=None,
entities: Optional[List[types.MessageEntity]]=None,
disable_web_page_preview: Optional[bool]=None,
reply_markup: Optional[types.InlineKeyboardMarkup]=None) -> Union[types.Message, bool]:
"""
Use this method to edit text and game messages.
Telegram documentation: https://core.telegram.org/bots/api#editmessagetext
:param text: New text of the message, 1-4096 characters after entities parsing
:type text: :obj:`str`
:param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the sent message
:type message_id: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message
:type inline_message_id: :obj:`str`
:param parse_mode: Mode for parsing entities in the message text.
:type parse_mode: :obj:`str`
:param entities: List of special entities that appear in the message text, which can be specified instead of parse_mode
:type entities: List of :obj:`telebot.types.MessageEntity`
:param disable_web_page_preview: Disables link previews for links in this message
:type disable_web_page_preview: :obj:`bool`
:param reply_markup: A JSON-serialized object for an inline keyboard.
:type reply_markup: :obj:`InlineKeyboardMarkup`
:return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
:rtype: :obj:`types.Message` or :obj:`bool`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
disable_web_page_preview = self.disable_web_page_preview if (disable_web_page_preview is None) else disable_web_page_preview
result = await asyncio_helper.edit_message_text(self.token, text, chat_id, message_id, inline_message_id, parse_mode,
entities, disable_web_page_preview, reply_markup)
if type(result) == bool: # if edit inline message return is bool not Message.
return result
return types.Message.de_json(result)
async def edit_message_media(
self, media: Any, chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
reply_markup: Optional[types.InlineKeyboardMarkup]=None) -> Union[types.Message, bool]:
"""
Use this method to edit animation, audio, document, photo, or video messages.
If a message is a part of a message album, then it can be edited only to a photo or a video.
Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded.
Use previously uploaded file via its file_id or specify a URL.
Telegram documentation: https://core.telegram.org/bots/api#editmessagemedia
:param media: A JSON-serialized object for a new media content of the message
:type media: :obj:`InputMedia`
:param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the sent message
:type message_id: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message
:type inline_message_id: :obj:`str`
:param reply_markup: A JSON-serialized object for an inline keyboard.
:type reply_markup: :obj:`telebot.types.InlineKeyboardMarkup` or :obj:`ReplyKeyboardMarkup` or :obj:`ReplyKeyboardRemove` or :obj:`ForceReply`
:return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
:rtype: :obj:`types.Message` or :obj:`bool`
"""
result = await asyncio_helper.edit_message_media(self.token, media, chat_id, message_id, inline_message_id, reply_markup)
if type(result) == bool: # if edit inline message return is bool not Message.
return result
return types.Message.de_json(result)
async def edit_message_reply_markup(
self, chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
reply_markup: Optional[types.InlineKeyboardMarkup]=None) -> Union[types.Message, bool]:
"""
Use this method to edit only the reply markup of messages.
Telegram documentation: https://core.telegram.org/bots/api#editmessagereplymarkup
:param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the sent message
:type message_id: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message
:type inline_message_id: :obj:`str`
:param reply_markup: A JSON-serialized object for an inline keyboard.
:type reply_markup: :obj:`InlineKeyboardMarkup` or :obj:`ReplyKeyboardMarkup` or :obj:`ReplyKeyboardRemove` or :obj:`ForceReply`
:return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
:rtype: :obj:`types.Message` or :obj:`bool`
"""
result = await asyncio_helper.edit_message_reply_markup(self.token, chat_id, message_id, inline_message_id, reply_markup)
if type(result) == bool:
return result
return types.Message.de_json(result)
async def send_game(
self, chat_id: Union[int, str], game_short_name: str,
disable_notification: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Used to send the game.
Telegram documentation: https://core.telegram.org/bots/api#sendgame
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
:type game_short_name: :obj:`str`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
:type reply_markup: :obj:`InlineKeyboardMarkup` or :obj:`ReplyKeyboardMarkup` or :obj:`ReplyKeyboardRemove` or :obj:`ForceReply`
:param timeout: Timeout in seconds for waiting for a response from the bot.
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if one of the specified replied-to messages is not found.
:type allow_sending_without_reply: :obj:`bool`
:param protect_content: Pass True, if content of the message needs to be protected from being viewed by the bot.
:type protect_content: :obj:`bool`
:param message_thread_id: Identifier of the thread to which the message will be sent.
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :obj:`types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
result = await asyncio_helper.send_game(
self.token, chat_id, game_short_name, disable_notification,
reply_to_message_id, reply_markup, timeout,
allow_sending_without_reply, protect_content, message_thread_id)
return types.Message.de_json(result)
async def set_game_score(
self, user_id: Union[int, str], score: int,
force: Optional[bool]=None,
chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
disable_edit_message: Optional[bool]=None) -> Union[types.Message, bool]:
"""
Sets the value of points in the game to a specific user.
Telegram documentation: https://core.telegram.org/bots/api#setgamescore
:param user_id: User identifier
:type user_id: :obj:`int` or :obj:`str`
:param score: New score, must be non-negative
:type score: :obj:`int`
:param force: Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters
:type force: :obj:`bool`
:param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the sent message
:type message_id: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message
:type inline_message_id: :obj:`str`
:param disable_edit_message: Pass True, if the game message should not be automatically edited to include the current scoreboard
:type disable_edit_message: :obj:`bool`
:return: On success, if the message was sent by the bot, returns the edited Message, otherwise returns True.
:rtype: :obj:`types.Message` or :obj:`bool`
"""
result = await asyncio_helper.set_game_score(self.token, user_id, score, force, disable_edit_message, chat_id,
message_id, inline_message_id)
if type(result) == bool:
return result
return types.Message.de_json(result)
async def get_game_high_scores(
self, user_id: int, chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None) -> List[types.GameHighScore]:
"""
Use this method to get data for high score tables. Will return the score of the specified user and several of
their neighbors in a game. On success, returns an Array of GameHighScore objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side.
Will also return the top three users if the user and their neighbors are not among them.
Please note that this behavior is subject to change.
Telegram documentation: https://core.telegram.org/bots/api#getgamehighscores
:param user_id: User identifier
:type user_id: :obj:`int`
:param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_id: Required if inline_message_id is not specified. Identifier of the sent message
:type message_id: :obj:`int`
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message
:type inline_message_id: :obj:`str`
:return: On success, returns an Array of GameHighScore objects.
:rtype: List[types.GameHighScore]
"""
result = await asyncio_helper.get_game_high_scores(self.token, user_id, chat_id, message_id, inline_message_id)
return [types.GameHighScore.de_json(r) for r in result]
async def send_invoice(
self, chat_id: Union[int, str], title: str, description: str,
invoice_payload: str, provider_token: str, currency: str,
prices: List[types.LabeledPrice], start_parameter: Optional[str]=None,
photo_url: Optional[str]=None, photo_size: Optional[int]=None,
photo_width: Optional[int]=None, photo_height: Optional[int]=None,
need_name: Optional[bool]=None, need_phone_number: Optional[bool]=None,
need_email: Optional[bool]=None, need_shipping_address: Optional[bool]=None,
send_phone_number_to_provider: Optional[bool]=None,
send_email_to_provider: Optional[bool]=None,
is_flexible: Optional[bool]=None,
disable_notification: Optional[bool]=None,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
provider_data: Optional[str]=None,
timeout: Optional[int]=None,
allow_sending_without_reply: Optional[bool]=None,
max_tip_amount: Optional[int] = None,
suggested_tip_amounts: Optional[List[int]]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Sends invoice.
Telegram documentation: https://core.telegram.org/bots/api#sendinvoice
:param chat_id: Unique identifier for the target private chat
:type chat_id: :obj:`int` or :obj:`str`
:param title: Product name, 1-32 characters
:type title: :obj:`str`
:param description: Product description, 1-255 characters
:type description: :obj:`str`
:param invoice_payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user,
use for your internal processes.
:type invoice_payload: :obj:`str`
:param provider_token: Payments provider token, obtained via @Botfather
:type provider_token: :obj:`str`
:param currency: Three-letter ISO 4217 currency code,
see https://core.telegram.org/bots/payments#supported-currencies
:type currency: :obj:`str`
:param prices: Price breakdown, a list of components
(e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
:type prices: List[:obj:`types.LabeledPrice`]
:param start_parameter: Unique deep-linking parameter that can be used to generate this invoice
when used as a start parameter
:type start_parameter: :obj:`str`
:param photo_url: URL of the product photo for the invoice. Can be a photo of the goods
or a marketing image for a service. People like it better when they see what they are paying for.
:type photo_url: :obj:`str`
:param photo_size: Photo size in bytes
:type photo_size: :obj:`int`
:param photo_width: Photo width
:type photo_width: :obj:`int`
:param photo_height: Photo height
:type photo_height: :obj:`int`
:param need_name: Pass True, if you require the user's full name to complete the order
:type need_name: :obj:`bool`
:param need_phone_number: Pass True, if you require the user's phone number to complete the order
:type need_phone_number: :obj:`bool`
:param need_email: Pass True, if you require the user's email to complete the order
:type need_email: :obj:`bool`
:param need_shipping_address: Pass True, if you require the user's shipping address to complete the order
:type need_shipping_address: :obj:`bool`
:param is_flexible: Pass True, if the final price depends on the shipping method
:type is_flexible: :obj:`bool`
:param send_phone_number_to_provider: Pass True, if user's phone number should be sent to provider
:type send_phone_number_to_provider: :obj:`bool`
:param send_email_to_provider: Pass True, if user's email address should be sent to provider
:type send_email_to_provider: :obj:`bool`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty,
one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button
:type reply_markup: :obj:`str`
:param provider_data: A JSON-serialized data about the invoice, which will be shared with the payment provider.
A detailed description of required fields should be provided by the payment provider.
:type provider_data: :obj:`str`
:param timeout: Timeout of a request, defaults to None
:type timeout: :obj:`int`
:param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency
:type max_tip_amount: :obj:`int`
:param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest
units of the currency. At most 4 suggested tip amounts can be specified. The suggested tip
amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
:type suggested_tip_amounts: :obj:`list` of :obj:`int`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: The identifier of a message thread, in which the invoice message will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :obj:`types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
result = await asyncio_helper.send_invoice(
self.token, chat_id, title, description, invoice_payload, provider_token,
currency, prices, start_parameter, photo_url, photo_size, photo_width,
photo_height, need_name, need_phone_number, need_email, need_shipping_address,
send_phone_number_to_provider, send_email_to_provider, is_flexible, disable_notification,
reply_to_message_id, reply_markup, provider_data, timeout, allow_sending_without_reply,
max_tip_amount, suggested_tip_amounts, protect_content, message_thread_id)
return types.Message.de_json(result)
async def create_invoice_link(self,
title: str, description: str, payload:str, provider_token: str,
currency: str, prices: List[types.LabeledPrice],
max_tip_amount: Optional[int] = None,
suggested_tip_amounts: Optional[List[int]]=None,
provider_data: Optional[str]=None,
photo_url: Optional[str]=None,
photo_size: Optional[int]=None,
photo_width: Optional[int]=None,
photo_height: Optional[int]=None,
need_name: Optional[bool]=None,
need_phone_number: Optional[bool]=None,
need_email: Optional[bool]=None,
need_shipping_address: Optional[bool]=None,
send_phone_number_to_provider: Optional[bool]=None,
send_email_to_provider: Optional[bool]=None,
is_flexible: Optional[bool]=None) -> str:
"""
Use this method to create a link for an invoice.
Returns the created invoice link as String on success.
Telegram documentation:
https://core.telegram.org/bots/api#createinvoicelink
:param title: Product name, 1-32 characters
:type title: :obj:`str`
:param description: Product description, 1-255 characters
:type description: :obj:`str`
:param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user,
use for your internal processes.
:type payload: :obj:`str`
:param provider_token: Payments provider token, obtained via @Botfather
:type provider_token: :obj:`str`
:param currency: Three-letter ISO 4217 currency code,
see https://core.telegram.org/bots/payments#supported-currencies
:type currency: :obj:`str`
:param prices: Price breakdown, a list of components
(e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
:type prices: :obj:`list` of :obj:`types.LabeledPrice`
:param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency
:type max_tip_amount: :obj:`int`
:param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest
units of the currency. At most 4 suggested tip amounts can be specified. The suggested tip
amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
:type suggested_tip_amounts: :obj:`list` of :obj:`int`
:param provider_data: A JSON-serialized data about the invoice, which will be shared with the payment provider.
A detailed description of required fields should be provided by the payment provider.
:type provider_data: :obj:`str`
:param photo_url: URL of the product photo for the invoice. Can be a photo of the goods
or a photo of the invoice. People like it better when they see a photo of what they are paying for.
:type photo_url: :obj:`str`
:param photo_size: Photo size in bytes
:type photo_size: :obj:`int`
:param photo_width: Photo width
:type photo_width: :obj:`int`
:param photo_height: Photo height
:type photo_height: :obj:`int`
:param need_name: Pass True, if you require the user's full name to complete the order
:type need_name: :obj:`bool`
:param need_phone_number: Pass True, if you require the user's phone number to complete the order
:type need_phone_number: :obj:`bool`
:param need_email: Pass True, if you require the user's email to complete the order
:type need_email: :obj:`bool`
:param need_shipping_address: Pass True, if you require the user's shipping address to complete the order
:type need_shipping_address: :obj:`bool`
:param send_phone_number_to_provider: Pass True, if user's phone number should be sent to provider
:type send_phone_number_to_provider: :obj:`bool`
:param send_email_to_provider: Pass True, if user's email address should be sent to provider
:type send_email_to_provider: :obj:`bool`
:param is_flexible: Pass True, if the final price depends on the shipping method
:type is_flexible: :obj:`bool`
:return: Created invoice link as String on success.
:rtype: :obj:`str`
"""
result = await asyncio_helper.create_invoice_link(
self.token, title, description, payload, provider_token,
currency, prices, max_tip_amount, suggested_tip_amounts, provider_data,
photo_url, photo_size, photo_width, photo_height, need_name, need_phone_number,
need_email, need_shipping_address, send_phone_number_to_provider,
send_email_to_provider, is_flexible)
return result
# noinspection PyShadowingBuiltins
async def send_poll(
self, chat_id: Union[int, str], question: str, options: List[str],
is_anonymous: Optional[bool]=None, type: Optional[str]=None,
allows_multiple_answers: Optional[bool]=None,
correct_option_id: Optional[int]=None,
explanation: Optional[str]=None,
explanation_parse_mode: Optional[str]=None,
open_period: Optional[int]=None,
close_date: Optional[Union[int, datetime]]=None,
is_closed: Optional[bool]=None,
disable_notification: Optional[bool]=False,
reply_to_message_id: Optional[int]=None,
reply_markup: Optional[REPLY_MARKUP_TYPES]=None,
allow_sending_without_reply: Optional[bool]=None,
timeout: Optional[int]=None,
explanation_entities: Optional[List[types.MessageEntity]]=None,
protect_content: Optional[bool]=None,
message_thread_id: Optional[int]=None) -> types.Message:
"""
Use this method to send a native poll.
On success, the sent Message is returned.
Telegram documentation: https://core.telegram.org/bots/api#sendpoll
:param chat_id: Unique identifier for the target chat or username of the target channel
:type chat_id: :obj:`int` | :obj:`str`
:param question: Poll question, 1-300 characters
:type question: :obj:`str`
:param options: A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
:type options: :obj:`list` of :obj:`str`
:param is_anonymous: True, if the poll needs to be anonymous, defaults to True
:type is_anonymous: :obj:`bool`
:param type: Poll type, “quiz” or “regular”, defaults to “regular”
:type type: :obj:`str`
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
:type allows_multiple_answers: :obj:`bool`
:param correct_option_id: 0-based identifier of the correct answer option. Available only for polls in quiz mode,
defaults to None
:type correct_option_id: :obj:`int`
:param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll,
0-200 characters with at most 2 line feeds after entities parsing
:type explanation: :obj:`str`
:param explanation_parse_mode: Mode for parsing entities in the explanation. See formatting options for more details.
:type explanation_parse_mode: :obj:`str`
:param open_period: Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
:type open_period: :obj:`int`
:param close_date: Point in time (Unix timestamp) when the poll will be automatically closed.
:type close_date: :obj:`int` | :obj:`datetime`
:param is_closed: Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.
:type is_closed: :obj:`bool`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param reply_to_message_id: If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param allow_sending_without_reply: Pass True, if the poll allows multiple options to be voted simultaneously.
:type allow_sending_without_reply: :obj:`bool`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard,
instructions to remove reply keyboard or to force a reply from the user.
:type reply_markup: :obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply`
:param timeout: Timeout in seconds for waiting for a response from the user.
:type timeout: :obj:`int`
:param explanation_entities: A JSON-serialized list of special entities that appear in the explanation,
which can be specified instead of parse_mode
:type explanation_entities: :obj:`list` of :obj:`MessageEntity`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param message_thread_id: The identifier of a message thread, in which the poll will be sent
:type message_thread_id: :obj:`int`
:return: On success, the sent Message is returned.
:rtype: :obj:`types.Message`
"""
disable_notification = self.disable_notification if (disable_notification is None) else disable_notification
protect_content = self.protect_content if (protect_content is None) else protect_content
allow_sending_without_reply = self.allow_sending_without_reply if (allow_sending_without_reply is None) else allow_sending_without_reply
explanation_parse_mode = self.parse_mode if (explanation_parse_mode is None) else explanation_parse_mode
if isinstance(question, types.Poll):
raise RuntimeError("The send_poll signature was changed, please see send_poll function details.")
return types.Message.de_json(
await asyncio_helper.send_poll(
self.token, chat_id,
question, options,
is_anonymous, type, allows_multiple_answers, correct_option_id,
explanation, explanation_parse_mode, open_period, close_date, is_closed,
disable_notification, reply_to_message_id, allow_sending_without_reply,
reply_markup, timeout, explanation_entities, protect_content, message_thread_id))
async def stop_poll(
self, chat_id: Union[int, str], message_id: int,
reply_markup: Optional[types.InlineKeyboardMarkup]=None) -> types.Poll:
"""
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
Telegram documentation: https://core.telegram.org/bots/api#stoppoll
:param chat_id: Unique identifier for the target chat or username of the target channel
:type chat_id: :obj:`int` | :obj:`str`
:param message_id: Identifier of the original message with the poll
:type message_id: :obj:`int`
:param reply_markup: A JSON-serialized object for a new message markup.
:type reply_markup: :obj:`InlineKeyboardMarkup`
:return: On success, the stopped Poll is returned.
:rtype: :obj:`types.Poll`
"""
return types.Poll.de_json(await asyncio_helper.stop_poll(self.token, chat_id, message_id, reply_markup))
async def answer_shipping_query(
self, shipping_query_id: str, ok: bool,
shipping_options: Optional[List[types.ShippingOption]]=None,
error_message: Optional[str]=None) -> bool:
"""
Asks for an answer to a shipping question.
Telegram documentation: https://core.telegram.org/bots/api#answershippingquery
:param shipping_query_id: Unique identifier for the query to be answered
:type shipping_query_id: :obj:`str`
:param ok: Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
:type ok: :obj:`bool`
:param shipping_options: Required if ok is True. A JSON-serialized array of available shipping options.
:type shipping_options: :obj:`list` of :obj:`ShippingOption`
:param error_message: Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order
(e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.
:type error_message: :obj:`str`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.answer_shipping_query(self.token, shipping_query_id, ok, shipping_options, error_message)
async def answer_pre_checkout_query(
self, pre_checkout_query_id: int, ok: bool,
error_message: Optional[str]=None) -> bool:
"""
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the
field pre_checkout_query. Use this method to respond to such pre-checkout queries.
On success, True is returned.
.. note::
The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
Telegram documentation: https://core.telegram.org/bots/api#answerprecheckoutquery
:param pre_checkout_query_id: Unique identifier for the query to be answered
:type pre_checkout_query_id: :obj:`int`
:param ok: Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
:type ok: :obj:`bool`
:param error_message: Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout
(e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different
color or garment!"). Telegram will display this message to the user.
:type error_message: :obj:`str`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.answer_pre_checkout_query(self.token, pre_checkout_query_id, ok, error_message)
async def edit_message_caption(
self, caption: str, chat_id: Optional[Union[int, str]]=None,
message_id: Optional[int]=None,
inline_message_id: Optional[str]=None,
parse_mode: Optional[str]=None,
caption_entities: Optional[List[types.MessageEntity]]=None,
reply_markup: Optional[types.InlineKeyboardMarkup]=None) -> Union[types.Message, bool]:
"""
Use this method to edit captions of messages.
Telegram documentation: https://core.telegram.org/bots/api#editmessagecaption
:param caption: New caption of the message
:type caption: :obj:`str`
:param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel
:type chat_id: :obj:`int` | :obj:`str`
:param message_id: Required if inline_message_id is not specified.
:type message_id: :obj:`int`
:param inline_message_id: Required if inline_message_id is not specified. Identifier of the inline message.
:type inline_message_id: :obj:`str`
:param parse_mode: New caption of the message, 0-1024 characters after entities parsing
:type parse_mode: :obj:`str`
:param caption_entities: A JSON-serialized array of objects that describe how the caption should be parsed.
:type caption_entities: :obj:`list` of :obj:`types.MessageEntity`
:param reply_markup: A JSON-serialized object for an inline keyboard.
:type reply_markup: :obj:`InlineKeyboardMarkup`
:return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
:rtype: :obj:`types.Message` | :obj:`bool`
"""
parse_mode = self.parse_mode if (parse_mode is None) else parse_mode
result = await asyncio_helper.edit_message_caption(self.token, caption, chat_id, message_id, inline_message_id,
parse_mode, caption_entities, reply_markup)
if type(result) == bool:
return result
return types.Message.de_json(result)
async def reply_to(self, message: types.Message, text: str, **kwargs) -> types.Message:
"""
Convenience function for `send_message(message.chat.id, text, reply_to_message_id=message.message_id, **kwargs)`
:param message: Instance of :class:`telebot.types.Message`
:type message: :obj:`types.Message`
:param text: Text of the message.
:type text: :obj:`str`
:param kwargs: Additional keyword arguments which are passed to :meth:`telebot.TeleBot.send_message`
:return: On success, the sent Message is returned.
:rtype: :class:`telebot.types.Message`
"""
return await self.send_message(message.chat.id, text, reply_to_message_id=message.message_id, **kwargs)
async def answer_inline_query(
self, inline_query_id: str,
results: List[Any],
cache_time: Optional[int]=None,
is_personal: Optional[bool]=None,
next_offset: Optional[str]=None,
switch_pm_text: Optional[str]=None,
switch_pm_parameter: Optional[str]=None,
button: Optional[types.InlineQueryResultsButton]=None) -> bool:
"""
Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
Telegram documentation: https://core.telegram.org/bots/api#answerinlinequery
:param inline_query_id: Unique identifier for the answered query
:type inline_query_id: :obj:`str`
:param results: Array of results for the inline query
:type results: :obj:`list` of :obj:`types.InlineQueryResult`
:param cache_time: The maximum amount of time in seconds that the result of the inline query
may be cached on the server.
:type cache_time: :obj:`int`
:param is_personal: Pass True, if results may be cached on the server side only for
the user that sent the query.
:type is_personal: :obj:`bool`
:param next_offset: Pass the offset that a client should send in the next query with the same text
to receive more results.
:type next_offset: :obj:`str`
:param switch_pm_parameter: Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters,
only A-Z, a-z, 0-9, _ and - are allowed.
Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly.
To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a
private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline
button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.
:type switch_pm_parameter: :obj:`str`
:param switch_pm_text: Parameter for the start message sent to the bot when user presses the switch button
:type switch_pm_text: :obj:`str`
:param button: A JSON-serialized object describing a button to be shown above inline query results
:type button: :obj:`types.InlineQueryResultsButton`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
if not button and (switch_pm_text or switch_pm_parameter):
logger.warning("switch_pm_text and switch_pm_parameter are deprecated for answer_inline_query. Use button instead.")
button = types.InlineQueryResultsButton(text=switch_pm_text, start_parameter=switch_pm_parameter)
return await asyncio_helper.answer_inline_query(self.token, inline_query_id, results, cache_time, is_personal, next_offset,
button)
async def answer_callback_query(
self, callback_query_id: int,
text: Optional[str]=None, show_alert: Optional[bool]=None,
url: Optional[str]=None, cache_time: Optional[int]=None) -> bool:
"""
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to
the user as a notification at the top of the chat screen or as an alert.
Telegram documentation: https://core.telegram.org/bots/api#answercallbackquery
:param callback_query_id: Unique identifier for the query to be answered
:type callback_query_id: :obj:`int`
:param text: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
:type text: :obj:`str`
:param show_alert: If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
:type show_alert: :obj:`bool`
:param url: URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your
game - note that this will only work if the query comes from a callback_game button.
:type url: :obj:`str`
:param cache_time: The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching
starting in version 3.14. Defaults to 0.
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.answer_callback_query(self.token, callback_query_id, text, show_alert, url, cache_time)
async def set_sticker_set_thumbnail(self, name: str, user_id: int, thumbnail: Union[Any, str]=None):
"""
Use this method to set the thumbnail of a sticker set.
Animated thumbnails can be set for animated sticker sets only. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setstickersetthumb
:param name: Sticker set name
:type name: :obj:`str`
:param user_id: User identifier
:type user_id: :obj:`int`
:param thumbnail: A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
:type thumbnail: :obj:`filelike object`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_sticker_set_thumbnail(self.token, name, user_id, thumbnail)
@util.deprecated(deprecation_text="Use set_sticker_set_thumbnail instead")
async def set_sticker_set_thumb(self, name: str, user_id: int, thumb: Union[Any, str]=None):
"""
Use this method to set the thumbnail of a sticker set.
Animated thumbnails can be set for animated sticker sets only. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setstickersetthumb
:param name: Sticker set name
:type name: :obj:`str`
:param user_id: User identifier
:type user_id: :obj:`int`
:param thumb:
:type thumb: :obj:`filelike object`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
# deprecated
return await self.set_sticker_set_thumbnail(name, user_id, thumb)
async def get_sticker_set(self, name: str) -> types.StickerSet:
"""
Use this method to get a sticker set. On success, a StickerSet object is returned.
Telegram documentation: https://core.telegram.org/bots/api#getstickerset
:param name: Sticker set name
:type name: :obj:`str`
:return: On success, a StickerSet object is returned.
:rtype: :class:`telebot.types.StickerSet`
"""
result = await asyncio_helper.get_sticker_set(self.token, name)
return types.StickerSet.de_json(result)
async def set_sticker_keywords(self, sticker: str, keywords: List[str]=None) -> bool:
"""
Use this method to change search keywords assigned to a regular or custom emoji sticker.
The sticker must belong to a sticker set created by the bot.
Returns True on success.
:param sticker: File identifier of the sticker.
:type sticker: :obj:`str`
:param keywords: A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters
:type keywords: :obj:`list` of :obj:`str`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_sticker_keywords(self.token, sticker, keywords)
async def set_sticker_mask_position(self, sticker: str, mask_position: types.MaskPosition=None) -> bool:
"""
Use this method to change the mask position of a mask sticker.
The sticker must belong to a sticker set that was created by the bot.
Returns True on success.
:param sticker: File identifier of the sticker.
:type sticker: :obj:`str`
:param mask_position: A JSON-serialized object for position where the mask should be placed on faces.
:type mask_position: :class:`telebot.types.MaskPosition`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_sticker_mask_position(self.token, sticker, mask_position)
async def get_custom_emoji_stickers(self, custom_emoji_ids: List[str]) -> List[types.Sticker]:
"""
Use this method to get information about custom emoji stickers by their identifiers.
Returns an Array of Sticker objects.
:param custom_emoji_ids: List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.
:type custom_emoji_ids: :obj:`list` of :obj:`str`
:return: Returns an Array of Sticker objects.
:rtype: :obj:`list` of :class:`telebot.types.Sticker`
"""
result = await asyncio_helper.get_custom_emoji_stickers(self.token, custom_emoji_ids)
return [types.Sticker.de_json(sticker) for sticker in result]
async def upload_sticker_file(self, user_id: int, png_sticker: Union[Any, str]=None, sticker: Optional[types.InputFile]=None, sticker_format: Optional[str]=None) -> types.File:
"""
Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet
methods (can be used multiple times). Returns the uploaded File on success.
Telegram documentation: https://core.telegram.org/bots/api#uploadstickerfile
:param user_id: User identifier of sticker set owner
:type user_id: :obj:`int`
:param png_sticker: DEPRECATED: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px,
and either width or height must be exactly 512px.
:type png_sticker: :obj:`filelike object`
:param sticker: A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format.
See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »
:type sticker: :class:`telebot.types.InputFile`
:param sticker_format: One of "static", "animated", "video".
:type sticker_format: :obj:`str`
:return: On success, the sent file is returned.
:rtype: :class:`telebot.types.File`
"""
if png_sticker:
logger.warning('The parameter "png_sticker" is deprecated. Use "sticker" instead.')
sticker = png_sticker
sticker_format = "static"
result = await asyncio_helper.upload_sticker_file(self.token, user_id, sticker, sticker_format)
return types.File.de_json(result)
async def set_custom_emoji_sticker_set_thumbnail(self, name: str, custom_emoji_id: Optional[str]=None) -> bool:
"""
Use this method to set the thumbnail of a custom emoji sticker set.
Returns True on success.
:param name: Sticker set name
:type name: :obj:`str`
:param custom_emoji_id: Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.
:type custom_emoji_id: :obj:`str`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_custom_emoji_sticker_set_thumbnail(self.token, name, custom_emoji_id)
async def set_sticker_set_title(self, name: str, title: str) -> bool:
"""
Use this method to set the title of a created sticker set.
Returns True on success.
:param name: Sticker set name
:type name: :obj:`str`
:param title: New sticker set title
:type title: :obj:`str`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_sticker_set_title(self.token, name, title)
async def delete_sticker_set(self, name:str) -> bool:
"""
Use this method to delete a sticker set. Returns True on success.
:param name: Sticker set name
:type name: :obj:`str`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_sticker_set(self.token, name)
async def set_sticker_emoji_list(self, name: str, emoji_list: List[str]) -> bool:
"""
Use this method to set the emoji list of a sticker set.
Returns True on success.
:param name: Sticker set name
:type name: :obj:`str`
:param emoji_list: List of emojis
:type emoji_list: :obj:`list` of :obj:`str`
:return: Returns True on success.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_sticker_emoji_list(self.token, name, emoji_list)
async def create_new_sticker_set(
self, user_id: int, name: str, title: str,
emojis: Optional[List[str]]=None,
png_sticker: Union[Any, str]=None,
tgs_sticker: Union[Any, str]=None,
webm_sticker: Union[Any, str]=None,
contains_masks: Optional[bool]=None,
sticker_type: Optional[str]=None,
mask_position: Optional[types.MaskPosition]=None,
needs_repainting: Optional[bool]=None,
stickers: List[types.InputSticker]=None,
sticker_format: Optional[str]=None) -> bool:
"""
Use this method to create new sticker set owned by a user.
The bot will be able to edit the created sticker set.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#createnewstickerset
.. note::
Fields *_sticker are deprecated, pass a list of stickers to stickers parameter instead.
:param user_id: User identifier of created sticker set owner
:type user_id: :obj:`int`
:param name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters,
digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot_username>".
<bot_username> is case insensitive. 1-64 characters.
:type name: :obj:`str`
:param title: Sticker set title, 1-64 characters
:type title: :obj:`str`
:param emojis: One or more emoji corresponding to the sticker
:type emojis: :obj:`str`
:param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width
or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL
as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
:type png_sticker: :obj:`str`
:param tgs_sticker: TGS animation with the sticker, uploaded using multipart/form-data.
:type tgs_sticker: :obj:`str`
:param webm_sticker: WebM animation with the sticker, uploaded using multipart/form-data.
:type webm_sticker: :obj:`str`
:param contains_masks: Pass True, if a set of mask stickers should be created. Deprecated since Bot API 6.2,
use sticker_type instead.
:type contains_masks: :obj:`bool`
:param sticker_type: Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
:type sticker_type: :obj:`str`
:param mask_position: A JSON-serialized object for position where the mask should be placed on faces
:type mask_position: :class:`telebot.types.MaskPosition`
:param needs_repainting: Pass True if stickers in the sticker set must be repainted to the color of text when used in messages,
the accent color if used as emoji status, white on chat photos, or another appropriate color based on context;
for custom emoji sticker sets only
:type needs_repainting: :obj:`bool`
:param stickers: List of stickers to be added to the set
:type stickers: :obj:`list` of :class:`telebot.types.InputSticker`
:param sticker_format: Format of stickers in the set, must be one of “static”, “animated”, “video”
:type sticker_format: :obj:`str`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
if tgs_sticker:
sticker_format = 'animated'
elif webm_sticker:
sticker_format = 'video'
elif png_sticker:
sticker_format = 'static'
if contains_masks is not None:
logger.warning('The parameter "contains_masks" is deprecated, use "sticker_type" instead')
if sticker_type is None:
sticker_type = 'mask' if contains_masks else 'regular'
if stickers is None:
stickers = png_sticker or tgs_sticker or webm_sticker
if stickers is None:
raise ValueError('You must pass at least one sticker')
stickers = [types.InputSticker(sticker=stickers, emoji_list=emojis, mask_position=mask_position)]
return await asyncio_helper.create_new_sticker_set(
self.token, user_id, name, title, stickers, sticker_format, sticker_type, needs_repainting)
async def add_sticker_to_set(
self, user_id: int, name: str, emojis: Union[List[str], str]=None,
png_sticker: Optional[Union[Any, str]]=None,
tgs_sticker: Optional[Union[Any, str]]=None,
webm_sticker: Optional[Union[Any, str]]=None,
mask_position: Optional[types.MaskPosition]=None,
sticker: Optional[List[types.InputSticker]]=None) -> bool:
"""
Use this method to add a new sticker to a set created by the bot.
The format of the added sticker must match the format of the other stickers in the set.
Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers.
Static sticker sets can have up to 120 stickers.
Returns True on success.
.. note::
**_sticker, mask_position, emojis parameters are deprecated, use stickers instead
Telegram documentation: https://core.telegram.org/bots/api#addstickertoset
:param user_id: User identifier of created sticker set owner
:type user_id: :obj:`int`
:param name: Sticker set name
:type name: :obj:`str`
:param emojis: One or more emoji corresponding to the sticker
:type emojis: :obj:`str`
:param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either
width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers,
pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
:type png_sticker: :obj:`str` or :obj:`filelike object`
:param tgs_sticker: TGS animation with the sticker, uploaded using multipart/form-data.
:type tgs_sticker: :obj:`str` or :obj:`filelike object`
:param webm_sticker: WebM animation with the sticker, uploaded using multipart/form-data.
:type webm_sticker: :obj:`str` or :obj:`filelike object`
:param mask_position: A JSON-serialized object for position where the mask should be placed on faces
:type mask_position: :class:`telebot.types.MaskPosition`
:param sticker: A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
:type sticker: :obj:`list` of :class:`telebot.types.InputSticker`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
# split emojis if string
if isinstance(emojis, str):
emojis = list(emojis)
# Replaced the parameters png_sticker, tgs_sticker, webm_sticker, emojis and mask_position
if sticker is None:
old_sticker = png_sticker or tgs_sticker or webm_sticker
if old_sticker is not None:
logger.warning('The parameters "..._sticker", "emojis" and "mask_position" are deprecated, use "sticker" instead')
if not old_sticker:
raise ValueError('You must pass at least one sticker.')
sticker = types.InputSticker(old_sticker, emojis, mask_position)
return await asyncio_helper.add_sticker_to_set(
self.token, user_id, name, sticker)
async def set_sticker_position_in_set(self, sticker: str, position: int) -> bool:
"""
Use this method to move a sticker in a set created by the bot to a specific position . Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#setstickerpositioninset
:param sticker: File identifier of the sticker
:type sticker: :obj:`str`
:param position: New sticker position in the set, zero-based
:type position: :obj:`int`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.set_sticker_position_in_set(self.token, sticker, position)
async def delete_sticker_from_set(self, sticker: str) -> bool:
"""
Use this method to delete a sticker from a set created by the bot. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#deletestickerfromset
:param sticker: File identifier of the sticker
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_sticker_from_set(self.token, sticker)
async def create_forum_topic(self,
chat_id: int, name: str, icon_color: Optional[int]=None,
icon_custom_emoji_id: Optional[str]=None) -> types.ForumTopic:
"""
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator
in the chat for this to work and must have the can_manage_topics administrator rights.
Returns information about the created topic as a ForumTopic object.
Telegram documentation: https://core.telegram.org/bots/api#createforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param name: Name of the topic, 1-128 characters
:type name: :obj:`str`
:param icon_color: Color of the topic icon in RGB format. Currently, must be one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F
:type icon_color: :obj:`int`
:param icon_custom_emoji_id: Custom emoji for the topic icon. Must be an emoji of type “tgs” and must be exactly 1 character long
:type icon_custom_emoji_id: :obj:`str`
:return: On success, information about the created topic is returned as a ForumTopic object.
:rtype: :class:`telebot.types.ForumTopic`
"""
return types.ForumTopic.de_json(
await asyncio_helper.create_forum_topic(self.token, chat_id, name, icon_color, icon_custom_emoji_id)
)
async def edit_forum_topic(
self, chat_id: Union[int, str],
message_thread_id: int, name: Optional[str]=None,
icon_custom_emoji_id: Optional[str]=None
) -> bool:
"""
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an
administrator in the chat for this to work and must have can_manage_topics administrator rights,
unless it is the creator of the topic. Returns True on success.
Telegram Documentation: https://core.telegram.org/bots/api#editforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_thread_id: Identifier of the topic to edit
:type message_thread_id: :obj:`int`
:param name: Optional, New name of the topic, 1-128 characters. If not specififed or empty,
the current name of the topic will be kept
:type name: :obj:`str`
:param icon_custom_emoji_id: Optional, New unique identifier of the custom emoji shown as the topic icon.
Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the
icon. If not specified, the current icon will be kept
:type icon_custom_emoji_id: :obj:`str`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.edit_forum_topic(self.token, chat_id, message_thread_id, name, icon_custom_emoji_id)
async def close_forum_topic(self, chat_id: Union[str, int], message_thread_id: int) -> bool:
"""
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator
in the chat for this to work and must have the can_manage_topics administrator rights, unless it is
the creator of the topic. Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#closeforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_thread_id: Identifier of the topic to close
:type message_thread_id: :obj:`int`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.close_forum_topic(self.token, chat_id, message_thread_id)
async def reopen_forum_topic(self, chat_id: Union[str, int], message_thread_id: int) -> bool:
"""
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat
for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#reopenforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_thread_id: Identifier of the topic to reopen
:type message_thread_id: :obj:`int`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.reopen_forum_topic(self.token, chat_id, message_thread_id)
async def delete_forum_topic(self, chat_id: Union[str, int], message_thread_id: int) -> bool:
"""
Use this method to delete a topic in a forum supergroup chat. The bot must be an administrator in the chat for this
to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True
on success.
Telegram documentation: https://core.telegram.org/bots/api#deleteforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_thread_id: Identifier of the topic to delete
:type message_thread_id: :obj:`int`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.delete_forum_topic(self.token, chat_id, message_thread_id)
async def unpin_all_forum_topic_messages(self, chat_id: Union[str, int], message_thread_id: int) -> bool:
"""
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the
chat for this to work and must have the can_pin_messages administrator right in the supergroup.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#unpinallforumtopicmessages
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param message_thread_id: Identifier of the topic
:type message_thread_id: :obj:`int`
:return: On success, True is returned.
:rtype: :obj:`bool`
"""
return await asyncio_helper.unpin_all_forum_topic_messages(self.token, chat_id, message_thread_id)
async def edit_general_forum_topic(self, chat_id: Union[int, str], name: str) -> bool:
"""
Use this method to edit the name of the 'General' topic in a forum supergroup chat.
The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#editgeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param name: New topic name, 1-128 characters
:type name: :obj:`str`
"""
return await asyncio_helper.edit_general_forum_topic(self.token, chat_id, name)
async def close_general_forum_topic(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to close the 'General' topic in a forum supergroup chat.
The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#closegeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
"""
return await asyncio_helper.close_general_forum_topic(self.token, chat_id)
async def reopen_general_forum_topic(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to reopen the 'General' topic in a forum supergroup chat.
The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#reopengeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
"""
return await asyncio_helper.reopen_general_forum_topic(self.token, chat_id)
async def hide_general_forum_topic(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to hide the 'General' topic in a forum supergroup chat.
The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#hidegeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
"""
return await asyncio_helper.hide_general_forum_topic(self.token, chat_id)
async def unhide_general_forum_topic(self, chat_id: Union[int, str]) -> bool:
"""
Use this method to unhide the 'General' topic in a forum supergroup chat.
The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights.
Returns True on success.
Telegram documentation: https://core.telegram.org/bots/api#unhidegeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
"""
return await asyncio_helper.unhide_general_forum_topic(self.token, chat_id)
async def get_forum_topic_icon_stickers(self) -> List[types.Sticker]:
"""
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user.
Requires no parameters. Returns an Array of Sticker objects.
Telegram documentation: https://core.telegram.org/bots/api#getforumtopiciconstickers
:return: On success, a list of StickerSet objects is returned.
:rtype: List[:class:`telebot.types.StickerSet`]
"""
return await asyncio_helper.get_forum_topic_icon_stickers(self.token)
async def set_state(self, user_id: int, state: Union[State, int, str], chat_id: Optional[int]=None):
"""
Sets a new state of a user.
.. note::
You should set both user id and chat id in order to set state for a user in a chat.
Otherwise, if you only set user_id, chat_id will equal to user_id, this means that
state will be set for the user in his private chat with a bot.
:param user_id: User's identifier
:type user_id: :obj:`int`
:param state: new state. can be string, integer, or :class:`telebot.types.State`
:type state: :obj:`int` or :obj:`str` or :class:`telebot.types.State`
:param chat_id: Chat's identifier
:type chat_id: :obj:`int`
:return: None
"""
if not chat_id:
chat_id = user_id
await self.current_states.set_state(chat_id, user_id, state)
async def reset_data(self, user_id: int, chat_id: Optional[int]=None):
"""
Reset data for a user in chat.
:param user_id: User's identifier
:type user_id: :obj:`int`
:param chat_id: Chat's identifier
:type chat_id: :obj:`int`
:return: None
"""
if chat_id is None:
chat_id = user_id
await self.current_states.reset_data(chat_id, user_id)
async def delete_state(self, user_id: int, chat_id: Optional[int]=None):
"""
Delete the current state of a user.
:param user_id: User's identifier
:type user_id: :obj:`int`
:param chat_id: Chat's identifier
:type chat_id: :obj:`int`
:return: None
"""
if not chat_id:
chat_id = user_id
await self.current_states.delete_state(chat_id, user_id)
def retrieve_data(self, user_id: int, chat_id: Optional[int]=None):
"""
Returns context manager with data for a user in chat.
:param user_id: User identifier
:type user_id: int
:param chat_id: Chat's unique identifier, defaults to user_id
:type chat_id: int, optional
:return: Context manager with data for a user in chat
:rtype: Optional[Any]
"""
if not chat_id:
chat_id = user_id
return self.current_states.get_interactive_data(chat_id, user_id)
async def get_state(self, user_id, chat_id: Optional[int]=None):
"""
Gets current state of a user.
Not recommended to use this method. But it is ok for debugging.
:param user_id: User's identifier
:type user_id: :obj:`int`
:param chat_id: Chat's identifier
:type chat_id: :obj:`int`
:return: state of a user
:rtype: :obj:`int` or :obj:`str` or :class:`telebot.types.State`
"""
if not chat_id:
chat_id = user_id
return await self.current_states.get_state(chat_id, user_id)
async def add_data(self, user_id: int, chat_id: Optional[int]=None, **kwargs):
"""
Add data to states.
:param user_id: User's identifier
:type user_id: :obj:`int`
:param chat_id: Chat's identifier
:type chat_id: :obj:`int`
:param kwargs: Data to add
:return: None
"""
if not chat_id:
chat_id = user_id
for key, value in kwargs.items():
await self.current_states.set_data(chat_id, user_id, key, value)
View Git Blame Copy Permalink