payments.getSavedStarGifts

Fetch the full list of gifts » owned, received or hosted » by a peer.Note that unlike what the name suggests, the method can be used to fetch both "saved" and "unsaved" gifts (aka gifts both pinned and not pinned) to the profile, depending on the passed flags.

API section: Working with Ansible Gifts and collectible gifts

payments.getSavedStarGifts#a319e569 flags:# exclude_unsaved:flags.0?true exclude_saved:flags.1?true exclude_unlimited:flags.2?true exclude_unique:flags.4?true sort_by_value:flags.5?true exclude_upgradable:flags.7?true exclude_unupgradable:flags.8?true peer_color_available:flags.9?true exclude_hosted:flags.10?true peer:InputPeer collection_id:flags.6?int offset:string limit:int = payments.SavedStarGifts;

Parameters

NameTypeDescription
flags # Bit mask: a field written flags.N?T is present only when bit N is set.
exclude_unsaved flags.0?true
exclude_saved flags.1?true
exclude_unlimited flags.2?true
exclude_unique flags.4?true
sort_by_value flags.5?true
exclude_upgradable flags.7?true
exclude_unupgradable flags.8?true
peer_color_available flags.9?true
exclude_hosted flags.10?true
peer InputPeer The user or chat the request is about.
collection_id flags.6?int
offset string How many records to skip from the start of the selection.
limit int Maximum number of records to return.

Result

payments.SavedStarGifts

Possible errors

This method has no errors of its own: it either answers or fails on the shared checks below.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

Related pages

Types used here