Available types

Giveaway

This object represents a message about a scheduled giveaway.

fields

fieldtyperequireddescription
chatsChat[]requiredThe list of chats which the user must join to participate in the giveaway
winners_selection_datenumberrequiredPoint in time (Unix timestamp) when winners of the giveaway will be selected
winner_countnumberrequiredThe number of users which are supposed to be selected as winners of the giveaway
only_new_membersbooleanoptionalOptional. True, if only users who join the chats after the giveaway started should be eligible to win
has_public_winnersbooleanoptionalOptional. True, if the list of giveaway winners will be visible to everyone
prize_descriptionstringoptionalOptional. Description of additional giveaway prize
country_codesstring[]optionalOptional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.
prize_star_countnumberoptionalOptional. The number of Telegram Stars to be 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

import

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

used by

types