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

    Interface SendGiftOptions

    Options for Bot.sendGift.

    user_id and chat_id are mutually exclusive: exactly one of them must be provided. Limited gifts cannot be sent to channel chats.

    interface SendGiftOptions {
        chat_id?: string | number;
        gift_id: string;
        pay_for_upgrade?: boolean;
        text?: string;
        text_entities?: MessageEntity[];
        text_parse_mode?: string;
        user_id?: number;
    }
    Index
    chat_id? gift_id pay_for_upgrade? text? text_entities? text_parse_mode? user_id?
    chat_id?: string | number

    Required if user_id is not specified. Unique identifier for the chat or username of the channel (@username) that will receive the gift.

    gift_id: string

    Identifier of the gift; limited gifts can't be sent to channel chats.

    pay_for_upgrade?: boolean

    Pass True to pay for the gift upgrade from the bot's balance, making the upgrade free for the receiver.

    Optionaltext

    text?: string

    Text that will be shown along with the gift; 0-128 characters.

    Optionaltext_entities

    text_entities?: MessageEntity[]

    Special entities that appear in the gift text.

    Optionaltext_parse_mode

    text_parse_mode?: string

    Mode for parsing entities in the text.

    user_id?: number

    Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.

    Settings
    Member Visibility

    On This Page
    Properties