Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy_types/mod.ts>GiveawayWinners

Type declarations of the Telegram Bot API.
Latest
interface GiveawayWinners
import { type GiveawayWinners } from "https://deno.land/x/grammy_types@v3.16.0/mod.ts";

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

Properties

chat: Chat

The chat that created the giveaway

giveaway_message_id: number

Identifier of the message with the giveaway in the chat

winners_selection_date: number

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

winner_count: number

Total number of winners in the giveaway

winners: User[]

List of up to 100 winners of the giveaway

optional
additional_chat_count: number

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

optional
prize_star_count: number

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

optional
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

optional
unclaimed_prize_count: number

Number of undistributed prizes

optional
only_new_members: true

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

optional
was_refunded: true

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

optional
prize_description: string

Description of additional giveaway prize