Constructor: inputStorePaymentStarsGiveaway
Used to pay for a star giveaway, see here » for more info.
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
| only_new_subscribers | Bool | Optional | If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway. |
| winners_are_visible | Bool | Optional | 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 | Yes | Total number of Telegram Stars being given away (each user will receive stars/users stars). |
| boost_peer | Username, chat ID, Update, Message or InputPeer | Optional | 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 | Array of Username, chat ID, Update, Message or InputPeer | Optional | Additional channels that the user must join to participate to the giveaway can be specified here. |
| countries_iso2 | Array of string | Optional | 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 | string | Optional | Can contain a textual description of additional giveaway prizes. |
| until_date | int | Yes | 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 | Yes | Three-letter ISO 4217 currency code |
| amount | long | Yes | 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 | Yes | Number of winners. |
Type: InputStorePaymentPurpose
Example:
$inputStorePaymentStarsGiveaway = ['_' => 'inputStorePaymentStarsGiveaway', 'only_new_subscribers' => Bool, 'winners_are_visible' => Bool, 'stars' => long, 'boost_peer' => InputPeer, 'additional_peers' => [InputPeer, InputPeer], 'countries_iso2' => ['string', 'string'], 'prize_description' => 'string', 'until_date' => int, 'currency' => 'string', 'amount' => long, 'users' => int];