Home › Methods › Payments › GetStarGiftAuctionState
Layer 227

PaymentsGetStarGiftAuctionState

Returns info about a collectible gift auction; also subscribes the user to auction updates, see here for more info on the full flow.

method Users
payments.getStarGiftAuctionState#5c9ff4d6 auction:InputStarGiftAuction version:int = payments.StarGiftAuctionState;

Parameters

Name Type Description
Auction InputStarGiftAuction Either the ID of the gift linked to the auction, or an auction deep link slug.
Version int Initially 0, then set to the returned star Gift Auction State. version, to avoid refetching results if they haven't changed.

Returns

payments.StarGiftAuctionState

Gogram Example

// PaymentsGetStarGiftAuctionState - positional arguments
result, err := client.PaymentsGetStarGiftAuctionState(&tg.InputStarGiftAuction{}, 42)
if err != nil {
    // handle error
}
// result is *tg.PaymentsStarGiftAuctionState

Possible Errors

Code Type Description
400 STARGIFT_INVALID The passed gift is invalid.