Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Tobigram
Logo
Tobigram

Introduction

  • Install Guide
  • Quick Start

Getting Started

  • Project Setup
  • Authorization
  • Invoking Methods
  • Handling Updates
  • Error Handling
  • Examples
    • hello_world
    • echo_bot
    • business_echo_bot
    • welcome_bot
    • get_history
    • get_chat_members
    • get_dialogs
    • callback_queries
    • inline_queries
    • use_inline_bots
    • bot_keyboards
    • send_voice
    • raw_updates
    • guest_message_echo_bot
    • conversation_bot
    • ephemeral_message_bot
    • rich_message

Features

  • Features
    • Business Accounts
    • Paid Media
    • Gifts and Stars
    • Stories
    • Checklists
    • Suggested Posts
    • Direct Messages in Channels
    • Topics and Drafts
    • Text Entities and Button Styling
    • Polls
    • Guest Mode and Managed Bots
    • Rich Messages
    • Ephemeral Messages
    • Communities
    • Listeners
    • Rate Limiting
    • Session Strings
    • Performance and Resource Budgets

API Reference

  • Pyrogram Client
  • Available Methods
    • ask
    • listen
    • register_next_step_handler
    • stop_listening
    • wait_for_callback_query
    • wait_for_message
    • add_handler
    • export_session_string
    • ping
    • remove_handler
    • restart
    • run
    • set_parse_mode
    • start
    • stop
    • stop_transmission
    • dismiss_suggestion
    • edit_user_info
    • get_app_config
    • get_app_update
    • get_cdn_config
    • get_countries_list
    • get_deep_link_info
    • get_invite_text
    • get_nearest_dc
    • get_passport_config
    • get_peer_colors
    • get_peer_profile_colors
    • get_premium_promo
    • get_promo_data
    • get_recent_me_urls
    • get_support
    • get_support_name
    • get_terms_of_service_update
    • get_timezones_list
    • get_user_info
    • hide_promo_data
    • save_app_log
    • set_bot_updates_status
    • get_difference
    • get_lang_pack
    • get_language
    • get_languages
    • get_strings
    • idle()
    • compose()
    • accept_authorization
    • add_profile_audio
    • cancel_password_email
    • change_authorization_settings
    • clear_recent_emoji_statuses
    • confirm_bot_connection
    • confirm_password_email
    • confirm_phone
    • create_theme
    • decline_password_reset
    • delete_account
    • delete_auto_save_exceptions
    • delete_passkey
    • delete_secure_value
    • delete_web_browser_settings_exceptions
    • disable_peer_connected_bot
    • edit_business_chat_link
    • get_account_ttl
    • get_all_secure_values
    • get_authorization_form
    • get_auto_download_settings
    • get_auto_save_settings
    • get_channel_default_emoji_statuses
    • get_channel_restricted_status_emojis
    • get_chat_themes
    • get_collectible_emoji_statuses
    • get_contact_sign_up_notification
    • get_content_settings
    • get_default_background_emojis
    • get_default_group_photo_emojis
    • get_default_profile_photo_emojis
    • get_global_privacy_settings
    • get_multi_wall_papers
    • get_notify_exceptions
    • get_notify_settings
    • get_paid_messages_revenue
    • get_passkeys
    • get_password_settings
    • get_privacy
    • get_reactions_notify_settings
    • get_recent_emoji_statuses
    • get_saved_music_ids
    • get_saved_ringtones
    • get_secure_value
    • get_theme
    • get_themes
    • get_tmp_password
    • get_unique_gift_chat_themes
    • get_wall_paper
    • get_wall_papers
    • get_web_authorizations
    • get_web_browser_settings
    • init_passkey_registration
    • install_theme
    • install_wall_paper
    • invalidate_sign_in_codes
    • register_device
    • register_passkey
    • remove_profile_audio
    • reorder_usernames
    • resend_password_email
    • reset_notify_settings
    • reset_password
    • reset_wall_papers
    • reset_web_authorization
    • reset_web_authorizations
    • save_auto_download_settings
    • save_auto_save_settings
    • save_ringtone
    • save_secure_value
    • save_theme
    • save_wall_paper
    • send_confirm_phone_code
    • set_account_ttl
    • set_contact_sign_up_notification
    • set_content_settings
    • set_global_privacy_settings
    • set_inactive_session_ttl
    • set_privacy
    • set_profile_audio_position
    • set_reactions_notify_settings
    • toggle_connected_bot_paused
    • toggle_no_paid_messages_exception
    • toggle_sponsored_messages
    • toggle_username
    • toggle_web_browser_settings_exception
    • unregister_device
    • update_connected_bot
    • update_device_locked
    • update_theme
    • update_web_browser_settings
    • upload_ringtone
    • upload_theme
    • upload_wall_paper
    • verify_phone
    • add_checklist_tasks
    • add_poll_option
    • add_to_gifs
    • approve_suggested_post
    • check_quick_reply_shortcut
    • check_search_posts_flood
    • clear_all_drafts
    • clear_recent_reactions
    • click_sponsored_message
    • compose_text_with_ai
    • copy_media_group
    • copy_message
    • copy_messages
    • decline_suggested_post
    • delete_chat_history
    • delete_direct_messages_chat_topic_history
    • delete_fact_check
    • delete_messages
    • delete_participant_reaction
    • delete_participant_reactions
    • delete_poll_option
    • delete_quick_reply_messages
    • delete_quick_reply_shortcut
    • delete_scheduled_messages
    • download_media
    • edit_fact_check
    • edit_inline_caption
    • edit_inline_media
    • edit_inline_reply_markup
    • edit_inline_text
    • edit_message_caption
    • edit_message_checklist
    • edit_message_live_location
    • edit_message_media
    • edit_message_reply_markup
    • edit_message_text
    • edit_quick_reply_shortcut
    • emojify_text_with_ai
    • export_message_link
    • fix_text_with_ai
    • forward_media_group
    • forward_messages
    • get_all_drafts
    • get_all_stickers
    • get_archived_stickers
    • get_available_effects
    • get_available_reactions
    • get_chat_history
    • get_chat_history_count
    • get_default_history_ttl
    • get_default_tag_reactions
    • get_direct_messages_chat_topic_history
    • get_discussion_message
    • get_discussion_replies
    • get_discussion_replies_count
    • get_emoji_stickers
    • get_custom_emoji_stickers
    • get_featured_emoji_stickers
    • get_featured_stickers
    • get_stickers
    • get_main_web_app
    • get_mask_stickers
    • get_media_group
    • get_message_author
    • get_message_reactions
    • get_message_read_participants
    • get_messages
    • get_messages_reactions
    • get_paid_reaction_privacy
    • get_poll_results
    • get_poll_stats
    • get_prepared_inline_message
    • get_quick_replies
    • get_quick_reply_messages
    • get_recent_reactions
    • get_rich_message
    • get_saved_gifs
    • get_saved_history
    • get_saved_reaction_tags
    • get_scheduled_messages
    • get_search_results_calendar
    • get_search_results_positions
    • get_sponsored_messages
    • get_top_reactions
    • get_unread_reactions
    • get_user_gifts
    • get_user_personal_chat_messages
    • get_user_profile_audios
    • get_web_app_link_url
    • get_web_app_url
    • get_web_page
    • get_web_page_preview
    • gift_premium_subscription
    • hide_peer_settings_bar
    • mark_checklist_tasks_as_done
    • open_web_app
    • read_chat_history
    • read_chat_message_contents
    • read_featured_stickers
    • read_mentions
    • read_reactions
    • read_saved_history
    • reorder_pinned_dialogs
    • reorder_quick_replies
    • reorder_sticker_sets
    • rephrase_text_with_ai
    • report_messages
    • report_reaction
    • report_sponsored_message
    • retract_vote
    • save_draft
    • save_prepared_inline_message
    • save_prepared_keyboard_button
    • save_recent_sticker
    • search_global
    • search_global_count
    • search_messages
    • search_messages_count
    • search_posts
    • search_posts_count
    • send_animation
    • send_audio
    • send_cached_media
    • send_chat_action
    • send_checklist
    • send_contact
    • send_dice
    • send_document
    • send_live_photo
    • send_location
    • send_media_group
    • send_message
    • send_message_draft
    • send_paid_media
    • send_paid_reaction
    • send_photo
    • send_poll
    • send_quick_reply_messages
    • send_reaction
    • send_rich_message
    • send_rich_message_draft
    • send_scheduled_messages
    • send_screenshot_notification
    • send_sticker
    • send_venue
    • send_video
    • send_video_note
    • send_voice
    • set_chat_available_reactions
    • set_chat_theme
    • set_chat_wallpaper
    • set_default_history_ttl
    • set_default_reaction
    • set_direct_messages_chat_topic_is_marked_as_unread
    • set_passport_data_errors
    • start_bot
    • stop_message_live_location
    • stop_poll
    • stream_media
    • summarize_text
    • toggle_dialog_pin
    • toggle_paid_reaction_privacy
    • toggle_peer_translations
    • toggle_saved_dialog_pin
    • transcribe_audio
    • translate_text
    • update_saved_reaction_tag
    • view_messages
    • view_sponsored_message
    • vote_poll
    • get_attached_stickers
    • get_dialog_unread_marks
    • get_document_by_hash
    • get_emoji_groups
    • get_emoji_keywords
    • get_emoji_keywords_difference
    • get_emoji_keywords_languages
    • get_emoji_profile_photo_groups
    • get_emoji_sticker_groups
    • get_emoji_status_groups
    • get_emoji_url
    • get_extended_media
    • get_fact_check
    • get_message_edit_data
    • get_outbox_read_date
    • get_pinned_saved_dialogs
    • get_poll_votes
    • get_recent_locations
    • get_stickers_by_emoticon
    • get_unread_mentions
    • get_unread_poll_votes
    • rate_transcribed_audio
    • read_discussion
    • read_poll_votes
    • reorder_pinned_saved_dialogs
    • report_messages_delivery
    • search_custom_emoji
    • search_emoji_sticker_sets
    • search_sent_media
    • accept_url_auth
    • check_url_auth_match_code
    • decline_url_auth
    • delete_chat
    • delete_phone_call_history
    • edit_chat_admin
    • get_attach_menu_bot
    • get_attach_menu_bots
    • get_bot_app
    • get_dh_config
    • get_emoji_game_info
    • get_future_chat_creator_after_leave
    • get_old_featured_stickers
    • get_split_ranges
    • get_suggested_dialog_filters
    • migrate_chat
    • prolong_web_view
    • read_message_contents
    • received_messages
    • received_queue
    • report_music_listen
    • report_read_metrics
    • request_chat_join_web_view
    • request_url_auth
    • send_bot_requested_peer
    • send_web_view_data
    • toggle_bot_in_attach_menu
    • toggle_sticker_sets
    • translate_rich_message
    • accept_encryption
    • check_history_import
    • check_history_import_peer
    • discard_encryption
    • init_history_import
    • read_encrypted_history
    • report_encrypted_spam
    • request_encryption
    • send_encrypted
    • send_encrypted_file
    • send_encrypted_service
    • set_encrypted_typing
    • start_history_import
    • upload_encrypted_file
    • upload_imported_media
    • compose_rich_message_with_ai
    • delete_all_welcome_messages
    • delete_ephemeral_message
    • delete_welcome_message
    • edit_ephemeral_message_caption
    • edit_ephemeral_message_media
    • edit_ephemeral_message_reply_markup
    • edit_ephemeral_message_text
    • get_ephemeral_callback_answer
    • get_welcome_messages
    • report_ephemeral_message
    • send_ephemeral_message
    • create_ai_tone
    • delete_ai_tone
    • get_ai_tone
    • get_ai_tone_example
    • get_ai_tones
    • save_ai_tone
    • update_ai_tone
    • add_chat_members
    • archive_chats
    • ban_chat_member
    • ban_chat_sender_chat
    • close_forum_topic
    • close_general_forum_topic
    • convert_to_gigagroup
    • create_channel
    • create_forum_topic
    • create_group
    • create_supergroup
    • deactivate_chat_usernames
    • delete_all_message_reactions
    • delete_channel
    • delete_chat_photo
    • delete_chat_sticker_set
    • delete_forum_topic
    • delete_message_reaction
    • delete_supergroup
    • delete_user_history
    • edit_chat_location
    • edit_forum_topic
    • edit_general_forum_topic
    • get_chat
    • get_chat_event_log
    • get_chat_member
    • get_chat_members
    • get_chat_members_count
    • get_chat_online_count
    • get_chat_settings
    • get_dialogs
    • get_dialogs_count
    • get_direct_messages_topics
    • get_direct_messages_topics_by_id
    • get_forum_topic_icon_stickers
    • get_forum_topics
    • get_forum_topics_by_id
    • get_inactive_channels
    • get_left_channels
    • get_nearby_chats
    • get_personal_channels
    • get_send_as_chats
    • get_similar_channels
    • get_suitable_discussion_chats
    • get_top_chats
    • hide_general_forum_topic
    • join_chat
    • leave_chat
    • mark_chat_unread
    • pin_chat_message
    • pin_forum_topic
    • promote_chat_member
    • remove_chat_verification
    • remove_user_verification
    • reopen_forum_topic
    • reopen_general_forum_topic
    • reorder_chat_usernames
    • reorder_pinned_forum_topics
    • report_anti_spam_false_positive
    • report_chat
    • report_spam
    • restrict_chat_member
    • restrict_sponsored_messages
    • set_administrator_title
    • set_boosts_to_unblock_restrictions
    • set_chat_accent_color
    • set_chat_custom_emoji_sticker_set
    • set_chat_description
    • set_chat_direct_messages_group
    • set_chat_discussion_group
    • set_chat_member_tag
    • set_chat_permissions
    • set_chat_photo
    • set_chat_protected_content
    • set_chat_sticker_set
    • set_chat_title
    • set_chat_ttl
    • set_chat_username
    • set_main_profile_tab
    • set_send_as_chat
    • set_slow_mode
    • set_upgraded_gift_colors
    • toggle_anti_spam
    • toggle_auto_translation
    • toggle_chat_username
    • toggle_forum
    • toggle_join_request
    • toggle_join_to_send
    • toggle_participants_hidden
    • toggle_pre_history_hidden
    • toggle_signatures
    • toggle_slow_mode
    • toggle_view_forum_as_messages
    • transfer_chat_ownership
    • unarchive_chats
    • unban_chat_member
    • unban_chat_sender_chat
    • unhide_general_forum_topic
    • unpin_all_chat_messages
    • unpin_all_forum_topic_messages
    • unpin_all_general_forum_topic_messages
    • unpin_chat_message
    • unpin_forum_topic
    • update_channel_color
    • update_chat_notifications
    • verify_chat
    • verify_user
    • approve_community_link_request
    • ban_community_participant
    • collapse_community
    • create_community
    • get_community_link_requests
    • get_joined_communities
    • get_participant_joined_community_chats
    • toggle_all_community_link_requests
    • toggle_community_chat_link
    • block_user
    • check_username
    • delete_profile_photos
    • get_chat_audios
    • get_chat_audios_count
    • get_chat_photos
    • get_chat_photos_count
    • get_common_chats
    • get_default_emoji_statuses
    • get_me
    • get_requirements_to_contact
    • get_saved_music_by_id
    • get_users
    • report_profile_photo
    • report_user
    • set_bot_profile_photo
    • set_emoji_status
    • set_personal_channel
    • set_profile_photo
    • set_secure_value_errors
    • set_username
    • unblock_user
    • update_birthday
    • update_profile
    • update_status
    • approve_all_chat_join_requests
    • approve_chat_join_request
    • create_chat_invite_link
    • create_chat_subscription_invite_link
    • decline_all_chat_join_requests
    • decline_chat_join_request
    • delete_chat_admin_invite_links
    • delete_chat_invite_link
    • edit_chat_invite_link
    • edit_chat_subscription_invite_link
    • export_chat_invite_link
    • get_chat_admin_invite_links
    • get_chat_admin_invite_links_count
    • get_chat_admins_with_invite_links
    • get_chat_invite_link
    • get_chat_invite_link_joiners
    • get_chat_invite_link_joiners_count
    • get_chat_join_requests
    • revoke_chat_invite_link
    • accept_contact
    • add_contact
    • block_from_replies
    • delete_contacts
    • delete_contacts_by_phones
    • edit_close_friends
    • export_contact_token
    • get_birthdays
    • get_blocked_message_senders
    • get_contact_ids
    • get_contact_statuses
    • get_contacts
    • get_contacts_count
    • get_saved_contacts
    • get_sponsored_peers
    • import_contact_token
    • import_contacts
    • reset_saved_contacts
    • reset_top_peer_rating
    • resolve_phone
    • search_contacts
    • set_blocked
    • set_contact_note
    • toggle_top_peers
    • upload_contact_profile_photo
    • check_chat_folder_invite_link
    • create_folder
    • create_folder_invite_link
    • delete_folder
    • delete_folder_invite_link
    • edit_folder
    • edit_folder_invite_link
    • get_chatlist_updates
    • get_chats_for_folder_invite_link
    • get_folder_invite_links
    • get_folders
    • get_leave_chatlist_suggestions
    • hide_chatlist_updates
    • join_chatlist_updates
    • join_folder
    • leave_folder
    • reorder_folders
    • toggle_folder_tags
    • change_cloud_password
    • enable_cloud_password
    • remove_cloud_password
    • add_bot_preview_media
    • add_bot_username
    • allow_bot_send_message
    • answer_callback_query
    • answer_chat_join_request_query
    • answer_guest_query
    • answer_inline_query
    • answer_pre_checkout_query
    • answer_shipping_query
    • answer_web_app_query
    • answer_webhook_json_query
    • can_bot_send_message
    • check_bot_username
    • check_download_file_params
    • create_bot
    • create_invoice_link
    • delete_bot_commands
    • delete_bot_preview_media
    • edit_bot_preview_media
    • edit_user_star_subscription
    • get_admined_bots
    • get_bot_commands
    • get_bot_default_privileges
    • get_bot_info
    • get_bot_info_description
    • get_bot_info_short_description
    • get_bot_name
    • get_bot_preview_info
    • get_bot_preview_medias
    • get_bot_recommendations
    • get_chat_menu_button
    • get_game_high_scores
    • get_inline_bot_results
    • get_managed_bot_access_settings
    • get_managed_bot_token
    • get_owned_bots
    • get_popular_app_bots
    • get_requested_web_view_button
    • invoke_web_view_custom_method
    • refund_star_payment
    • reorder_bot_preview_medias
    • reorder_bot_usernames
    • remove_bot_username
    • replace_managed_bot_token
    • request_callback_answer
    • request_web_view_button
    • send_chat_join_request_web_app
    • send_custom_request
    • send_game
    • send_inline_bot_result
    • send_invoice
    • set_bot_commands
    • set_bot_default_privileges
    • set_bot_info_description
    • set_bot_info_short_description
    • set_bot_name
    • set_chat_menu_button
    • set_game_score
    • set_managed_bot_access_settings
    • toggle_bot_username
    • toggle_user_emoji_status_permission
    • update_star_ref_program
    • update_user_emoji_status
    • create_business_chat_link
    • delete_business_chat_link
    • delete_business_messages
    • get_business_account_gifts
    • get_business_account_star_balance
    • get_business_chat_links
    • get_business_connection
    • get_connected_bots
    • read_business_message
    • remove_business_account_profile_photo
    • resolve_business_chat_link
    • set_business_account_bio
    • set_business_account_gift_settings
    • set_business_account_name
    • set_business_account_profile_photo
    • set_business_account_username
    • transfer_business_account_stars
    • update_business_away_message
    • update_business_greeting_message
    • update_business_intro
    • update_business_location
    • update_business_work_hours
    • add_collection_gifts
    • apply_gift_code
    • assign_app_store_transaction
    • assign_play_market_transaction
    • buy_gift_upgrade
    • can_purchase_store
    • check_can_send_gift
    • check_gift_code
    • clear_saved_info
    • connect_star_ref_bot
    • convert_gift_to_stars
    • craft_gift
    • create_gift_collection
    • create_onramp_session
    • delete_gift_collection
    • drop_gift_original_details
    • edit_connected_star_ref_bot
    • edit_star_subscription
    • get_available_gifts
    • get_bank_card_data
    • get_chat_gifts
    • get_chat_gifts_count
    • get_connected_star_ref_bot
    • get_connected_star_ref_bots
    • get_currency_rates
    • get_gift_auction_state
    • get_gift_collections
    • get_gift_upgrade_preview
    • get_gift_upgrade_variants
    • get_gifts_for_crafting
    • get_giveaway_info
    • get_onramp_availability
    • get_onramp_base_currencies
    • get_onramp_limits
    • get_onramp_providers
    • get_onramp_quote
    • get_payment_form
    • get_payment_receipt
    • get_premium_gift_code_options
    • get_received_gifts
    • get_received_gifts_count
    • get_saved_info
    • get_saved_star_gift
    • get_star_gift_active_auctions
    • get_star_gift_auction_acquired_gifts
    • get_star_gift_withdrawal_url
    • get_stars_balance
    • get_stars_gift_options
    • get_stars_giveaway_options
    • get_stars_revenue_ads_account_url
    • get_stars_revenue_stats
    • get_stars_revenue_withdrawal_url
    • get_stars_subscriptions
    • get_stars_topup_options
    • get_stars_transactions
    • get_stars_transactions_by_id
    • get_suggested_star_ref_bots
    • get_ton_balance
    • get_upgraded_gift
    • get_upgraded_gift_value_info
    • gift_premium_with_stars
    • hide_gift
    • increase_gift_auction_bid
    • launch_prepaid_giveaway
    • place_gift_auction_bid
    • process_gift_purchase_offer
    • remove_collection_gifts
    • reorder_collection_gifts
    • reorder_gift_collections
    • reuse_star_subscription
    • search_gifts_for_resale
    • send_gift
    • send_gift_purchase_offer
    • send_payment_form
    • send_resold_gift
    • set_gift_collection_name
    • set_gift_resale_price
    • set_pinned_gifts
    • show_gift
    • suggest_birthday
    • toggle_chat_star_gift_notifications
    • transfer_gift
    • upgrade_gift
    • validate_requested_info
    • can_post_stories
    • copy_story
    • copy_story_album
    • create_story_album
    • delete_stories
    • delete_story_album
    • edit_story_caption
    • edit_story_media
    • edit_story_privacy
    • enable_stealth_mode
    • export_story_link
    • forward_story
    • get_all_read_peer_stories
    • get_all_stories
    • get_archived_stories
    • get_chat_stories
    • get_chats_to_send_stories
    • get_peer_max_story_ids
    • get_pinned_stories
    • get_stories
    • get_stories_views
    • get_story_album_stories
    • get_story_albums
    • get_story_reactions_list
    • get_story_views
    • hide_chat_stories
    • pin_chat_stories
    • read_chat_stories
    • reorder_story_albums
    • report_story
    • repost_story
    • search_stories
    • send_story
    • send_story_reaction
    • show_chat_stories
    • start_live_story
    • toggle_all_stories_hidden
    • toggle_stories_pinned_to_top
    • unpin_chat_stories
    • update_story_album
    • view_stories
    • add_favorite_sticker
    • add_recent_sticker
    • add_sticker_to_set
    • change_sticker_set
    • check_sticker_set_short_name
    • clear_recent_stickers
    • create_new_sticker_set
    • delete_sticker_from_set
    • delete_sticker_set
    • get_favorite_stickers
    • get_owned_sticker_sets
    • get_recent_stickers
    • get_sticker_set
    • get_suggested_sticker_set_name
    • remove_favorite_sticker
    • remove_recent_sticker
    • reorder_installed_sticker_sets
    • replace_sticker_in_set
    • search_sticker_sets
    • search_stickers
    • set_custom_emoji_sticker_set_thumbnail
    • set_sticker_emoji_list
    • set_sticker_keywords
    • set_sticker_mask_position
    • set_sticker_position_in_set
    • set_sticker_set_thumbnail
    • set_sticker_set_title
    • upload_sticker_file
    • finish_sms_job
    • get_sms_job
    • get_sms_jobs_status
    • is_eligible_to_join_sms_jobs
    • join_sms_jobs
    • leave_sms_jobs
    • update_sms_jobs_settings
    • accept_call
    • change_call_volume
    • check_group_call
    • confirm_call
    • create_conference_call
    • decline_conference_call_invite
    • delete_conference_call_participants
    • delete_group_call_messages
    • delete_group_call_participant_messages
    • decline_call
    • edit_group_call_participant
    • edit_group_call_settings
    • edit_group_call_title
    • end_group_call
    • export_group_call_invite
    • get_call_config
    • get_call_members
    • get_group_call
    • get_group_call_chain_blocks
    • get_group_call_join_as
    • get_group_call_settings
    • get_group_call_stars
    • get_group_call_stream_channels
    • get_group_call_stream_rtmp_url
    • invite_conference_call_participant
    • invite_to_group_call
    • join_group_call
    • join_group_call_presentation
    • leave_group_call
    • leave_group_call_presentation
    • pause_stream
    • play_audio
    • play_video
    • received_call
    • request_call
    • resume_stream
    • save_call_debug
    • save_call_log
    • save_default_group_call_join_as
    • save_default_send_as
    • send_conference_call_broadcast
    • send_group_call_encrypted_message
    • send_group_call_message
    • send_signaling_data
    • set_call_rating
    • start_group_call
    • start_group_call_record
    • start_scheduled_group_call
    • stop_group_call_record
    • subscribe_to_group_call
    • unsubscribe_from_group_call
    • get_broadcast_stats
    • get_megagroup_stats
    • get_message_public_forwards
    • get_message_stats
    • get_story_public_forwards
    • get_story_stats
    • load_async_graph
    • apply_boost
    • get_boosts
    • get_boosts_list
    • get_boosts_status
    • get_user_boosts
    • on_business_connection
    • on_business_message
    • on_callback_query
    • on_chat_boost
    • on_chat_join_request
    • on_chat_left
    • on_chat_member_updated
    • on_chosen_inline_result
    • on_connect
    • on_deleted_business_messages
    • on_deleted_messages
    • on_disconnect
    • on_edited_business_message
    • on_edited_message
    • on_error
    • on_guest_message
    • on_inline_query
    • on_managed_bot
    • on_message
    • on_message_generation_stopped
    • on_message_reaction
    • on_message_reaction_count
    • on_poll
    • on_pre_checkout_query
    • on_purchased_paid_media
    • on_raw_update
    • on_shipping_query
    • on_start
    • on_stop
    • on_story
    • on_stream_end
    • on_stream_start
    • on_user_status
    • accept_login_token
    • accept_terms_of_service
    • bind_temp_auth_key
    • cancel_code
    • cancel_web_token_authorization
    • change_phone_number
    • check_paid_auth
    • check_password
    • check_recovery_password
    • connect
    • disconnect
    • drop_temp_auth_keys
    • export_authorization
    • export_login_token
    • finish_firebase_pnv_login
    • finish_passkey_login
    • firebase_pnv_sign_up
    • get_active_sessions
    • get_password_hint
    • import_authorization
    • import_login_token
    • import_web_token_authorization
    • init_firebase_pnv_login
    • init_passkey_login
    • initialize
    • log_out
    • recover_password
    • report_missing_code
    • request_firebase_sms
    • resend_code
    • resend_phone_number_code
    • reset_login_email
    • reset_session
    • reset_sessions
    • send_code
    • send_phone_number_code
    • send_recovery_code
    • sign_in
    • sign_in_bot
    • sign_up
    • terminate
    • get_collectible_info
    • get_file_hashes
    • get_session
    • get_web_file
    • init_connection
    • invoke
    • invoke_after_msg
    • invoke_after_msgs
    • invoke_with_apns_secret
    • invoke_with_google_play_integrity
    • invoke_with_layer
    • invoke_with_messages_range
    • recover_gaps
    • resolve_peer
    • save_file
    • set_dc
  • Available Types
    • User
    • Chat
    • ChatPreview
    • ChatPhoto
    • AnimatedChatPhoto
    • ChatPhotoSticker
    • ChatMember
    • ChatPermissions
    • ChatPrivileges
    • ChatLocation
    • ChatInviteLink
    • ChatAdminWithInviteLinks
    • ChatEvent
    • ChatEventFilter
    • ChatMemberUpdated
    • ChatJoinRequest
    • ChatJoiner
    • Dialog
    • Restriction
    • EmojiStatus
    • BackgroundFillFreeformGradient
    • BackgroundFillGradient
    • BackgroundFillSolid
    • BackgroundTypeChatTheme
    • BackgroundTypeFill
    • BackgroundTypePattern
    • BackgroundTypeWallpaper
    • Birthday
    • BusinessConnection
    • BusinessIntro
    • BusinessRecipients
    • BusinessWorkingHours
    • BusinessWeeklyOpen
    • ChatAdministratorRights
    • ChatColor
    • ChatJoinResult
    • ChatSettings
    • Folder
    • FolderInviteLink
    • FoundContacts
    • GlobalPrivacySettings
    • GroupCallMember
    • HistoryCleared
    • InviteLinkImporter
    • PhoneCallEnded
    • PhoneCallStarted
    • PrivacyRule
    • StoriesStealthMode
    • StoryAlbum
    • ContactBirthday
    • SavedPhoneContact
    • UserRating
    • AcceptedGiftTypes
    • BotVerification
    • BusinessBotRights
    • ChatFolderInviteLinkInfo
    • ChatFullInfo
    • ChatJoinResultDeclined
    • ChatJoinResultGuardBotApprovalRequired
    • ChatJoinResultRequestSent
    • ChatJoinResultSuccess
    • Community
    • CommunityChatAdded
    • CommunityChatJoined
    • CommunityChatRemoved
    • FailedToAddMember
    • Link
    • Username
    • UserTonWalletAddress
    • VerificationStatus
    • TonConnectSession
    • WalletGaslessInfo
    • WalletState
    • WalletTransaction
    • Message
    • MessageEntity
    • MessageGenerationStopped
    • Photo
    • Thumbnail
    • Audio
    • Document
    • Animation
    • Video
    • VideoQuality
    • Voice
    • VideoNote
    • Contact
    • Location
    • Venue
    • Sticker
    • StickerSet
    • Game
    • WebPage
    • Poll
    • PollOption
    • Dice
    • Reaction
    • ReadParticipantDate
    • VideoChatScheduled
    • VideoChatStarted
    • VideoChatEnded
    • VideoChatMembersInvited
    • GroupCall
    • GroupCallSettings
    • MediaStream
    • WebAppData
    • MessageReactions
    • MessagePeerReaction
    • ChatReactions
    • AvailableEffect
    • BoostsStatus
    • BusinessMessage
    • ChatBackground
    • ChatBoost
    • Checklist
    • ChecklistTask
    • ChecklistTasksAdded
    • ChecklistTasksDone
    • ContactRegistered
    • DirectMessagePriceChanged
    • DirectMessagesTopic
    • EphemeralMessageParameters
    • ExternalReplyInfo
    • FactCheck
    • File
    • FormattedText
    • ForumTopic
    • ForumTopicClosed
    • ForumTopicCreated
    • ForumTopicEdited
    • ForumTopicReopened
    • GeneralForumTopicHidden
    • GeneralForumTopicUnhidden
    • Gift
    • GiftAttribute
    • GiftBackground
    • GiftAuction
    • GiftAuctionState
    • GiftCollection
    • GiftedPremium
    • GiftedStars
    • GiftedGrams
    • Giveaway
    • GiveawayCompleted
    • GiveawayCreated
    • GiveawayPrizeStars
    • GiveawayWinners
    • GramTransfer
    • InputChecklistTask
    • Invoice
    • LinkPreviewOptions
    • LivePhoto
    • ManagedBotCreated
    • MaskPosition
    • MediaArea
    • MessageContent
    • MessageOrigin
    • MessageOriginChannel
    • MessageOriginChat
    • MessageOriginHiddenUser
    • MessageOriginImport
    • MessageOriginUser
    • MyBoost
    • PaidMediaInfo
    • PaidMediaPreview
    • PaidMessagesPriceChanged
    • PaidMessagesRefunded
    • PaidReactor
    • PaymentForm
    • PaymentOption
    • PollOptionAdded
    • PollOptionDeleted
    • PremiumGiftCode
    • ProximityAlertTriggered
    • RefundedPayment
    • ReplyParameters
    • RestrictionReason
    • RichBlock
    • RichMessage
    • RichMessageButton
    • RichText
    • ScreenshotTaken
    • StarAmount
    • StarsRevenueStats
    • StarsRevenueStatus
    • StarsTransaction
    • Story
    • StoryView
    • StrippedThumbnail
    • SuggestedPostApprovalFailed
    • SuggestedPostApproved
    • SuggestedPostDeclined
    • SuggestedPostInfo
    • SuggestedPostPaid
    • SuggestedPostParameters
    • SuggestedPostPrice
    • SuggestedPostRefunded
    • TextQuote
    • TranscribedAudio
    • UpgradedGiftAttributeId
    • UpgradedGiftAttributeIdBackdrop
    • UpgradedGiftAttributeIdModel
    • UpgradedGiftAttributeIdSymbol
    • UpgradedGiftAttributeRarity
    • UpgradedGiftOriginalDetails
    • UpgradedGiftPurchaseOffer
    • UpgradedGiftValueInfo
    • WalletTonConnectRequest
    • WriteAccessAllowed
    • AuctionBid
    • AuctionRound
    • AuctionState
    • AuctionStateActive
    • AuctionStateFinished
    • ChatHasProtectedContentDisableRequested
    • ChatHasProtectedContentToggled
    • ChatOwnerChanged
    • ChatOwnerLeft
    • ChatTheme
    • CheckedGiftCode
    • CraftGiftResult
    • CraftGiftResultFail
    • CraftGiftResultSuccess
    • GiftPurchaseLimit
    • GiftResaleParameters
    • GiftResalePrice
    • GiftResalePriceStar
    • GiftResalePriceTon
    • GiftUpgradePreview
    • GiftUpgradePrice
    • GiftUpgradeVariants
    • PaymentResult
    • PollStats
    • RichBlockAnchor
    • RichBlockAnimation
    • RichBlockAudio
    • RichBlockBlockQuotation
    • RichBlockButtons
    • RichBlockCaption
    • RichBlockCollage
    • RichBlockDetails
    • RichBlockDivider
    • RichBlockDocument
    • RichBlockExpandableBlockQuotation
    • RichBlockFooter
    • RichBlockList
    • RichBlockListItem
    • RichBlockMap
    • RichBlockMathematicalExpression
    • RichBlockParagraph
    • RichBlockPhoto
    • RichBlockPreformatted
    • RichBlockPullQuotation
    • RichBlockSectionHeading
    • RichBlockSlideshow
    • RichBlockTable
    • RichBlockTableCell
    • RichBlockThinking
    • RichBlockUnsupported
    • RichBlockVideo
    • RichBlockVoiceNote
    • RichTextAnchor
    • RichTextAnchorLink
    • RichTextBankCardNumber
    • RichTextBold
    • RichTextButton
    • RichTextBotCommand
    • RichTextCashtag
    • RichTextCode
    • RichTextCustomEmoji
    • RichTextDateTime
    • RichTextDiff
    • RichTextEmailAddress
    • RichTextHashtag
    • RichTextImage
    • RichTextItalic
    • RichTextMarked
    • RichTextMathematicalExpression
    • RichTextMention
    • RichTextPhoneNumber
    • RichTextReference
    • RichTextReferenceLink
    • RichTextSpoiler
    • RichTextStrikethrough
    • RichTextSubscript
    • RichTextSuperscript
    • RichTextTextMention
    • RichTextTonAddress
    • RichTextUnderline
    • RichTextUnsupported
    • RichTextUrl
    • SavedCredentials
    • Str
    • SuccessfulPayment
    • SuggestedPostPriceStar
    • SuggestedPostPriceTon
    • UpgradedGiftAttributeRarityEpic
    • UpgradedGiftAttributeRarityLegendary
    • UpgradedGiftAttributeRarityPerMille
    • UpgradedGiftAttributeRarityRare
    • UpgradedGiftAttributeRarityUncommon
    • UpgradedGiftPurchaseOfferRejected
    • ReplyKeyboardMarkup
    • KeyboardButton
    • ReplyKeyboardRemove
    • InlineKeyboardMarkup
    • InlineKeyboardButton
    • CopyTextButton
    • DisabledButton
    • SwitchInlineQueryChosenChat
    • LoginUrl
    • ForceReply
    • CallbackQuery
    • GameHighScore
    • CallbackGame
    • WebAppInfo
    • MenuButton
    • MenuButtonCommands
    • MenuButtonWebApp
    • MenuButtonDefault
    • SentWebAppMessage
    • BotCommand
    • BotCommandScope
    • BotCommandScopeDefault
    • BotCommandScopeAllPrivateChats
    • BotCommandScopeAllGroupChats
    • BotCommandScopeAllChatAdministrators
    • BotCommandScopeChat
    • BotCommandScopeChatAdministrators
    • BotCommandScopeChatMember
    • BotAccessSettings
    • BotDescription
    • BotName
    • BotShortDescription
    • ChatBoostUpdated
    • ChatShared
    • KeyboardButtonPollType
    • KeyboardButtonRequestChat
    • KeyboardButtonRequestManagedBot
    • KeyboardButtonRequestUsers
    • LabeledPrice
    • ManagedBotUpdated
    • MessageReactionCountUpdated
    • MessageReactionUpdated
    • OrderInfo
    • PreCheckoutQuery
    • PurchasedPaidMedia
    • SentGuestMessage
    • ShippingAddress
    • ShippingOption
    • ShippingQuery
    • UsersShared
    • InlineQuery
    • InlineQueryResult
    • InlineQueryResultCachedAudio
    • InlineQueryResultCachedDocument
    • InlineQueryResultCachedAnimation
    • InlineQueryResultCachedPhoto
    • InlineQueryResultCachedSticker
    • InlineQueryResultCachedVideo
    • InlineQueryResultCachedVoice
    • InlineQueryResultArticle
    • InlineQueryResultAudio
    • InlineQueryResultContact
    • InlineQueryResultDocument
    • InlineQueryResultAnimation
    • InlineQueryResultLocation
    • InlineQueryResultPhoto
    • InlineQueryResultVenue
    • InlineQueryResultVideo
    • InlineQueryResultVoice
    • ChosenInlineResult
    • InputMedia
    • InputMediaPhoto
    • InputMediaVideo
    • InputMediaAudio
    • InputMediaAnimation
    • InputMediaDocument
    • InputPhoneContact
    • InputChatPhoto
    • InputChecklist
    • InputCredentials
    • InputCredentialsApplePay
    • InputCredentialsGooglePay
    • InputCredentialsNew
    • InputCredentialsSaved
    • InputInvoice
    • InputInvoiceMessage
    • InputInvoiceMessageContent
    • InputInvoiceName
    • InputMediaLink
    • InputMediaLivePhoto
    • InputMediaLocation
    • InputMediaSticker
    • InputSticker
    • InputMediaVenue
    • InputMessageContent
    • InputPollMedia
    • InputPollOption
    • InputPollOptionMedia
    • InputPrivacyRule
    • InputPrivacyRuleAllowAll
    • InputPrivacyRuleAllowBots
    • InputPrivacyRuleAllowChats
    • InputPrivacyRuleAllowCloseFriends
    • InputPrivacyRuleAllowContacts
    • InputPrivacyRuleAllowPremium
    • InputPrivacyRuleAllowUsers
    • InputPrivacyRuleDisallowAll
    • InputPrivacyRuleDisallowBots
    • InputPrivacyRuleDisallowChats
    • InputPrivacyRuleDisallowContacts
    • InputPrivacyRuleDisallowUsers
    • InputRichMessage
    • InputRichMessageContent
    • InputTextMessageContent
    • InputContactMessageContent
    • InputLocationMessageContent
    • InputVenueMessageContent
    • InputChatPhotoAnimation
    • InputChatPhotoPrevious
    • InputChatPhotoStatic
    • InputMediaVoiceNote
    • InputRichBlock
    • InputRichBlockAnchor
    • InputRichBlockAnimation
    • InputRichBlockAudio
    • InputRichBlockBlockQuotation
    • InputRichBlockButtons
    • InputRichBlockCollage
    • InputRichBlockDetails
    • InputRichBlockDivider
    • InputRichBlockDocument
    • InputRichBlockExpandableBlockQuotation
    • InputRichBlockFooter
    • InputRichBlockList
    • InputRichBlockListItem
    • InputRichBlockMap
    • InputRichBlockMathematicalExpression
    • InputRichBlockParagraph
    • InputRichBlockPhoto
    • InputRichBlockPreformatted
    • InputRichBlockPullQuotation
    • InputRichBlockSectionHeading
    • InputRichBlockSlideshow
    • InputRichBlockTable
    • InputRichBlockTableCell
    • InputRichBlockThinking
    • InputRichBlockVideo
    • InputRichBlockVoiceNote
    • InputRichMessageMedia
    • Identifier
    • Listener
    • SentCode
    • TermsOfService
    • ActiveSession
    • ActiveSessions
    • FirebaseAuthenticationSettings
    • PhoneNumberAuthenticationSettings
    • List
    • FirebaseAuthenticationSettingsAndroid
    • FirebaseAuthenticationSettingsIos
  • Enums
    • BlockAlignment
    • BlockList
    • BusinessSchedule
    • ButtonStyle
    • RichButtonStyle
    • ChatAction
    • ChatEventAction
    • ChatJoinRequestQueryResult
    • ListenerTypes
    • ChatJoinType
    • ChatMemberStatus
    • ChatMembersFilter
    • ChatPhotoStickerType
    • ChatType
    • ClientPlatform
    • FolderColor
    • GiftAttributeType
    • GiftForResaleOrder
    • GiftPurchaseOfferState
    • GiftType
    • MaskPointType
    • MediaAreaType
    • MessageEntityType
    • MessageMediaType
    • MessageOriginType
    • MessageServiceType
    • MessagesFilter
    • NextCodeType
    • PaidReactionPrivacy
    • ParseMode
    • PaymentFormType
    • PhoneCallDiscardReason
    • PhoneNumberCodeType
    • PollType
    • PrivacyKey
    • PrivacyRuleType
    • ProfileColor
    • ProfileTab
    • ProxyScheme
    • ReplyColor
    • ReportReason
    • SentCodeType
    • StickerFormat
    • StickerType
    • StoriesPrivacyRules
    • StreamType
    • SuggestedPostRefundReason
    • SuggestedPostState
    • TopChatCategory
    • UpgradedGiftOrigin
    • UserStatus
  • Bound Methods
    • click
    • delete
    • delete_ephemeral
    • edit_ephemeral_text
    • edit_ephemeral_caption
    • edit_ephemeral_media
    • edit_ephemeral_reply_markup
    • reply_ephemeral_text
    • download
    • forward
    • copy
    • copy_media_group
    • pin
    • unpin
    • edit
    • edit_text
    • edit_caption
    • edit_media
    • edit_reply_markup
    • reply
    • reply_text
    • reply_animation
    • reply_audio
    • reply_cached_media
    • reply_chat_action
    • reply_checklist
    • reply_contact
    • reply_dice
    • reply_document
    • reply_game
    • reply_inline_bot_result
    • reply_invoice
    • reply_live_photo
    • reply_location
    • reply_media_group
    • reply_paid_media
    • reply_photo
    • reply_poll
    • reply_rich
    • reply_sticker
    • reply_venue
    • reply_video
    • reply_video_note
    • reply_voice
    • answer
    • answer_animation
    • answer_audio
    • answer_cached_media
    • answer_checklist
    • answer_contact
    • answer_dice
    • answer_document
    • answer_game
    • answer_inline_bot_result
    • answer_invoice
    • answer_live_photo
    • answer_location
    • answer_media_group
    • answer_paid_media
    • answer_photo
    • answer_poll
    • answer_rich
    • answer_sticker
    • answer_venue
    • answer_video
    • answer_video_note
    • answer_voice
    • get_media_group
    • get_reactions
    • get_read_participants
    • react
    • report
    • wait_for_click
    • read
    • view
    • vote
    • pay
    • retract_vote
    • edit_checklist
    • edit_live_location
    • stop_live_location
    • summarize
    • transcribe
    • content
    • link
    • html_text
    • md_text
    • forward_date
    • forward_from
    • forward_from_chat
    • forward_from_message_id
    • forward_sender_name
    • forward_signature
    • is_topic_message
    • archive
    • ask
    • listen
    • stop_listening
    • unarchive
    • set_title
    • set_description
    • set_photo
    • ban_member
    • unban_member
    • restrict_member
    • promote_member
    • get_member
    • get_members
    • add_members
    • join
    • leave
    • mark_unread
    • set_protected_content
    • unpin_all_messages
    • report
    • report_spam
    • mute
    • unmute
    • set_ttl
    • export_invite_link
    • play
    • play_audio
    • play_video
    • join_group_call
    • leave_group_call
    • pause_stream
    • resume_stream
    • change_call_volume
    • get_group_call
    • get_group_call_settings
    • start_group_call
    • end_group_call
    • edit_group_call_title
    • export_group_call_invite
    • get_group_call_stream_rtmp_url
    • invite_to_group_call
    • start_scheduled_group_call
    • start_recording
    • stop_recording
    • edit_group_call_participant
    • edit_group_call_settings
    • full_name
    • is_fake
    • is_scam
    • is_verified
    • archive
    • unarchive
    • block
    • unblock
    • full_name
    • is_fake
    • is_scam
    • is_verified
    • mention
    • report
    • get_common_chats
    • answer
    • edit_message_text
    • edit_message_caption
    • edit_message_media
    • edit_message_reply_markup
    • answer
    • approve
    • decline
    • copy
    • delete
    • download
    • edit_caption
    • edit_media
    • edit_privacy
    • forward
    • link
    • react
    • read
    • report
    • view
    • reply_text
    • reply_animation
    • reply_audio
    • reply_cached_media
    • reply_media_group
    • reply_photo
    • reply_sticker
    • reply_video
    • reply_video_note
    • reply_voice
    • buy
    • send
    • transfer
    • upgrade
    • convert
    • hide
    • show
    • link
    • wear
    • owned_gift_id
    • send_purchase_offer
    • get_auction_state
    • get_vote_percentage
    • answer
    • answer
    • create_invite_link
    • delete
    • edit
    • exclude_chat
    • include_chat
    • pin_chat
    • remove_chat
    • update_color
    • start_recording
    • stop_recording
    • end
    • edit_title
    • edit_settings
    • get_settings
  • Update Handlers
  • Filters
  • Storage
  • Errors
  • Enumerations

