getReceivedGifts¶
Returns gifts received by the given user or chat
getReceivedGifts(
business_connection_id: string,
owner_id: MessageSender,
collection_id: int32,
exclude_unsaved: Bool,
exclude_saved: Bool,
exclude_unlimited: Bool,
exclude_upgradable: Bool,
exclude_non_upgradable: Bool,
exclude_upgraded: Bool,
exclude_without_colors: Bool,
exclude_hosted: Bool,
sort_by_price: Bool,
offset: string,
limit: int32
) → ReceivedGifts
business_connection_id¶
string
Unique identifier of business connection on behalf of which to send the request; for bots only
owner_id¶
Identifier of the gift receiver
collection_id¶
int32
Pass collection identifier to get gifts only from the specified collection; pass 0 to get gifts regardless of collections
exclude_unsaved¶
Bool
Pass true to exclude gifts that aren't saved to the chat's profile page. Always true for gifts received by other users and channel chats without can_post_messages administrator right
exclude_saved¶
Bool
Pass true to exclude gifts that are saved to the chat's profile page. Always false for gifts received by other users and channel chats without can_post_messages administrator right
exclude_unlimited¶
Bool
Pass true to exclude gifts that can be purchased unlimited number of times
exclude_upgradable¶
Bool
Pass true to exclude gifts that can be purchased limited number of times and can be upgraded
exclude_non_upgradable¶
Bool
Pass true to exclude gifts that can be purchased limited number of times and can't be upgraded
exclude_upgraded¶
Bool
Pass true to exclude upgraded gifts
exclude_without_colors¶
Bool
Pass true to exclude gifts that can't be used in setUpgradedGiftColors
exclude_hosted¶
Bool
Pass true to exclude gifts that are just hosted and are not owned by the owner
sort_by_price¶
Bool
Pass true to sort results by gift price instead of send date
offset¶
string
Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
limit¶
int32
The maximum number of gifts to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit