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

Getting started

  • Quickstart
  • Complete examples

Guides

  • Routers and handlers
  • Filters
  • Keyboards
  • Formatting
  • FSM and scene-style flows
  • Polling
  • Webhook
  • Writing multi-platform bots
  • Migration from aiogram

Platform information

  • Platform capabilities

API reference

  • API reference
  • Bot API
  • Neutral types API
  • Filters API
  • Keyboard API
  • Formatting API
  • Webhook API
  • FSM API
    • peyk.fsm
      • peyk.fsm.context
      • peyk.fsm.middleware
      • peyk.fsm.state
      • peyk.fsm.storage
        • peyk.fsm.storage.base
        • peyk.fsm.storage.isolation
        • peyk.fsm.storage.memory
        • peyk.fsm.storage.redis
  • Flags API
  • Utilities API
  • Bale API
    • peyk.platforms.bale.types
      • peyk.platforms.bale.types.animation
      • peyk.platforms.bale.types.audio
      • peyk.platforms.bale.types.callback_query
      • peyk.platforms.bale.types.chat
      • peyk.platforms.bale.types.chat_member
      • peyk.platforms.bale.types.chat_member_administrator
      • peyk.platforms.bale.types.chat_member_member
      • peyk.platforms.bale.types.chat_member_owner
      • peyk.platforms.bale.types.chat_member_restricted
      • peyk.platforms.bale.types.chat_photo
      • peyk.platforms.bale.types.contact
      • peyk.platforms.bale.types.copy_text_button
      • peyk.platforms.bale.types.document
      • peyk.platforms.bale.types.file
      • peyk.platforms.bale.types.inline_keyboard_button
      • peyk.platforms.bale.types.inline_keyboard_markup
      • peyk.platforms.bale.types.input_media_animation
      • peyk.platforms.bale.types.input_media_audio
      • peyk.platforms.bale.types.input_media_document
      • peyk.platforms.bale.types.input_media_item
      • peyk.platforms.bale.types.input_media_photo
      • peyk.platforms.bale.types.input_media_video
      • peyk.platforms.bale.types.invoice
      • peyk.platforms.bale.types.keyboard_button
      • peyk.platforms.bale.types.labeled_price
      • peyk.platforms.bale.types.location
      • peyk.platforms.bale.types.media_input
      • peyk.platforms.bale.types.message
      • peyk.platforms.bale.types.message_entity
      • peyk.platforms.bale.types.message_id
      • peyk.platforms.bale.types.photo_size
      • peyk.platforms.bale.types.pre_checkout_query
      • peyk.platforms.bale.types.reply_keyboard_markup
      • peyk.platforms.bale.types.reply_keyboard_remove
      • peyk.platforms.bale.types.response_parameters
      • peyk.platforms.bale.types.sticker
      • peyk.platforms.bale.types.sticker_set
      • peyk.platforms.bale.types.successful_payment
      • peyk.platforms.bale.types.transaction
      • peyk.platforms.bale.types.update
      • peyk.platforms.bale.types.user
      • peyk.platforms.bale.types.video
      • peyk.platforms.bale.types.voice
      • peyk.platforms.bale.types.web_app_data
      • peyk.platforms.bale.types.web_app_info
      • peyk.platforms.bale.types.webhook_info
    • peyk.platforms.bale.methods
      • peyk.platforms.bale.methods.add_sticker_to_set
      • peyk.platforms.bale.methods.answer_callback_query
      • peyk.platforms.bale.methods.answer_pre_checkout_query
      • peyk.platforms.bale.methods.ask_review
      • peyk.platforms.bale.methods.ban_chat_member
      • peyk.platforms.bale.methods.close_bot
      • peyk.platforms.bale.methods.copy_message
      • peyk.platforms.bale.methods.create_chat_invite_link
      • peyk.platforms.bale.methods.create_invoice_link
      • peyk.platforms.bale.methods.create_new_sticker_set
      • peyk.platforms.bale.methods.delete_webhook
      • peyk.platforms.bale.methods.edit_message_caption
      • peyk.platforms.bale.methods.edit_message_reply_markup
      • peyk.platforms.bale.methods.edit_message_text
      • peyk.platforms.bale.methods.export_chat_invite_link
      • peyk.platforms.bale.methods.forward_message
      • peyk.platforms.bale.methods.get_chat_administrators
      • peyk.platforms.bale.methods.get_chat_members_count
      • peyk.platforms.bale.methods.get_updates
      • peyk.platforms.bale.methods.inquire_transaction
      • peyk.platforms.bale.methods.logout
      • peyk.platforms.bale.methods.pin_chat_message
      • peyk.platforms.bale.methods.promote_chat_member
      • peyk.platforms.bale.methods.revoke_chat_invite_link
      • peyk.platforms.bale.methods.send_animation
      • peyk.platforms.bale.methods.send_audio
      • peyk.platforms.bale.methods.send_chat_action
      • peyk.platforms.bale.methods.send_contact
      • peyk.platforms.bale.methods.send_document
      • peyk.platforms.bale.methods.send_invoice
      • peyk.platforms.bale.methods.send_location
      • peyk.platforms.bale.methods.send_media_group
      • peyk.platforms.bale.methods.send_message
      • peyk.platforms.bale.methods.send_photo
      • peyk.platforms.bale.methods.send_video
      • peyk.platforms.bale.methods.send_voice
      • peyk.platforms.bale.methods.set_chat_description
      • peyk.platforms.bale.methods.set_chat_photo
      • peyk.platforms.bale.methods.set_webhook
      • peyk.platforms.bale.methods.unpin_chat_message
      • peyk.platforms.bale.methods.upload_sticker_file
  • Telegram API
    • peyk.platforms.telegram.types
      • peyk.platforms.telegram.types.accepted_gift_types
      • peyk.platforms.telegram.types.affiliate_info
      • peyk.platforms.telegram.types.animation
      • peyk.platforms.telegram.types.audio
      • peyk.platforms.telegram.types.background_fill_freeform_gradient
      • peyk.platforms.telegram.types.background_fill_gradient
      • peyk.platforms.telegram.types.background_fill_solid
      • peyk.platforms.telegram.types.background_type_chat_theme
      • peyk.platforms.telegram.types.background_type_fill
      • peyk.platforms.telegram.types.background_type_pattern
      • peyk.platforms.telegram.types.background_type_wallpaper
      • peyk.platforms.telegram.types.birthdate
      • peyk.platforms.telegram.types.bot_access_settings
      • peyk.platforms.telegram.types.bot_command
      • peyk.platforms.telegram.types.bot_command_scope_all_chat_administrators
      • peyk.platforms.telegram.types.bot_command_scope_all_group_chats
      • peyk.platforms.telegram.types.bot_command_scope_all_private_chats
      • peyk.platforms.telegram.types.bot_command_scope_chat
      • peyk.platforms.telegram.types.bot_command_scope_chat_administrators
      • peyk.platforms.telegram.types.bot_command_scope_chat_member
      • peyk.platforms.telegram.types.bot_command_scope_default
      • peyk.platforms.telegram.types.bot_description
      • peyk.platforms.telegram.types.bot_name
      • peyk.platforms.telegram.types.bot_short_description
      • peyk.platforms.telegram.types.bot_subscription_updated
      • peyk.platforms.telegram.types.business_bot_rights
      • peyk.platforms.telegram.types.business_connection
      • peyk.platforms.telegram.types.business_intro
      • peyk.platforms.telegram.types.business_location
      • peyk.platforms.telegram.types.business_messages_deleted
      • peyk.platforms.telegram.types.business_opening_hours
      • peyk.platforms.telegram.types.business_opening_hours_interval
      • peyk.platforms.telegram.types.callback_game
      • peyk.platforms.telegram.types.callback_query
      • peyk.platforms.telegram.types.chat
      • peyk.platforms.telegram.types.chat_administrator_rights
      • peyk.platforms.telegram.types.chat_background
      • peyk.platforms.telegram.types.chat_boost
      • peyk.platforms.telegram.types.chat_boost_added
      • peyk.platforms.telegram.types.chat_boost_removed
      • peyk.platforms.telegram.types.chat_boost_source
      • peyk.platforms.telegram.types.chat_boost_source_gift_code
      • peyk.platforms.telegram.types.chat_boost_source_giveaway
      • peyk.platforms.telegram.types.chat_boost_source_premium
      • peyk.platforms.telegram.types.chat_boost_updated
      • peyk.platforms.telegram.types.chat_full_info
      • peyk.platforms.telegram.types.chat_invite_link
      • peyk.platforms.telegram.types.chat_join_request
      • peyk.platforms.telegram.types.chat_location
      • peyk.platforms.telegram.types.chat_member
      • peyk.platforms.telegram.types.chat_member_administrator
      • peyk.platforms.telegram.types.chat_member_banned
      • peyk.platforms.telegram.types.chat_member_left
      • peyk.platforms.telegram.types.chat_member_member
      • peyk.platforms.telegram.types.chat_member_owner
      • peyk.platforms.telegram.types.chat_member_restricted
      • peyk.platforms.telegram.types.chat_member_updated
      • peyk.platforms.telegram.types.chat_owner_changed
      • peyk.platforms.telegram.types.chat_owner_left
      • peyk.platforms.telegram.types.chat_permissions
      • peyk.platforms.telegram.types.chat_photo
      • peyk.platforms.telegram.types.chat_shared
      • peyk.platforms.telegram.types.checklist
      • peyk.platforms.telegram.types.checklist_task
      • peyk.platforms.telegram.types.checklist_tasks_added
      • peyk.platforms.telegram.types.checklist_tasks_done
      • peyk.platforms.telegram.types.chosen_inline_result
      • peyk.platforms.telegram.types.community
      • peyk.platforms.telegram.types.community_chat_added
      • peyk.platforms.telegram.types.community_chat_joined
      • peyk.platforms.telegram.types.community_chat_removed
      • peyk.platforms.telegram.types.contact
      • peyk.platforms.telegram.types.copy_text_button
      • peyk.platforms.telegram.types.dice
      • peyk.platforms.telegram.types.direct_message_price_changed
      • peyk.platforms.telegram.types.direct_messages_topic
      • peyk.platforms.telegram.types.disabled_button
      • peyk.platforms.telegram.types.document
      • peyk.platforms.telegram.types.encrypted_credentials
      • peyk.platforms.telegram.types.encrypted_passport_element
      • peyk.platforms.telegram.types.ephemeral_message_parameters
      • peyk.platforms.telegram.types.external_reply_info
      • peyk.platforms.telegram.types.file
      • peyk.platforms.telegram.types.force_reply
      • peyk.platforms.telegram.types.forum_topic
      • peyk.platforms.telegram.types.forum_topic_closed
      • peyk.platforms.telegram.types.forum_topic_created
      • peyk.platforms.telegram.types.forum_topic_edited
      • peyk.platforms.telegram.types.forum_topic_reopened
      • peyk.platforms.telegram.types.game
      • peyk.platforms.telegram.types.game_high_score
      • peyk.platforms.telegram.types.general_forum_topic_hidden
      • peyk.platforms.telegram.types.general_forum_topic_unhidden
      • peyk.platforms.telegram.types.gift
      • peyk.platforms.telegram.types.gift_background
      • peyk.platforms.telegram.types.gift_info
      • peyk.platforms.telegram.types.gifts
      • peyk.platforms.telegram.types.giveaway
      • peyk.platforms.telegram.types.giveaway_completed
      • peyk.platforms.telegram.types.giveaway_created
      • peyk.platforms.telegram.types.giveaway_winners
      • peyk.platforms.telegram.types.inaccessible_message
      • peyk.platforms.telegram.types.inline_keyboard_button
      • peyk.platforms.telegram.types.inline_keyboard_markup
      • peyk.platforms.telegram.types.inline_query
      • peyk.platforms.telegram.types.inline_query_result_article
      • peyk.platforms.telegram.types.inline_query_result_audio
      • peyk.platforms.telegram.types.inline_query_result_cached_audio
      • peyk.platforms.telegram.types.inline_query_result_cached_document
      • peyk.platforms.telegram.types.inline_query_result_cached_gif
      • peyk.platforms.telegram.types.inline_query_result_cached_mpeg4_gif
      • peyk.platforms.telegram.types.inline_query_result_cached_photo
      • peyk.platforms.telegram.types.inline_query_result_cached_sticker
      • peyk.platforms.telegram.types.inline_query_result_cached_video
      • peyk.platforms.telegram.types.inline_query_result_cached_voice
      • peyk.platforms.telegram.types.inline_query_result_contact
      • peyk.platforms.telegram.types.inline_query_result_document
      • peyk.platforms.telegram.types.inline_query_result_game
      • peyk.platforms.telegram.types.inline_query_result_gif
      • peyk.platforms.telegram.types.inline_query_result_location
      • peyk.platforms.telegram.types.inline_query_result_mpeg4_gif
      • peyk.platforms.telegram.types.inline_query_result_photo
      • peyk.platforms.telegram.types.inline_query_result_venue
      • peyk.platforms.telegram.types.inline_query_result_video
      • peyk.platforms.telegram.types.inline_query_result_voice
      • peyk.platforms.telegram.types.inline_query_results_button
      • peyk.platforms.telegram.types.input_checklist
      • peyk.platforms.telegram.types.input_checklist_task
      • peyk.platforms.telegram.types.input_contact_message_content
      • peyk.platforms.telegram.types.input_file
      • peyk.platforms.telegram.types.input_invoice_message_content
      • peyk.platforms.telegram.types.input_location_message_content
      • peyk.platforms.telegram.types.input_media_animation
      • peyk.platforms.telegram.types.input_media_audio
      • peyk.platforms.telegram.types.input_media_document
      • peyk.platforms.telegram.types.input_media_item
      • peyk.platforms.telegram.types.input_media_link
      • peyk.platforms.telegram.types.input_media_live_photo
      • peyk.platforms.telegram.types.input_media_location
      • peyk.platforms.telegram.types.input_media_photo
      • peyk.platforms.telegram.types.input_media_sticker
      • peyk.platforms.telegram.types.input_media_venue
      • peyk.platforms.telegram.types.input_media_video
      • peyk.platforms.telegram.types.input_media_voice_note
      • peyk.platforms.telegram.types.input_paid_media_live_photo
      • peyk.platforms.telegram.types.input_paid_media_photo
      • peyk.platforms.telegram.types.input_paid_media_video
      • peyk.platforms.telegram.types.input_poll_media
      • peyk.platforms.telegram.types.input_poll_option
      • peyk.platforms.telegram.types.input_poll_option_media
      • peyk.platforms.telegram.types.input_profile_photo_animated
      • peyk.platforms.telegram.types.input_profile_photo_static
      • peyk.platforms.telegram.types.input_rich_block_anchor
      • peyk.platforms.telegram.types.input_rich_block_animation
      • peyk.platforms.telegram.types.input_rich_block_audio
      • peyk.platforms.telegram.types.input_rich_block_block_quotation
      • peyk.platforms.telegram.types.input_rich_block_buttons
      • peyk.platforms.telegram.types.input_rich_block_collage
      • peyk.platforms.telegram.types.input_rich_block_details
      • peyk.platforms.telegram.types.input_rich_block_divider
      • peyk.platforms.telegram.types.input_rich_block_document
      • peyk.platforms.telegram.types.input_rich_block_expandable_block_quotation
      • peyk.platforms.telegram.types.input_rich_block_footer
      • peyk.platforms.telegram.types.input_rich_block_list
      • peyk.platforms.telegram.types.input_rich_block_list_item
      • peyk.platforms.telegram.types.input_rich_block_map
      • peyk.platforms.telegram.types.input_rich_block_mathematical_expression
      • peyk.platforms.telegram.types.input_rich_block_paragraph
      • peyk.platforms.telegram.types.input_rich_block_photo
      • peyk.platforms.telegram.types.input_rich_block_preformatted
      • peyk.platforms.telegram.types.input_rich_block_pull_quotation
      • peyk.platforms.telegram.types.input_rich_block_section_heading
      • peyk.platforms.telegram.types.input_rich_block_slideshow
      • peyk.platforms.telegram.types.input_rich_block_table
      • peyk.platforms.telegram.types.input_rich_block_thinking
      • peyk.platforms.telegram.types.input_rich_block_video
      • peyk.platforms.telegram.types.input_rich_block_voice_note
      • peyk.platforms.telegram.types.input_rich_message
      • peyk.platforms.telegram.types.input_rich_message_content
      • peyk.platforms.telegram.types.input_rich_message_media
      • peyk.platforms.telegram.types.input_sticker
      • peyk.platforms.telegram.types.input_story_content_photo
      • peyk.platforms.telegram.types.input_story_content_video
      • peyk.platforms.telegram.types.input_text_message_content
      • peyk.platforms.telegram.types.input_venue_message_content
      • peyk.platforms.telegram.types.invoice
      • peyk.platforms.telegram.types.keyboard_button
      • peyk.platforms.telegram.types.keyboard_button_poll_type
      • peyk.platforms.telegram.types.keyboard_button_request_chat
      • peyk.platforms.telegram.types.keyboard_button_request_managed_bot
      • peyk.platforms.telegram.types.keyboard_button_request_users
      • peyk.platforms.telegram.types.labeled_price
      • peyk.platforms.telegram.types.link
      • peyk.platforms.telegram.types.link_preview_options
      • peyk.platforms.telegram.types.live_photo
      • peyk.platforms.telegram.types.location
      • peyk.platforms.telegram.types.location_address
      • peyk.platforms.telegram.types.login_url
      • peyk.platforms.telegram.types.managed_bot_created
      • peyk.platforms.telegram.types.managed_bot_updated
      • peyk.platforms.telegram.types.mask_position
      • peyk.platforms.telegram.types.menu_button_commands
      • peyk.platforms.telegram.types.menu_button_default
      • peyk.platforms.telegram.types.menu_button_web_app
      • peyk.platforms.telegram.types.message
      • peyk.platforms.telegram.types.message_auto_delete_timer_changed
      • peyk.platforms.telegram.types.message_entity
      • peyk.platforms.telegram.types.message_generation_stopped
      • peyk.platforms.telegram.types.message_id
      • peyk.platforms.telegram.types.message_origin_channel
      • peyk.platforms.telegram.types.message_origin_chat
      • peyk.platforms.telegram.types.message_origin_hidden_user
      • peyk.platforms.telegram.types.message_origin_user
      • peyk.platforms.telegram.types.message_reaction_count_updated
      • peyk.platforms.telegram.types.message_reaction_updated
      • peyk.platforms.telegram.types.order_info
      • peyk.platforms.telegram.types.owned_gift_regular
      • peyk.platforms.telegram.types.owned_gift_unique
      • peyk.platforms.telegram.types.owned_gifts
      • peyk.platforms.telegram.types.paid_media_info
      • peyk.platforms.telegram.types.paid_media_live_photo
      • peyk.platforms.telegram.types.paid_media_photo
      • peyk.platforms.telegram.types.paid_media_preview
      • peyk.platforms.telegram.types.paid_media_purchased
      • peyk.platforms.telegram.types.paid_media_video
      • peyk.platforms.telegram.types.paid_message_price_changed
      • peyk.platforms.telegram.types.passport_data
      • peyk.platforms.telegram.types.passport_element_error_data_field
      • peyk.platforms.telegram.types.passport_element_error_file
      • peyk.platforms.telegram.types.passport_element_error_files
      • peyk.platforms.telegram.types.passport_element_error_front_side
      • peyk.platforms.telegram.types.passport_element_error_reverse_side
      • peyk.platforms.telegram.types.passport_element_error_selfie
      • peyk.platforms.telegram.types.passport_element_error_translation_file
      • peyk.platforms.telegram.types.passport_element_error_translation_files
      • peyk.platforms.telegram.types.passport_element_error_unspecified
      • peyk.platforms.telegram.types.passport_file
      • peyk.platforms.telegram.types.photo_size
      • peyk.platforms.telegram.types.poll
      • peyk.platforms.telegram.types.poll_answer
      • peyk.platforms.telegram.types.poll_media
      • peyk.platforms.telegram.types.poll_option
      • peyk.platforms.telegram.types.poll_option_added
      • peyk.platforms.telegram.types.poll_option_deleted
      • peyk.platforms.telegram.types.pre_checkout_query
      • peyk.platforms.telegram.types.prepared_inline_message
      • peyk.platforms.telegram.types.prepared_keyboard_button
      • peyk.platforms.telegram.types.proximity_alert_triggered
      • peyk.platforms.telegram.types.reaction_count
      • peyk.platforms.telegram.types.reaction_type_custom_emoji
      • peyk.platforms.telegram.types.reaction_type_emoji
      • peyk.platforms.telegram.types.reaction_type_paid
      • peyk.platforms.telegram.types.refunded_payment
      • peyk.platforms.telegram.types.reply_keyboard_markup
      • peyk.platforms.telegram.types.reply_keyboard_remove
      • peyk.platforms.telegram.types.reply_parameters
      • peyk.platforms.telegram.types.response_parameters
      • peyk.platforms.telegram.types.revenue_withdrawal_state_failed
      • peyk.platforms.telegram.types.revenue_withdrawal_state_pending
      • peyk.platforms.telegram.types.revenue_withdrawal_state_succeeded
      • peyk.platforms.telegram.types.rich_block_anchor
      • peyk.platforms.telegram.types.rich_block_animation
      • peyk.platforms.telegram.types.rich_block_audio
      • peyk.platforms.telegram.types.rich_block_block_quotation
      • peyk.platforms.telegram.types.rich_block_buttons
      • peyk.platforms.telegram.types.rich_block_caption
      • peyk.platforms.telegram.types.rich_block_collage
      • peyk.platforms.telegram.types.rich_block_details
      • peyk.platforms.telegram.types.rich_block_divider
      • peyk.platforms.telegram.types.rich_block_document
      • peyk.platforms.telegram.types.rich_block_expandable_block_quotation
      • peyk.platforms.telegram.types.rich_block_footer
      • peyk.platforms.telegram.types.rich_block_list
      • peyk.platforms.telegram.types.rich_block_list_item
      • peyk.platforms.telegram.types.rich_block_map
      • peyk.platforms.telegram.types.rich_block_mathematical_expression
      • peyk.platforms.telegram.types.rich_block_paragraph
      • peyk.platforms.telegram.types.rich_block_photo
      • peyk.platforms.telegram.types.rich_block_preformatted
      • peyk.platforms.telegram.types.rich_block_pull_quotation
      • peyk.platforms.telegram.types.rich_block_section_heading
      • peyk.platforms.telegram.types.rich_block_slideshow
      • peyk.platforms.telegram.types.rich_block_table
      • peyk.platforms.telegram.types.rich_block_table_cell
      • peyk.platforms.telegram.types.rich_block_thinking
      • peyk.platforms.telegram.types.rich_block_video
      • peyk.platforms.telegram.types.rich_block_voice_note
      • peyk.platforms.telegram.types.rich_message
      • peyk.platforms.telegram.types.rich_message_button
      • peyk.platforms.telegram.types.rich_text_anchor
      • peyk.platforms.telegram.types.rich_text_anchor_link
      • peyk.platforms.telegram.types.rich_text_bank_card_number
      • peyk.platforms.telegram.types.rich_text_bold
      • peyk.platforms.telegram.types.rich_text_bot_command
      • peyk.platforms.telegram.types.rich_text_button
      • peyk.platforms.telegram.types.rich_text_cashtag
      • peyk.platforms.telegram.types.rich_text_code
      • peyk.platforms.telegram.types.rich_text_custom_emoji
      • peyk.platforms.telegram.types.rich_text_date_time
      • peyk.platforms.telegram.types.rich_text_email_address
      • peyk.platforms.telegram.types.rich_text_hashtag
      • peyk.platforms.telegram.types.rich_text_italic
      • peyk.platforms.telegram.types.rich_text_marked
      • peyk.platforms.telegram.types.rich_text_mathematical_expression
      • peyk.platforms.telegram.types.rich_text_mention
      • peyk.platforms.telegram.types.rich_text_phone_number
      • peyk.platforms.telegram.types.rich_text_reference
      • peyk.platforms.telegram.types.rich_text_reference_link
      • peyk.platforms.telegram.types.rich_text_spoiler
      • peyk.platforms.telegram.types.rich_text_strikethrough
      • peyk.platforms.telegram.types.rich_text_subscript
      • peyk.platforms.telegram.types.rich_text_superscript
      • peyk.platforms.telegram.types.rich_text_text_mention
      • peyk.platforms.telegram.types.rich_text_underline
      • peyk.platforms.telegram.types.rich_text_url
      • peyk.platforms.telegram.types.sent_guest_message
      • peyk.platforms.telegram.types.sent_web_app_message
      • peyk.platforms.telegram.types.shared_user
      • peyk.platforms.telegram.types.shipping_address
      • peyk.platforms.telegram.types.shipping_option
      • peyk.platforms.telegram.types.shipping_query
      • peyk.platforms.telegram.types.star_amount
      • peyk.platforms.telegram.types.star_transaction
      • peyk.platforms.telegram.types.star_transactions
      • peyk.platforms.telegram.types.sticker
      • peyk.platforms.telegram.types.sticker_set
      • peyk.platforms.telegram.types.story
      • peyk.platforms.telegram.types.story_area
      • peyk.platforms.telegram.types.story_area_position
      • peyk.platforms.telegram.types.story_area_type_link
      • peyk.platforms.telegram.types.story_area_type_location
      • peyk.platforms.telegram.types.story_area_type_suggested_reaction
      • peyk.platforms.telegram.types.story_area_type_unique_gift
      • peyk.platforms.telegram.types.story_area_type_weather
      • peyk.platforms.telegram.types.successful_payment
      • peyk.platforms.telegram.types.suggested_post_approval_failed
      • peyk.platforms.telegram.types.suggested_post_approved
      • peyk.platforms.telegram.types.suggested_post_declined
      • peyk.platforms.telegram.types.suggested_post_info
      • peyk.platforms.telegram.types.suggested_post_paid
      • peyk.platforms.telegram.types.suggested_post_parameters
      • peyk.platforms.telegram.types.suggested_post_price
      • peyk.platforms.telegram.types.suggested_post_refunded
      • peyk.platforms.telegram.types.switch_inline_query_chosen_chat
      • peyk.platforms.telegram.types.text_quote
      • peyk.platforms.telegram.types.transaction_partner_affiliate_program
      • peyk.platforms.telegram.types.transaction_partner_chat
      • peyk.platforms.telegram.types.transaction_partner_fragment
      • peyk.platforms.telegram.types.transaction_partner_other
      • peyk.platforms.telegram.types.transaction_partner_telegram_ads
      • peyk.platforms.telegram.types.transaction_partner_telegram_api
      • peyk.platforms.telegram.types.transaction_partner_user
      • peyk.platforms.telegram.types.unique_gift
      • peyk.platforms.telegram.types.unique_gift_backdrop
      • peyk.platforms.telegram.types.unique_gift_backdrop_colors
      • peyk.platforms.telegram.types.unique_gift_colors
      • peyk.platforms.telegram.types.unique_gift_info
      • peyk.platforms.telegram.types.unique_gift_model
      • peyk.platforms.telegram.types.unique_gift_symbol
      • peyk.platforms.telegram.types.update
      • peyk.platforms.telegram.types.user
      • peyk.platforms.telegram.types.user_chat_boosts
      • peyk.platforms.telegram.types.user_profile_audios
      • peyk.platforms.telegram.types.user_profile_photos
      • peyk.platforms.telegram.types.user_rating
      • peyk.platforms.telegram.types.users_shared
      • peyk.platforms.telegram.types.venue
      • peyk.platforms.telegram.types.video
      • peyk.platforms.telegram.types.video_chat_ended
      • peyk.platforms.telegram.types.video_chat_participants_invited
      • peyk.platforms.telegram.types.video_chat_scheduled
      • peyk.platforms.telegram.types.video_chat_started
      • peyk.platforms.telegram.types.video_note
      • peyk.platforms.telegram.types.video_quality
      • peyk.platforms.telegram.types.voice
      • peyk.platforms.telegram.types.web_app_data
      • peyk.platforms.telegram.types.web_app_info
      • peyk.platforms.telegram.types.webhook_info
      • peyk.platforms.telegram.types.write_access_allowed
    • peyk.platforms.telegram.methods
      • peyk.platforms.telegram.methods.add_sticker_to_set
      • peyk.platforms.telegram.methods.answer_callback_query
      • peyk.platforms.telegram.methods.answer_chat_join_request_query
      • peyk.platforms.telegram.methods.answer_guest_query
      • peyk.platforms.telegram.methods.answer_inline_query
      • peyk.platforms.telegram.methods.answer_pre_checkout_query
      • peyk.platforms.telegram.methods.answer_shipping_query
      • peyk.platforms.telegram.methods.answer_web_app_query
      • peyk.platforms.telegram.methods.approve_chat_join_request
      • peyk.platforms.telegram.methods.approve_suggested_post
      • peyk.platforms.telegram.methods.ban_chat_member
      • peyk.platforms.telegram.methods.ban_chat_sender_chat
      • peyk.platforms.telegram.methods.build_inline_keyboard_button
      • peyk.platforms.telegram.methods.close_bot
      • peyk.platforms.telegram.methods.close_forum_topic
      • peyk.platforms.telegram.methods.close_general_forum_topic
      • peyk.platforms.telegram.methods.convert_gift_to_stars
      • peyk.platforms.telegram.methods.copy_message
      • peyk.platforms.telegram.methods.copy_messages
      • peyk.platforms.telegram.methods.create_chat_invite_link
      • peyk.platforms.telegram.methods.create_chat_subscription_invite_link
      • peyk.platforms.telegram.methods.create_forum_topic
      • peyk.platforms.telegram.methods.create_invoice_link
      • peyk.platforms.telegram.methods.create_new_sticker_set
      • peyk.platforms.telegram.methods.decline_chat_join_request
      • peyk.platforms.telegram.methods.decline_suggested_post
      • peyk.platforms.telegram.methods.delete_all_message_reactions
      • peyk.platforms.telegram.methods.delete_business_messages
      • peyk.platforms.telegram.methods.delete_chat_sticker_set
      • peyk.platforms.telegram.methods.delete_ephemeral_message
      • peyk.platforms.telegram.methods.delete_forum_topic
      • peyk.platforms.telegram.methods.delete_message_reaction
      • peyk.platforms.telegram.methods.delete_messages
      • peyk.platforms.telegram.methods.delete_my_commands
      • peyk.platforms.telegram.methods.delete_sticker_from_set
      • peyk.platforms.telegram.methods.delete_sticker_set
      • peyk.platforms.telegram.methods.delete_story
      • peyk.platforms.telegram.methods.delete_webhook
      • peyk.platforms.telegram.methods.edit_chat_invite_link
      • peyk.platforms.telegram.methods.edit_chat_subscription_invite_link
      • peyk.platforms.telegram.methods.edit_ephemeral_message_caption
      • peyk.platforms.telegram.methods.edit_ephemeral_message_media
      • peyk.platforms.telegram.methods.edit_ephemeral_message_reply_markup
      • peyk.platforms.telegram.methods.edit_ephemeral_message_text
      • peyk.platforms.telegram.methods.edit_forum_topic
      • peyk.platforms.telegram.methods.edit_general_forum_topic
      • peyk.platforms.telegram.methods.edit_message_caption
      • peyk.platforms.telegram.methods.edit_message_checklist
      • peyk.platforms.telegram.methods.edit_message_live_location
      • peyk.platforms.telegram.methods.edit_message_media
      • peyk.platforms.telegram.methods.edit_message_reply_markup
      • peyk.platforms.telegram.methods.edit_message_text
      • peyk.platforms.telegram.methods.edit_story
      • peyk.platforms.telegram.methods.edit_user_star_subscription
      • peyk.platforms.telegram.methods.export_chat_invite_link
      • peyk.platforms.telegram.methods.forward_message
      • peyk.platforms.telegram.methods.forward_messages
      • peyk.platforms.telegram.methods.get_available_gifts
      • peyk.platforms.telegram.methods.get_business_account_gifts
      • peyk.platforms.telegram.methods.get_business_account_star_balance
      • peyk.platforms.telegram.methods.get_business_connection
      • peyk.platforms.telegram.methods.get_chat_administrators
      • peyk.platforms.telegram.methods.get_chat_gifts
      • peyk.platforms.telegram.methods.get_chat_member_count
      • peyk.platforms.telegram.methods.get_chat_menu_button
      • peyk.platforms.telegram.methods.get_custom_emoji_stickers
      • peyk.platforms.telegram.methods.get_forum_topic_icon_stickers
      • peyk.platforms.telegram.methods.get_game_high_scores
      • peyk.platforms.telegram.methods.get_managed_bot_access_settings
      • peyk.platforms.telegram.methods.get_managed_bot_token
      • peyk.platforms.telegram.methods.get_my_commands
      • peyk.platforms.telegram.methods.get_my_default_administrator_rights
      • peyk.platforms.telegram.methods.get_my_description
      • peyk.platforms.telegram.methods.get_my_name
      • peyk.platforms.telegram.methods.get_my_short_description
      • peyk.platforms.telegram.methods.get_my_star_balance
      • peyk.platforms.telegram.methods.get_star_transactions
      • peyk.platforms.telegram.methods.get_sticker_set
      • peyk.platforms.telegram.methods.get_updates
      • peyk.platforms.telegram.methods.get_user_chat_boosts
      • peyk.platforms.telegram.methods.get_user_gifts
      • peyk.platforms.telegram.methods.get_user_personal_chat_messages
      • peyk.platforms.telegram.methods.get_user_profile_audios
      • peyk.platforms.telegram.methods.get_user_profile_photos
      • peyk.platforms.telegram.methods.gift_premium_subscription
      • peyk.platforms.telegram.methods.hide_general_forum_topic
      • peyk.platforms.telegram.methods.log_out
      • peyk.platforms.telegram.methods.pin_chat_message
      • peyk.platforms.telegram.methods.post_story
      • peyk.platforms.telegram.methods.promote_chat_member
      • peyk.platforms.telegram.methods.read_business_message
      • peyk.platforms.telegram.methods.refund_star_payment
      • peyk.platforms.telegram.methods.remove_business_account_profile_photo
      • peyk.platforms.telegram.methods.remove_chat_verification
      • peyk.platforms.telegram.methods.remove_my_profile_photo
      • peyk.platforms.telegram.methods.remove_user_verification
      • peyk.platforms.telegram.methods.reopen_forum_topic
      • peyk.platforms.telegram.methods.reopen_general_forum_topic
      • peyk.platforms.telegram.methods.replace_managed_bot_token
      • peyk.platforms.telegram.methods.replace_sticker_in_set
      • peyk.platforms.telegram.methods.repost_story
      • peyk.platforms.telegram.methods.restrict_chat_member
      • peyk.platforms.telegram.methods.revoke_chat_invite_link
      • peyk.platforms.telegram.methods.save_prepared_inline_message
      • peyk.platforms.telegram.methods.save_prepared_keyboard_button
      • peyk.platforms.telegram.methods.send_animation
      • peyk.platforms.telegram.methods.send_audio
      • peyk.platforms.telegram.methods.send_chat_action
      • peyk.platforms.telegram.methods.send_chat_join_request_web_app
      • peyk.platforms.telegram.methods.send_checklist
      • peyk.platforms.telegram.methods.send_contact
      • peyk.platforms.telegram.methods.send_dice
      • peyk.platforms.telegram.methods.send_document
      • peyk.platforms.telegram.methods.send_game
      • peyk.platforms.telegram.methods.send_gift
      • peyk.platforms.telegram.methods.send_invoice
      • peyk.platforms.telegram.methods.send_live_photo
      • peyk.platforms.telegram.methods.send_location
      • peyk.platforms.telegram.methods.send_media_group
      • peyk.platforms.telegram.methods.send_message
      • peyk.platforms.telegram.methods.send_message_draft
      • peyk.platforms.telegram.methods.send_paid_media
      • peyk.platforms.telegram.methods.send_photo
      • peyk.platforms.telegram.methods.send_poll
      • peyk.platforms.telegram.methods.send_rich_message
      • peyk.platforms.telegram.methods.send_rich_message_draft
      • peyk.platforms.telegram.methods.send_sticker
      • peyk.platforms.telegram.methods.send_venue
      • peyk.platforms.telegram.methods.send_video
      • peyk.platforms.telegram.methods.send_video_note
      • peyk.platforms.telegram.methods.send_voice
      • peyk.platforms.telegram.methods.set_business_account_bio
      • peyk.platforms.telegram.methods.set_business_account_gift_settings
      • peyk.platforms.telegram.methods.set_business_account_name
      • peyk.platforms.telegram.methods.set_business_account_profile_photo
      • peyk.platforms.telegram.methods.set_business_account_username
      • peyk.platforms.telegram.methods.set_chat_administrator_custom_title
      • peyk.platforms.telegram.methods.set_chat_description
      • peyk.platforms.telegram.methods.set_chat_member_tag
      • peyk.platforms.telegram.methods.set_chat_menu_button
      • peyk.platforms.telegram.methods.set_chat_permissions
      • peyk.platforms.telegram.methods.set_chat_photo
      • peyk.platforms.telegram.methods.set_chat_sticker_set
      • peyk.platforms.telegram.methods.set_custom_emoji_sticker_set_thumbnail
      • peyk.platforms.telegram.methods.set_game_score
      • peyk.platforms.telegram.methods.set_managed_bot_access_settings
      • peyk.platforms.telegram.methods.set_message_reaction
      • peyk.platforms.telegram.methods.set_my_commands
      • peyk.platforms.telegram.methods.set_my_default_administrator_rights
      • peyk.platforms.telegram.methods.set_my_description
      • peyk.platforms.telegram.methods.set_my_name
      • peyk.platforms.telegram.methods.set_my_profile_photo
      • peyk.platforms.telegram.methods.set_my_short_description
      • peyk.platforms.telegram.methods.set_passport_data_errors
      • peyk.platforms.telegram.methods.set_sticker_emoji_list
      • peyk.platforms.telegram.methods.set_sticker_keywords
      • peyk.platforms.telegram.methods.set_sticker_mask_position
      • peyk.platforms.telegram.methods.set_sticker_position_in_set
      • peyk.platforms.telegram.methods.set_sticker_set_thumbnail
      • peyk.platforms.telegram.methods.set_sticker_set_title
      • peyk.platforms.telegram.methods.set_user_emoji_status
      • peyk.platforms.telegram.methods.set_webhook
      • peyk.platforms.telegram.methods.stop_message_live_location
      • peyk.platforms.telegram.methods.stop_poll
      • peyk.platforms.telegram.methods.transfer_business_account_stars
      • peyk.platforms.telegram.methods.transfer_gift
      • peyk.platforms.telegram.methods.unban_chat_sender_chat
      • peyk.platforms.telegram.methods.unhide_general_forum_topic
      • peyk.platforms.telegram.methods.unpin_all_forum_topic_messages
      • peyk.platforms.telegram.methods.unpin_all_general_forum_topic_messages
      • peyk.platforms.telegram.methods.unpin_chat_message
      • peyk.platforms.telegram.methods.upgrade_gift
      • peyk.platforms.telegram.methods.upload_sticker_file
      • peyk.platforms.telegram.methods.verify_chat
      • peyk.platforms.telegram.methods.verify_user
  • Rubika API
    • peyk.platforms.rubika.types
      • peyk.platforms.rubika.types.aux_data
      • peyk.platforms.rubika.types.bot
      • peyk.platforms.rubika.types.bot_command
      • peyk.platforms.rubika.types.button
      • peyk.platforms.rubika.types.button_calendar
      • peyk.platforms.rubika.types.button_location
      • peyk.platforms.rubika.types.button_number_picker
      • peyk.platforms.rubika.types.button_selection
      • peyk.platforms.rubika.types.button_selection_item
      • peyk.platforms.rubika.types.button_string_picker
      • peyk.platforms.rubika.types.button_textbox
      • peyk.platforms.rubika.types.chat
      • peyk.platforms.rubika.types.contact_message
      • peyk.platforms.rubika.types.event
      • peyk.platforms.rubika.types.file
      • peyk.platforms.rubika.types.forwarded_from
      • peyk.platforms.rubika.types.get_updates_result
      • peyk.platforms.rubika.types.inline_message
      • peyk.platforms.rubika.types.keypad
      • peyk.platforms.rubika.types.keypad_row
      • peyk.platforms.rubika.types.location
      • peyk.platforms.rubika.types.message
      • peyk.platforms.rubika.types.metadata
      • peyk.platforms.rubika.types.metadata_part
      • peyk.platforms.rubika.types.poll
      • peyk.platforms.rubika.types.poll_status
      • peyk.platforms.rubika.types.sticker
      • peyk.platforms.rubika.types.update
    • peyk.platforms.rubika.methods
      • peyk.platforms.rubika.methods.ban_chat_member
      • peyk.platforms.rubika.methods.close
      • peyk.platforms.rubika.methods.delete_message
      • peyk.platforms.rubika.methods.edit_chat_keypad
      • peyk.platforms.rubika.methods.edit_message_keypad
      • peyk.platforms.rubika.methods.edit_message_text
      • peyk.platforms.rubika.methods.forward_message
      • peyk.platforms.rubika.methods.get_chat
      • peyk.platforms.rubika.methods.get_file
      • peyk.platforms.rubika.methods.get_me
      • peyk.platforms.rubika.methods.get_updates
      • peyk.platforms.rubika.methods.remove_chat_keypad
      • peyk.platforms.rubika.methods.request_send_file
      • peyk.platforms.rubika.methods.send_contact
      • peyk.platforms.rubika.methods.send_file
      • peyk.platforms.rubika.methods.send_location
      • peyk.platforms.rubika.methods.send_message
      • peyk.platforms.rubika.methods.send_poll
      • peyk.platforms.rubika.methods.set_commands
      • peyk.platforms.rubika.methods.unban_chat_member
      • peyk.platforms.rubika.methods.update_bot_endpoints
      • peyk.platforms.rubika.methods.upload_and_send_file
      • peyk.platforms.rubika.methods.upload_file
  • Dispatcher API
    • peyk.dispatcher
      • peyk.dispatcher.dispatcher
      • peyk.dispatcher.event
        • peyk.dispatcher.event.bases
        • peyk.dispatcher.event.handler
        • peyk.dispatcher.event.telegram
      • peyk.dispatcher.filters
        • peyk.dispatcher.filters.base
        • peyk.dispatcher.filters.callback_data
        • peyk.dispatcher.filters.chat_type
        • peyk.dispatcher.filters.command
        • peyk.dispatcher.filters.state
        • peyk.dispatcher.filters.text
      • peyk.dispatcher.middlewares
        • peyk.dispatcher.middlewares.base
        • peyk.dispatcher.middlewares.fsm
        • peyk.dispatcher.middlewares.logging_middleware
        • peyk.dispatcher.middlewares.utils
      • peyk.dispatcher.polling
      • peyk.dispatcher.router
  • Transport API
    • peyk.transport
      • peyk.transport.errors
      • peyk.transport.logging_hook
      • peyk.transport.multipart
      • peyk.transport.retry
      • peyk.transport.session
  • Platform Core API
    • peyk.platform_core
      • peyk.platform_core.adapters
        • peyk.platform_core.adapters.bale
        • peyk.platform_core.adapters.rubika
        • peyk.platform_core.adapters.telegram
      • peyk.platform_core.capabilities
        • peyk.platform_core.capabilities.bale
        • peyk.platform_core.capabilities.legacy
        • peyk.platform_core.capabilities.rubika
        • peyk.platform_core.capabilities.telegram
      • peyk.platform_core.contracts
        • peyk.platform_core.contracts.callback
        • peyk.platform_core.contracts.capabilities
        • peyk.platform_core.contracts.chat_member
        • peyk.platform_core.contracts.message
      • peyk.platform_core.enums
        • peyk.platform_core.enums.chat_type
        • peyk.platform_core.enums.parse_mode
        • peyk.platform_core.enums.platform
        • peyk.platform_core.enums.update_delivery
      • peyk.platform_core.errors
  • Enum reference
  • Utilities
Back to top
View this page
Edit this page

peyk.platforms.bale.methods.create_chat_invite_link¶

async peyk.platforms.bale.methods.create_chat_invite_link(self, chat_id: int | str) → Dict[str, object][source]¶

Creates chat invite link through the Bale API.

Parameters:

chat_id – Identifier of the target chat.

Returns:

Result produced by the Bale operation.

Next
peyk.platforms.bale.methods.create_invoice_link
Previous
peyk.platforms.bale.methods.copy_message
Copyright ©
Made with Sphinx and @pradyunsg's Furo
On this page
  • peyk.platforms.bale.methods.create_chat_invite_link
    • create_chat_invite_link()