GramIO API Reference / gramio/dist / TelegramGiveawayWinners
Interface: TelegramGiveawayWinners
Defined in: @gramio/types/out/objects.d.ts:2895
This object represents a message about the completion of a giveaway with public winners.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
additional_chat_count? | number | Optional. The number of other chats the user had to join in order to be eligible for the giveaway | @gramio/types/out/objects.d.ts:2919 |
chat | TelegramChat | The chat that created the giveaway | @gramio/types/out/objects.d.ts:2899 |
giveaway_message_id | number | Identifier of the message with the giveaway in the chat | @gramio/types/out/objects.d.ts:2903 |
only_new_members? | true | Optional. True, if only users who had joined the chats after the giveaway started were eligible to win | @gramio/types/out/objects.d.ts:2935 |
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:2927 |
prize_description? | string | Optional. Description of additional giveaway prize | @gramio/types/out/objects.d.ts:2943 |
prize_star_count? | number | Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only | @gramio/types/out/objects.d.ts:2923 |
unclaimed_prize_count? | number | Optional. Number of undistributed prizes | @gramio/types/out/objects.d.ts:2931 |
was_refunded? | true | Optional. True, if the giveaway was canceled because the payment for it was refunded | @gramio/types/out/objects.d.ts:2939 |
winner_count | number | Total number of winners in the giveaway | @gramio/types/out/objects.d.ts:2911 |
winners | TelegramUser[] | List of up to 100 winners of the giveaway | @gramio/types/out/objects.d.ts:2915 |
winners_selection_date | number | Point in time (Unix timestamp) when winners of the giveaway were selected | @gramio/types/out/objects.d.ts:2907 |