inputStorePaymentStarsGiveaway

Used to pay for a star giveaway, see here » for more info.

inputStorePaymentStarsGiveaway#751f08fa flags:# only_new_subscribers:flags.0?true winners_are_visible:flags.3?true stars:long boost_peer:InputPeer additional_peers:flags.1?Vector<InputPeer> countries_iso2:flags.2?Vector<string> prize_description:flags.4?string random_id:long until_date:int currency:string amount:long users:int = InputStorePaymentPurpose;

Parameters

Name Type Description
flags # Flags, see TL conditional fields
only_new_subscribers flags.0?true If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway.
winners_are_visible flags.3?true If set, giveaway winners are public and will be listed in a messageMediaGiveawayResults message that will be automatically sent to the channel once the giveaway ends.
stars long Total number of Telegram Stars being given away (each user will receive stars/users stars).
boost_peer InputPeer The channel/supergroup starting the giveaway, that the user must join to participate, that will receive the giveaway boosts; see here » for more info on giveaways.
additional_peers flags.1?Vector<InputPeer> Additional channels that the user must join to participate to the giveaway can be specified here.
countries_iso2 flags.2?Vector<string> The set of users that can participate to the giveaway can be restricted by passing here an explicit whitelist of up to giveaway_countries_max countries, specified as two-letter ISO 3166-1 alpha-2 country codes.
prize_description flags.4?string Can contain a textual description of additional giveaway prizes.
random_id long Random ID to avoid resending the giveaway
until_date int The end date of the giveaway, must be at most giveaway_period_max seconds in the future; see here » for more info on giveaways.
currency string Three-letter ISO 4217 currency code
amount long Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
users int Number of winners.

Type

InputStorePaymentPurpose

Related pages

messageMediaGiveawayResults

A giveaway with public winners has finished, this constructor contains info about the winners.

Channel and supergroup boosts

Telegram Premium users can grant their favorite channels and supergroups additional features like the ability to post stories by giving them boosts.

Giveaways

Telegram channel and supergroup administrators may launch giveaways to randomly distribute Telegram Premium subscriptions and other gifts among their followers, in exchange for boosts.

Client configuration

The MTProto API has multiple configuration parameters that can be fetched with the appropriate methods.

Bot Payments API