Skip to content

Latest commit

 

History

History
367 lines (313 loc) · 12.4 KB

bot_methods.rst

File metadata and controls

367 lines (313 loc) · 12.4 KB

Since this class has a large number of methods and attributes, below you can find a quick overview.

Sending Messages
~telegram.Bot.send_animation Used for sending animations
~telegram.Bot.send_audio Used for sending audio files
~telegram.Bot.send_chat_action Used for sending chat actions
~telegram.Bot.send_contact Used for sending contacts
~telegram.Bot.send_dice Used for sending dice messages
~telegram.Bot.send_document Used for sending documents
~telegram.Bot.send_game Used for sending a game
~telegram.Bot.send_invoice Used for sending an invoice
~telegram.Bot.send_location Used for sending location
~telegram.Bot.send_media_group Used for sending media grouped together
~telegram.Bot.send_message Used for sending text messages
~telegram.Bot.send_photo Used for sending photos
~telegram.Bot.send_poll Used for sending polls
~telegram.Bot.send_sticker Used for sending stickers
~telegram.Bot.send_venue Used for sending venue locations.
~telegram.Bot.send_video Used for sending videos
~telegram.Bot.send_video_note Used for sending video notes
~telegram.Bot.send_voice Used for sending voice messages
~telegram.Bot.copy_message Used for copying the contents of an arbitrary message
~telegram.Bot.forward_message Used for forwarding messages

Updating Messages
~telegram.Bot.answer_callback_query Used for answering the callback query
~telegram.Bot.answer_inline_query Used for answering the inline query
~telegram.Bot.answer_pre_checkout_query Used for answering a pre checkout query
~telegram.Bot.answer_shipping_query Used for answering a shipping query
~telegram.Bot.answer_web_app_query Used for answering a web app query
~telegram.Bot.edit_message_caption Used for editing captions
~telegram.Bot.edit_message_media Used for editing the media on messages
~telegram.Bot.edit_message_live_location Used for editing the location in live location messages
~telegram.Bot.edit_message_reply_markup Used for editing the reply markup on messages
~telegram.Bot.edit_message_text Used for editing text messages
~telegram.Bot.stop_poll Used for stopping the running poll
~telegram.Bot.delete_message Used for deleting messages.

Chat Moderation and information
~telegram.Bot.ban_chat_member Used for banning a member from the chat
~telegram.Bot.unban_chat_member Used for unbanning a member from the chat
~telegram.Bot.ban_chat_sender_chat Used for banning a channel in a channel or supergroup
~telegram.Bot.unban_chat_sender_chat Used for unbanning a channel in a channel or supergroup
~telegram.Bot.restrict_chat_member Used for restricting a chat member
~telegram.Bot.promote_chat_member Used for promoting a chat member
~telegram.Bot.set_chat_administrator_custom_title Used for assigning a custom admin title to an admin
~telegram.Bot.set_chat_permissions Used for setting the permissions of a chat
~telegram.Bot.export_chat_invite_link Used for creating a new primary invite link for a chat
~telegram.Bot.create_chat_invite_link Used for creating an additional invite link for a chat
~telegram.Bot.edit_chat_invite_link Used for editing a non-primary invite link
~telegram.Bot.revoke_chat_invite_link Used for revoking an invite link created by the bot
~telegram.Bot.approve_chat_join_request Used for approving a chat join request
~telegram.Bot.decline_chat_join_request Used for declining a chat join request
~telegram.Bot.set_chat_photo Used for setting a photo to a chat
~telegram.Bot.delete_chat_photo Used for deleting a chat photo
~telegram.Bot.set_chat_title Used for setting a chat title
~telegram.Bot.set_chat_description Used for setting the description of a chat
~telegram.Bot.pin_chat_message Used for pinning a message
~telegram.Bot.unpin_chat_message Used for unpinning a message
~telegram.Bot.unpin_all_chat_messages Used for unpinning all pinned chat messages
~telegram.Bot.get_user_profile_photos Used for obtaining user's profile pictures
~telegram.Bot.get_chat Used for getting information about a chat
~telegram.Bot.get_chat_administrators Used for getting the list of admins in a chat
~telegram.Bot.get_chat_member_count Used for getting the number of members in a chat
~telegram.Bot.get_chat_member Used for getting a member of a chat
~telegram.Bot.set_my_commands Used for setting the list of commands
~telegram.Bot.delete_my_commands Used for deleting the list of commands
~telegram.Bot.get_my_commands Used for obtaining the list of commands
~telegram.Bot.get_my_default_administrator_rights Used for obtaining the default administrator rights for the bot
~telegram.Bot.set_my_default_administrator_rights Used for setting the default administrator rights for the bot
~telegram.Bot.get_chat_menu_button Used for obtaining the menu button of a private chat or the default menu button
~telegram.Bot.set_chat_menu_button Used for setting the menu button of a private chat or the default menu button
~telegram.Bot.leave_chat Used for leaving a chat

