GiveawayWinners
This object represents a message about the completion of a giveaway with public winners.
fields
| field | type | required | description |
|---|---|---|---|
chat | Chat | required | The chat that created the giveaway |
giveaway_message_id | number | required | Identifier of the message with the giveaway in the chat |
winners_selection_date | number | required | Point in time (Unix timestamp) when winners of the giveaway were selected |
winner_count | number | required | Total number of winners in the giveaway |
winners | User[] | required | List of up to 100 winners of the giveaway |
additional_chat_count | number | optional | Optional. The number of other chats the user had to join in order to be eligible for the giveaway |
prize_star_count | number | optional | Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only |
premium_subscription_month_count | number | optional | Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only |
unclaimed_prize_count | number | optional | Optional. Number of undistributed prizes |
only_new_members | boolean | optional | Optional. True, if only users who had joined the chats after the giveaway started were eligible to win |
was_refunded | boolean | optional | Optional. True, if the giveaway was canceled because the payment for it was refunded |
prize_description | string | optional | Optional. Description of additional giveaway prize |
import
import type { GiveawayWinners } from "@yaebal/types";used by
types
official Bot API docs: https://core.telegram.org/bots/api/#giveawaywinners