telegramx.js

GiveawayWinners

interface

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

Declaration

interface GiveawayWinners 

Properties

additional_chat_count?: number;

Optional. The number of other chats the user had to join in order to be eligible for the giveaway

chatproperty#
chat: Chat;

The chat that created the giveaway

giveaway_message_id: number;

Identifier of the message with the giveaway in the chat

only_new_members?: boolean;

Optional. True, if only users who had joined the chats after the giveaway started were eligible to win

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

prize_description?: string;

Optional. Description of additional giveaway prize

prize_star_count?: number;

Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only

unclaimed_prize_count?: number;

Optional. Number of undistributed prizes

was_refunded?: boolean;

Optional. True, if the giveaway was canceled because the payment for it was refunded

winner_count: number;

Total number of winners in the giveaway

winners_selection_date: number;

Point in time (Unix timestamp) when winners of the giveaway were selected

winnersproperty#
winners: User[];

List of up to 100 winners of the giveaway