Stickerset management
~telegram.Bot.add_sticker_to_set Used for adding a sticker to a set
~telegram.Bot.delete_sticker_from_set Used for deleting a sticker from a set
~telegram.Bot.create_new_sticker_set Used for creating a new sticker set
~telegram.Bot.set_chat_sticker_set Used for setting a sticker set
~telegram.Bot.delete_chat_sticker_set Used for deleting the set sticker set
~telegram.Bot.set_sticker_position_in_set Used for moving a sticker's position in the set
~telegram.Bot.set_sticker_set_thumb Used for setting the thumbnail of a sticker set
~telegram.Bot.get_sticker_set Used for getting a sticker set
~telegram.Bot.upload_sticker_file Used for uploading a sticker file
~telegram.Bot.get_custom_emoji_stickers Used for getting custom emoji files based on their IDs

Games
~telegram.Bot.get_game_high_scores Used for getting the game high scores
~telegram.Bot.set_game_score Used for setting the game score

Getting updates
~telegram.Bot.get_updates Used for getting updates using long polling
~telegram.Bot.get_webhook_info Used for getting current webhook status
~telegram.Bot.set_webhook Used for setting a webhook to receive updates
~telegram.Bot.delete_webhook Used for removing webhook integration

Forum topic management
~telegram.Bot.close_forum_topic Used for closing a forum topic
~telegram.Bot.close_general_forum_topic Used for closing the general forum topic
~telegram.Bot.create_forum_topic Used to create a topic
~telegram.Bot.delete_forum_topic Used for deleting a forum topic
~telegram.Bot.edit_forum_topic Used to edit a topic
~telegram.Bot.edit_general_forum_topic Used to edit the general topic
~telegram.Bot.get_forum_topic_icon_stickers Used to get custom emojis to use as topic icons
~telegram.Bot.hide_general_forum_topic Used to hide the general topic
~telegram.Bot.unhide_general_forum_topic Used to unhide the general topic
~telegram.Bot.reopen_forum_topic Used to reopen a topic
~telegram.Bot.reopen_general_forum_topic Used to reopen the general topic
~telegram.Bot.unpin_all_forum_topic_messages Used to unpin all messages in a forum topic

Miscellaneous
~telegram.Bot.create_invoice_link Used to generate an HTTP link for an invoice
~telegram.Bot.close Used for closing server instance when switching to another local server
~telegram.Bot.log_out Used for logging out from cloud Bot API server
~telegram.Bot.get_file Used for getting basic info about a file
~telegram.Bot.get_me Used for getting basic information about the bot

Properties
~telegram.Bot.base_file_url Telegram Bot API file URL
~telegram.Bot.base_url Telegram Bot API service URL
~telegram.Bot.bot The user instance of the bot as returned by ~telegram.Bot.get_me
~telegram.Bot.can_join_groups Whether the bot can join groups
~telegram.Bot.can_read_all_group_messages Whether the bot can read all incoming group messages
~telegram.Bot.id The user id of the bot
~telegram.Bot.name The username of the bot, with leading @
~telegram.Bot.first_name The first name of the bot
~telegram.Bot.last_name The last name of the bot
~telegram.Bot.local_mode Whether the bot is running in local mode
~telegram.Bot.username The username of the bot, without leading @
~telegram.Bot.link The t.me link of the bot
~telegram.Bot.private_key Deserialized private key for decryption of telegram passport data
~telegram.Bot.supports_inline_queries Whether the bot supports inline queries
~telegram.Bot.token Bot's unique authentication token