place_gift_auction_bid()

Client.place_gift_auction_bid()

Places a bid on an auction gift.

Usable by Users Bots

Parameters:

• gift_id (int) – Identifier of the gift to place the bid on.

• star_count (int) – The number of Telegram Stars to place in the bid.

• user_id (int | str, optional) – Unique identifier (int) or username (str) of the target chat you want to transfer the star gift to. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

• text (str | FormattedText, optional) – Text to show along with the gift. Must be empty if the receiver enabled paid messages.

• is_private (bool, optional) – Pass True to show gift text and sender only to the gift receiver, otherwise, everyone will be able to see them.

Returns:

bool – On success, True is returned.

Example

# Place a bid of 100 stars on a gift auction for yourself
await app.place_gift_auction_bid(
    gift_id=12345,
    star_count=100
)

# Place a bid of 250 stars on a gift auction for another user with a message
await app.place_gift_auction_bid(
    gift_id=12345,
    star_count=250,
    user_id="@KurimuzonAkuma",
    text=types.FormattedText(
        text="Here's a gift for you!"
    )
)