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

    Interface GiftInfo

    Describes a service message about a regular gift that was sent or received.

    Telegram Bot API: GiftInfo

    interface GiftInfo {
        can_be_upgraded?: boolean;
        convert_star_count?: number;
        entities?: MessageEntity[];
        gift: Gift;
        is_private?: boolean;
        is_upgrade_separate?: boolean;
        owned_gift_id?: string;
        prepaid_upgrade_star_count?: number;
        text?: string;
        unique_gift_number?: number;
    }
    Index
    can_be_upgraded? convert_star_count? entities? gift is_private? is_upgrade_separate? owned_gift_id? prepaid_upgrade_star_count? text? unique_gift_number?
    can_be_upgraded?: boolean

    True, if the gift can be upgraded to a unique gift.

    convert_star_count?: number

    Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible.

    entities?: MessageEntity[]

    Special entities that appear in the text.

    gift: Gift

    Information about the gift.

    is_private?: boolean

    True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them.

    is_upgrade_separate?: boolean

    True, if the gift's upgrade was purchased after the gift was sent.

    owned_gift_id?: string

    Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts.

    prepaid_upgrade_star_count?: number

    Number of Telegram Stars that were prepaid for the ability to upgrade the gift.

    Optionaltext

    text?: string

    Text of the message that was added to the gift.

    unique_gift_number?: number

    Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

    Settings
    Member Visibility

    On This Page
    Properties