Available types

GiveawayWinners

This object represents a message about the completion of a giveaway with public winners.

fields

fieldtyperequireddescription
chatChatrequiredThe chat that created the giveaway
giveaway_message_idnumberrequiredIdentifier of the message with the giveaway in the chat
winners_selection_datenumberrequiredPoint in time (Unix timestamp) when winners of the giveaway were selected
winner_countnumberrequiredTotal number of winners in the giveaway
winnersUser[]requiredList of up to 100 winners of the giveaway
additional_chat_countnumberoptionalOptional. The number of other chats the user had to join in order to be eligible for the giveaway
prize_star_countnumberoptionalOptional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only
premium_subscription_month_countnumberoptionalOptional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only
unclaimed_prize_countnumberoptionalOptional. Number of undistributed prizes
only_new_membersbooleanoptionalOptional. True, if only users who had joined the chats after the giveaway started were eligible to win
was_refundedbooleanoptionalOptional. True, if the giveaway was canceled because the payment for it was refunded
prize_descriptionstringoptionalOptional. Description of additional giveaway prize

import

types.ts
import type { GiveawayWinners } from "@yaebal/types";

used by

types