Returns info about a collectible gift auction »; also subscribes the user to auction updates, see here » for more info on the full flow.
payments.starGiftAuctionState#e98e474 gift:StarGift state:StarGiftAuctionState user_state:StarGiftAuctionUserState timeout:int users:Vector<User> = payments.StarGiftAuctionState;
---functions---
payments.getStarGiftAuctionState#5c9ff4d6 auction:InputStarGiftAuction version:int = payments.StarGiftAuctionState;| 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 starGiftAuctionState.version, to avoid refetching results if they haven't changed. |
| Code | Type | Description |
|---|---|---|
| 400 | STARGIFT_INVALID | The passed gift is invalid. |
Telegram clients must handle special tg:// and t.me deep links encountered in messages, link entities and in other apps by registering OS handlers.
Represents an active or pending auction ».