Concepts

  • MTProto vs. Bot API
  • Message identifiers
  • Text Formatting
  • Rich Text Formatting
  • Object Serialization
  • Reporting Abuse & Content

Updates & Filters

  • Using Filters
  • Creating Filters
  • More on Updates
  • Smart Plugins

Configuration

  • Client Settings
  • Storage Engines
  • Proxy Settings
  • MTProxy Settings
  • Web Proxy Settings
  • Scheduling Tasks
  • Test Servers
  • Synchronous Usage

Advanced

  • Advanced Usage
  • Speedups
  • Voice & Video Calls
  • Voice Calls
  • Debugging

Help

  • FAQ

Telegram Raw API

  • Raw Functions
  • Raw Types
  • Raw Base
  • Home »
  • Raw Functions »
  • Messages »
  • messages.GetSponsoredMessages
View on GitHub
Star
Used by
Back to top

messages.GetSponsoredMessages¶

class pyrogram.raw.functions.messages.GetSponsoredMessages[source]¶

Get a list of sponsored messages for a peer, see here » for more info.

Usable by Users Bots
Details:
  • Layer: 230

  • ID: 3D6CE850

Parameters:
  • peer (InputPeer) – The currently open channel/bot.

  • msg_id (int 32-bit, optional) – Must be set when fetching sponsored messages to show on channel videos ».

Returns:

messages.SponsoredMessages

Next
messages.GetStickerSet
Previous
messages.GetSplitRanges
Copyright © 2017-present Dan, TobiBotz
Made with Sphinx and @pradyunsg's Furo
On this page
  • messages.GetSponsoredMessages
    • GetSponsoredMessages