payments.sendStarGiftOffer

Send an offer to purchase a collectible gift », see here » for the full flow.

API section: Working with Ansible Gifts and collectible gifts

payments.sendStarGiftOffer#8fb86b41 flags:# peer:InputPeer slug:string price:StarsAmount duration:int random_id:long allow_paid_stars:flags.0?long = Updates;

Parameters

NameTypeDescription
flags # Bit mask: a field written flags.N?T is present only when bit N is set.
peer InputPeer The user or chat the request is about.
slug string Short address used in the link.
price StarsAmount
duration int Duration in seconds.
random_id long A random number from the client. The server uses it to discard duplicates when a request goes out twice.
allow_paid_stars flags.0?long

Result

Updates

Possible errors

Read out of the handler itself — this is what the server actually returns for this method.

CodeTypeWhat it means
400 STARGIFT_OFFER_INVALID The gift offer is not valid.

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