premium.BoostsStatus

class pyrogram.raw.types.premium.BoostsStatus

Contains info about the current boost status of a peer.

Constructor of BoostsStatus.

Details:

  • Layer: 223

  • ID: 4959427A

Parameters:

  • level (int 32-bit) – The current boost level of the channel/supergroup.

  • current_level_boosts (int 32-bit) – The number of boosts acquired so far in the current level.

  • boosts (int 32-bit) – Total number of boosts acquired so far.

  • boost_url (str) – Boost deep link » that can be used to boost the chat.

  • my_boost (bool, optional) – Whether we’re currently boosting this channel/supergroup, my_boost_slots will also be set.

  • gift_boosts (int 32-bit, optional) – The number of boosts acquired from created Telegram Premium gift codes and giveaways; only returned to channel/supergroup admins.

  • next_level_boosts (int 32-bit, optional) – Total number of boosts needed to reach the next level; if absent, the next level isn’t available.

  • premium_audience (StatsPercentValue, optional) – Only returned to channel/supergroup admins: contains the approximated number of Premium users subscribed to the channel/supergroup, related to the total number of subscribers.

  • prepaid_giveaways (List of PrepaidGiveaway, optional) – A list of prepaid giveaways available for the chat; only returned to channel/supergroup admins.

  • my_boost_slots (List of int 32-bit, optional) – Indicates which of our boost slots we’ve assigned to this peer (populated if my_boost is set).

Functions:

This object can be returned by 1 function.

premium.GetBoostsStatus

Gets the current number of boosts of a channel/supergroup.

TL Schema

premium.boostsStatus#4959427a
flags:#
my_boost:flags.2?true
level:int
current_level_boosts:int
boosts:int
gift_boosts:flags.4?int
next_level_boosts:flags.0?int
premium_audience:flags.1?StatsPercentValue
boost_url:string
prepaid_giveaways:flags.3?Vector<PrepaidGiveaway>
my_boost_slots:flags.2?Vector<int>

= premium.BoostsStatus

Parameter Tree

BoostsStatus
├── my_boost → true (optional)
├── level → int
├── current_level_boosts → int
├── boosts → int
├── gift_boosts → int (optional)
├── next_level_boosts → int (optional)
├── premium_audience → StatsPercentValue (optional)
│ └── StatsPercentValue
│ ├── part → double
│ └── total → double
├── boost_url → string
├── prepaid_giveaways → Vector < PrepaidGiveaway > (optional)
│ ├── PrepaidGiveaway
│ │ ├── id → long
│ │ ├── months → int
│ │ ├── quantity → int
│ │ └── date → int
│ └── PrepaidStarsGiveaway
│ ├── id → long
│ ├── stars → long
│ ├── quantity → int
│ ├── boosts → int
│ └── date → int
└── my_boost_slots → Vector < int > (optional)

Example

BoostsStatus(
    level=0,
    current_level_boosts=0,
    boosts=0,
    boost_url="text",
)