GramIO API Reference / gramio/dist / TelegramGiveaway
Interface: TelegramGiveaway
Defined in: @gramio/types/out/objects.d.ts:2715
This object represents a message about a scheduled giveaway.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
chats | TelegramChat[] | The list of chats which the user must join to participate in the giveaway | @gramio/types/out/objects.d.ts:2719 |
country_codes? | string[] | Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. | @gramio/types/out/objects.d.ts:2743 |
has_public_winners? | true | Optional. True, if the list of giveaway winners will be visible to everyone | @gramio/types/out/objects.d.ts:2735 |
only_new_members? | true | Optional. True, if only users who join the chats after the giveaway started should be eligible to win | @gramio/types/out/objects.d.ts:2731 |
premium_subscription_month_count? | number | Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | @gramio/types/out/objects.d.ts:2751 |
prize_description? | string | Optional. Description of additional giveaway prize | @gramio/types/out/objects.d.ts:2739 |
prize_star_count? | number | Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | @gramio/types/out/objects.d.ts:2747 |
winner_count | number | The number of users which are supposed to be selected as winners of the giveaway | @gramio/types/out/objects.d.ts:2727 |
winners_selection_date | number | Point in time (Unix timestamp) when winners of the giveaway will be selected | @gramio/types/out/objects.d.ts:2723 |