Welcome to pyTelegramBotAPI’s documentation!¶
TeleBot¶
TeleBot is synchronous and asynchronous implementation of Telegram Bot API.
Chats¶
English chat: Private chat
Russian chat: @pytelegrambotapi_talks_ru
News: @pyTelegramBotAPI
Pypi: Pypi
Source: Github repository
Some features:¶
Easy to learn and use.
Easy to understand.
Both sync and async.
Examples on features.
States
And more…
Content¶
- Installation Guide
- Quick start
- Types of API
AnimationAudioBackgroundFillBackgroundFillFreeformGradientBackgroundFillGradientBackgroundFillSolidBackgroundTypeBackgroundTypeChatThemeBackgroundTypeFillBackgroundTypePatternBackgroundTypeWallpaperBirthdateBotCommandBotCommandScopeBotCommandScopeAllChatAdministratorsBotCommandScopeAllGroupChatsBotCommandScopeAllPrivateChatsBotCommandScopeChatBotCommandScopeChatAdministratorsBotCommandScopeChatMemberBotCommandScopeDefaultBotDescriptionBotNameBotShortDescriptionBusinessConnectionBusinessIntroBusinessLocationBusinessMessagesDeletedBusinessOpeningHoursBusinessOpeningHoursIntervalCallbackQueryChatChatAdministratorRightsChatBackgroundChatBoostChatBoostAddedChatBoostRemovedChatBoostSourceChatBoostSourceGiftCodeChatBoostSourceGiveawayChatBoostSourcePremiumChatBoostUpdatedChatFullInfoChatInviteLinkChatJoinRequestChatLocationChatMemberChatMemberAdministratorChatMemberBannedChatMemberLeftChatMemberMemberChatMemberOwnerChatMemberRestrictedChatMemberUpdatedChatPermissionsChatPhotoChatSharedChosenInlineResultContactDiceDictionaryableDocumentExternalReplyInfoFileForceReplyForumTopicForumTopicClosedForumTopicCreatedForumTopicEditedForumTopicReopenedGameGameHighScoreGeneralForumTopicHiddenGeneralForumTopicUnhiddenGiveawayGiveawayCompletedGiveawayCreatedGiveawayWinnersInaccessibleMessageInlineKeyboardButtonInlineKeyboardMarkupInlineQueryInlineQueryResultArticleInlineQueryResultAudioInlineQueryResultBaseInlineQueryResultCachedAudioInlineQueryResultCachedBaseInlineQueryResultCachedDocumentInlineQueryResultCachedGifInlineQueryResultCachedMpeg4GifInlineQueryResultCachedPhotoInlineQueryResultCachedStickerInlineQueryResultCachedVideoInlineQueryResultCachedVoiceInlineQueryResultContactInlineQueryResultDocumentInlineQueryResultGameInlineQueryResultGifInlineQueryResultLocationInlineQueryResultMpeg4GifInlineQueryResultPhotoInlineQueryResultVenueInlineQueryResultVideoInlineQueryResultVoiceInlineQueryResultsButtonInputContactMessageContentInputFileInputInvoiceMessageContentInputLocationMessageContentInputMediaInputMediaAnimationInputMediaAudioInputMediaDocumentInputMediaPhotoInputMediaVideoInputPaidMediaInputPaidMediaPhotoInputPaidMediaVideoInputPollOptionInputStickerInputTextMessageContentInputVenueMessageContentInvoiceJsonDeserializableJsonSerializableKeyboardButtonKeyboardButtonPollTypeKeyboardButtonRequestChatKeyboardButtonRequestUserKeyboardButtonRequestUsersLabeledPriceLinkPreviewOptionsLocationLoginUrlMaskPositionMenuButtonMenuButtonCommandsMenuButtonDefaultMenuButtonWebAppMessageMessage.any_entitiesMessage.any_textMessage.forward_dateMessage.forward_fromMessage.forward_from_chatMessage.forward_from_message_idMessage.forward_sender_nameMessage.forward_signatureMessage.html_captionMessage.html_textMessage.new_chat_memberMessage.parse_chat()Message.parse_entities()Message.parse_photo()Message.user_sharedMessage.voice_chat_endedMessage.voice_chat_participants_invitedMessage.voice_chat_scheduledMessage.voice_chat_started
MessageAutoDeleteTimerChangedMessageEntityMessageIDMessageOriginMessageOriginChannelMessageOriginChatMessageOriginHiddenUserMessageOriginUserMessageReactionCountUpdatedMessageReactionUpdatedOrderInfoPaidMediaPaidMediaInfoPaidMediaPhotoPaidMediaPreviewPaidMediaPurchasedPaidMediaVideoPhotoSizePollPollAnswerPollOptionPreCheckoutQueryProximityAlertTriggeredReactionCountReactionTypeReactionTypeCustomEmojiReactionTypeEmojiReactionTypePaidRefundedPaymentReplyKeyboardMarkupReplyKeyboardRemoveReplyParametersRevenueWithdrawalStateRevenueWithdrawalStateFailedRevenueWithdrawalStatePendingRevenueWithdrawalStateSucceededSentWebAppMessageSharedUserShippingAddressShippingOptionShippingQueryStarTransactionStarTransactionsStickerStickerSetStorySuccessfulPaymentSwitchInlineQueryChosenChatTextQuoteTransactionPartnerTransactionPartnerFragmentTransactionPartnerOtherTransactionPartnerTelegramAdsTransactionPartnerUserUpdateUserUserChatBoostsUserProfilePhotosUsersSharedVenueVideoVideoChatEndedVideoChatParticipantsInvitedVideoChatScheduledVideoChatStartedVideoNoteVoiceVoiceChatEndedVoiceChatParticipantsInvitedVoiceChatScheduledVoiceChatStartedWebAppDataWebAppInfoWebhookInfoWriteAccessAllowed
- TeleBot version
- TeleBot methods
ExceptionHandlerHandlerREPLY_MARKUP_TYPESTeleBotTeleBot.add_custom_filter()TeleBot.add_data()TeleBot.add_sticker_to_set()TeleBot.answer_callback_query()TeleBot.answer_inline_query()TeleBot.answer_pre_checkout_query()TeleBot.answer_shipping_query()TeleBot.answer_web_app_query()TeleBot.approve_chat_join_request()TeleBot.ban_chat_member()TeleBot.ban_chat_sender_chat()TeleBot.business_connection_handler()TeleBot.business_message_handler()TeleBot.callback_query_handler()TeleBot.channel_post_handler()TeleBot.chat_boost_handler()TeleBot.chat_join_request_handler()TeleBot.chat_member_handler()TeleBot.chosen_inline_handler()TeleBot.clear_reply_handlers()TeleBot.clear_reply_handlers_by_message_id()TeleBot.clear_step_handler()TeleBot.clear_step_handler_by_chat_id()TeleBot.close()TeleBot.close_forum_topic()TeleBot.close_general_forum_topic()TeleBot.copy_message()TeleBot.copy_messages()TeleBot.create_chat_invite_link()TeleBot.create_chat_subscription_invite_link()TeleBot.create_forum_topic()TeleBot.create_invoice_link()TeleBot.create_new_sticker_set()TeleBot.decline_chat_join_request()TeleBot.delete_chat_photo()TeleBot.delete_chat_sticker_set()TeleBot.delete_forum_topic()TeleBot.delete_message()TeleBot.delete_messages()TeleBot.delete_my_commands()TeleBot.delete_state()TeleBot.delete_sticker_from_set()TeleBot.delete_sticker_set()TeleBot.delete_webhook()TeleBot.deleted_business_messages_handler()TeleBot.disable_save_next_step_handlers()TeleBot.disable_save_reply_handlers()TeleBot.download_file()TeleBot.edit_chat_invite_link()TeleBot.edit_chat_subscription_invite_link()TeleBot.edit_forum_topic()TeleBot.edit_general_forum_topic()TeleBot.edit_message_caption()TeleBot.edit_message_live_location()TeleBot.edit_message_media()TeleBot.edit_message_reply_markup()TeleBot.edit_message_text()TeleBot.edited_business_message_handler()TeleBot.edited_channel_post_handler()TeleBot.edited_message_handler()TeleBot.enable_save_next_step_handlers()TeleBot.enable_save_reply_handlers()TeleBot.enable_saving_states()TeleBot.export_chat_invite_link()TeleBot.forward_message()TeleBot.forward_messages()TeleBot.get_business_connection()TeleBot.get_chat()TeleBot.get_chat_administrators()TeleBot.get_chat_member()TeleBot.get_chat_member_count()TeleBot.get_chat_members_count()TeleBot.get_chat_menu_button()TeleBot.get_custom_emoji_stickers()TeleBot.get_file()TeleBot.get_file_url()TeleBot.get_forum_topic_icon_stickers()TeleBot.get_game_high_scores()TeleBot.get_me()TeleBot.get_my_commands()TeleBot.get_my_default_administrator_rights()TeleBot.get_my_description()TeleBot.get_my_name()TeleBot.get_my_short_description()TeleBot.get_star_transactions()TeleBot.get_state()TeleBot.get_sticker_set()TeleBot.get_updates()TeleBot.get_user_chat_boosts()TeleBot.get_user_profile_photos()TeleBot.get_webhook_info()TeleBot.hide_general_forum_topic()TeleBot.infinity_polling()TeleBot.inline_handler()TeleBot.kick_chat_member()TeleBot.leave_chat()TeleBot.load_next_step_handlers()TeleBot.load_reply_handlers()TeleBot.log_out()TeleBot.message_handler()TeleBot.message_reaction_count_handler()TeleBot.message_reaction_handler()TeleBot.middleware_handler()TeleBot.my_chat_member_handler()TeleBot.pin_chat_message()TeleBot.poll_answer_handler()TeleBot.poll_handler()TeleBot.polling()TeleBot.pre_checkout_query_handler()TeleBot.process_new_updates()TeleBot.promote_chat_member()TeleBot.purchased_paid_media_handler()TeleBot.refund_star_payment()TeleBot.register_business_connection_handler()TeleBot.register_business_message_handler()TeleBot.register_callback_query_handler()TeleBot.register_channel_post_handler()TeleBot.register_chat_boost_handler()TeleBot.register_chat_join_request_handler()TeleBot.register_chat_member_handler()TeleBot.register_chosen_inline_handler()TeleBot.register_deleted_business_messages_handler()TeleBot.register_edited_business_message_handler()TeleBot.register_edited_channel_post_handler()TeleBot.register_edited_message_handler()TeleBot.register_for_reply()TeleBot.register_for_reply_by_message_id()TeleBot.register_inline_handler()TeleBot.register_message_handler()TeleBot.register_message_reaction_count_handler()TeleBot.register_message_reaction_handler()TeleBot.register_middleware_handler()TeleBot.register_my_chat_member_handler()TeleBot.register_next_step_handler()TeleBot.register_next_step_handler_by_chat_id()TeleBot.register_poll_answer_handler()TeleBot.register_poll_handler()TeleBot.register_pre_checkout_query_handler()TeleBot.register_purchased_paid_media_handler()TeleBot.register_removed_chat_boost_handler()TeleBot.register_shipping_query_handler()TeleBot.remove_webhook()TeleBot.removed_chat_boost_handler()TeleBot.reopen_forum_topic()TeleBot.reopen_general_forum_topic()TeleBot.replace_sticker_in_set()TeleBot.reply_to()TeleBot.reset_data()TeleBot.restrict_chat_member()TeleBot.retrieve_data()TeleBot.revoke_chat_invite_link()TeleBot.run_webhooks()TeleBot.send_animation()TeleBot.send_audio()TeleBot.send_chat_action()TeleBot.send_contact()TeleBot.send_dice()TeleBot.send_document()TeleBot.send_game()TeleBot.send_invoice()TeleBot.send_location()TeleBot.send_media_group()TeleBot.send_message()TeleBot.send_paid_media()TeleBot.send_photo()TeleBot.send_poll()TeleBot.send_sticker()TeleBot.send_venue()TeleBot.send_video()TeleBot.send_video_note()TeleBot.send_voice()TeleBot.set_chat_administrator_custom_title()TeleBot.set_chat_description()TeleBot.set_chat_menu_button()TeleBot.set_chat_permissions()TeleBot.set_chat_photo()TeleBot.set_chat_sticker_set()TeleBot.set_chat_title()TeleBot.set_custom_emoji_sticker_set_thumbnail()TeleBot.set_game_score()TeleBot.set_message_reaction()TeleBot.set_my_commands()TeleBot.set_my_default_administrator_rights()TeleBot.set_my_description()TeleBot.set_my_name()TeleBot.set_my_short_description()TeleBot.set_state()TeleBot.set_sticker_emoji_list()TeleBot.set_sticker_keywords()TeleBot.set_sticker_mask_position()TeleBot.set_sticker_position_in_set()TeleBot.set_sticker_set_thumb()TeleBot.set_sticker_set_thumbnail()TeleBot.set_sticker_set_title()TeleBot.set_update_listener()TeleBot.set_webhook()TeleBot.setup_middleware()TeleBot.shipping_query_handler()TeleBot.stop_bot()TeleBot.stop_message_live_location()TeleBot.stop_poll()TeleBot.stop_polling()TeleBot.unban_chat_member()TeleBot.unban_chat_sender_chat()TeleBot.unhide_general_forum_topic()TeleBot.unpin_all_chat_messages()TeleBot.unpin_all_forum_topic_messages()TeleBot.unpin_all_general_forum_topic_messages()TeleBot.unpin_chat_message()TeleBot.upload_sticker_file()TeleBot.user
- custom_filters file
- handler_backends file
- Extensions
- TeleBot methods
- AsyncTeleBot
- AsyncTeleBot methods
AsyncTeleBotAsyncTeleBot.add_custom_filter()AsyncTeleBot.add_data()AsyncTeleBot.add_sticker_to_set()AsyncTeleBot.answer_callback_query()AsyncTeleBot.answer_inline_query()AsyncTeleBot.answer_pre_checkout_query()AsyncTeleBot.answer_shipping_query()AsyncTeleBot.answer_web_app_query()AsyncTeleBot.approve_chat_join_request()AsyncTeleBot.ban_chat_member()AsyncTeleBot.ban_chat_sender_chat()AsyncTeleBot.business_connection_handler()AsyncTeleBot.business_message_handler()AsyncTeleBot.callback_query_handler()AsyncTeleBot.channel_post_handler()AsyncTeleBot.chat_boost_handler()AsyncTeleBot.chat_join_request_handler()AsyncTeleBot.chat_member_handler()AsyncTeleBot.chosen_inline_handler()AsyncTeleBot.close()AsyncTeleBot.close_forum_topic()AsyncTeleBot.close_general_forum_topic()AsyncTeleBot.close_session()AsyncTeleBot.copy_message()AsyncTeleBot.copy_messages()AsyncTeleBot.create_chat_invite_link()AsyncTeleBot.create_chat_subscription_invite_link()AsyncTeleBot.create_forum_topic()AsyncTeleBot.create_invoice_link()AsyncTeleBot.create_new_sticker_set()AsyncTeleBot.decline_chat_join_request()AsyncTeleBot.delete_chat_photo()AsyncTeleBot.delete_chat_sticker_set()AsyncTeleBot.delete_forum_topic()AsyncTeleBot.delete_message()AsyncTeleBot.delete_messages()AsyncTeleBot.delete_my_commands()AsyncTeleBot.delete_state()AsyncTeleBot.delete_sticker_from_set()AsyncTeleBot.delete_sticker_set()AsyncTeleBot.delete_webhook()AsyncTeleBot.deleted_business_messages_handler()AsyncTeleBot.download_file()AsyncTeleBot.edit_chat_invite_link()AsyncTeleBot.edit_chat_subscription_invite_link()AsyncTeleBot.edit_forum_topic()AsyncTeleBot.edit_general_forum_topic()AsyncTeleBot.edit_message_caption()AsyncTeleBot.edit_message_live_location()AsyncTeleBot.edit_message_media()AsyncTeleBot.edit_message_reply_markup()AsyncTeleBot.edit_message_text()AsyncTeleBot.edited_business_message_handler()AsyncTeleBot.edited_channel_post_handler()AsyncTeleBot.edited_message_handler()AsyncTeleBot.enable_saving_states()AsyncTeleBot.export_chat_invite_link()AsyncTeleBot.forward_message()AsyncTeleBot.forward_messages()AsyncTeleBot.get_business_connection()AsyncTeleBot.get_chat()AsyncTeleBot.get_chat_administrators()AsyncTeleBot.get_chat_member()AsyncTeleBot.get_chat_member_count()AsyncTeleBot.get_chat_members_count()AsyncTeleBot.get_chat_menu_button()AsyncTeleBot.get_custom_emoji_stickers()AsyncTeleBot.get_file()AsyncTeleBot.get_file_url()AsyncTeleBot.get_forum_topic_icon_stickers()AsyncTeleBot.get_game_high_scores()AsyncTeleBot.get_me()AsyncTeleBot.get_my_commands()AsyncTeleBot.get_my_default_administrator_rights()AsyncTeleBot.get_my_description()AsyncTeleBot.get_my_name()AsyncTeleBot.get_my_short_description()AsyncTeleBot.get_star_transactions()AsyncTeleBot.get_state()AsyncTeleBot.get_sticker_set()AsyncTeleBot.get_updates()AsyncTeleBot.get_user_chat_boosts()AsyncTeleBot.get_user_profile_photos()AsyncTeleBot.get_webhook_info()AsyncTeleBot.hide_general_forum_topic()AsyncTeleBot.infinity_polling()AsyncTeleBot.inline_handler()AsyncTeleBot.kick_chat_member()AsyncTeleBot.leave_chat()AsyncTeleBot.log_out()AsyncTeleBot.message_handler()AsyncTeleBot.message_reaction_count_handler()AsyncTeleBot.message_reaction_handler()AsyncTeleBot.my_chat_member_handler()AsyncTeleBot.pin_chat_message()AsyncTeleBot.poll_answer_handler()AsyncTeleBot.poll_handler()AsyncTeleBot.polling()AsyncTeleBot.pre_checkout_query_handler()AsyncTeleBot.process_new_updates()AsyncTeleBot.promote_chat_member()AsyncTeleBot.purchased_paid_media_handler()AsyncTeleBot.refund_star_payment()AsyncTeleBot.register_business_connection_handler()AsyncTeleBot.register_business_message_handler()AsyncTeleBot.register_callback_query_handler()AsyncTeleBot.register_channel_post_handler()AsyncTeleBot.register_chat_boost_handler()AsyncTeleBot.register_chat_join_request_handler()AsyncTeleBot.register_chat_member_handler()AsyncTeleBot.register_chosen_inline_handler()AsyncTeleBot.register_deleted_business_messages_handler()AsyncTeleBot.register_edited_business_message_handler()AsyncTeleBot.register_edited_channel_post_handler()AsyncTeleBot.register_edited_message_handler()AsyncTeleBot.register_inline_handler()AsyncTeleBot.register_message_handler()AsyncTeleBot.register_message_reaction_count_handler()AsyncTeleBot.register_message_reaction_handler()AsyncTeleBot.register_my_chat_member_handler()AsyncTeleBot.register_poll_answer_handler()AsyncTeleBot.register_poll_handler()AsyncTeleBot.register_pre_checkout_query_handler()AsyncTeleBot.register_purchased_paid_media_handler()AsyncTeleBot.register_removed_chat_boost_handler()AsyncTeleBot.register_shipping_query_handler()AsyncTeleBot.remove_webhook()AsyncTeleBot.removed_chat_boost_handler()AsyncTeleBot.reopen_forum_topic()AsyncTeleBot.reopen_general_forum_topic()AsyncTeleBot.replace_sticker_in_set()AsyncTeleBot.reply_to()AsyncTeleBot.reset_data()AsyncTeleBot.restrict_chat_member()AsyncTeleBot.retrieve_data()AsyncTeleBot.revoke_chat_invite_link()AsyncTeleBot.run_webhooks()AsyncTeleBot.send_animation()AsyncTeleBot.send_audio()AsyncTeleBot.send_chat_action()AsyncTeleBot.send_contact()AsyncTeleBot.send_dice()AsyncTeleBot.send_document()AsyncTeleBot.send_game()AsyncTeleBot.send_invoice()AsyncTeleBot.send_location()AsyncTeleBot.send_media_group()AsyncTeleBot.send_message()AsyncTeleBot.send_paid_media()AsyncTeleBot.send_photo()AsyncTeleBot.send_poll()AsyncTeleBot.send_sticker()AsyncTeleBot.send_venue()AsyncTeleBot.send_video()AsyncTeleBot.send_video_note()AsyncTeleBot.send_voice()AsyncTeleBot.set_chat_administrator_custom_title()AsyncTeleBot.set_chat_description()AsyncTeleBot.set_chat_menu_button()AsyncTeleBot.set_chat_permissions()AsyncTeleBot.set_chat_photo()AsyncTeleBot.set_chat_sticker_set()AsyncTeleBot.set_chat_title()AsyncTeleBot.set_custom_emoji_sticker_set_thumbnail()AsyncTeleBot.set_game_score()AsyncTeleBot.set_message_reaction()AsyncTeleBot.set_my_commands()AsyncTeleBot.set_my_default_administrator_rights()AsyncTeleBot.set_my_description()AsyncTeleBot.set_my_name()AsyncTeleBot.set_my_short_description()AsyncTeleBot.set_state()AsyncTeleBot.set_sticker_emoji_list()AsyncTeleBot.set_sticker_keywords()AsyncTeleBot.set_sticker_mask_position()AsyncTeleBot.set_sticker_position_in_set()AsyncTeleBot.set_sticker_set_thumb()AsyncTeleBot.set_sticker_set_thumbnail()AsyncTeleBot.set_sticker_set_title()AsyncTeleBot.set_update_listener()AsyncTeleBot.set_webhook()AsyncTeleBot.setup_middleware()AsyncTeleBot.shipping_query_handler()AsyncTeleBot.skip_updates()AsyncTeleBot.stop_message_live_location()AsyncTeleBot.stop_poll()AsyncTeleBot.unban_chat_member()AsyncTeleBot.unban_chat_sender_chat()AsyncTeleBot.unhide_general_forum_topic()AsyncTeleBot.unpin_all_chat_messages()AsyncTeleBot.unpin_all_forum_topic_messages()AsyncTeleBot.unpin_all_general_forum_topic_messages()AsyncTeleBot.unpin_chat_message()AsyncTeleBot.upload_sticker_file()AsyncTeleBot.user
ExceptionHandlerHandler
- Asyncio filters
- Asyncio handler backends
- Extensions
- AsyncTeleBot methods
- Callback data factory
- Utils
- util file
antiflood()chunks()content_type_mediacontent_type_serviceescape()extract_arguments()extract_bot_id()extract_command()generate_random_token()is_bytes()is_command()is_dict()is_pil_image()is_string()parse_web_app_data()pil_image_to_file()quick_markup()smart_split()split_string()update_typesuser_link()validate_token()validate_web_app_data()webhook_google_functions()
- util file
- Formatting options