telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface GiveawayWinners

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

    Telegram Bot API: GiveawayWinners

    interface GiveawayWinners {
        additional_chat_count?: number;
        chat: Chat;
        giveaway_message_id: number;
        only_new_members?: boolean;
        premium_subscription_month_count?: number;
        prize_description?: string;
        prize_star_count?: number;
        unclaimed_prize_count?: number;
        was_refunded?: boolean;
        winner_count: number;
        winners: User[];
        winners_selection_date: number;
    }
    Index
    additional_chat_count? chat giveaway_message_id only_new_members? premium_subscription_month_count? prize_description? prize_star_count? unclaimed_prize_count? was_refunded? winner_count winners winners_selection_date
    additional_chat_count?: number

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

    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

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

    premium_subscription_month_count?: number

    The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only.

    prize_description?: string

    Description of additional giveaway prize.

    prize_star_count?: number

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

    unclaimed_prize_count?: number

    Number of undistributed prizes.

    was_refunded?: boolean

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

    winner_count: number

    Total number of winners in the giveaway.

    winners: User[]

    List of up to 100 winners of the giveaway.

    winners_selection_date: number

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

    Settings
    Member Visibility

    On This Page
    Properties