GramIO API Reference / gramio/dist / GetChatGiftsParams

Interface: GetChatGiftsParams

Defined in: @gramio/types/out/params.d.ts:3085

Params object for getChatGifts method

Properties

Property	Type	Description	Defined in
chat_id	string | number	Unique identifier for the target chat or username of the target channel (in the format @channelusername)	@gramio/types/out/params.d.ts:3089
exclude_from_blockchain?	boolean	Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram	@gramio/types/out/params.d.ts:3113
exclude_limited_non_upgradable?	boolean	Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique	@gramio/types/out/params.d.ts:3109
exclude_limited_upgradable?	boolean	Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique	@gramio/types/out/params.d.ts:3105
exclude_saved?	boolean	Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.	@gramio/types/out/params.d.ts:3097
exclude_unique?	boolean	Pass True to exclude unique gifts	@gramio/types/out/params.d.ts:3117
exclude_unlimited?	boolean	Pass True to exclude gifts that can be purchased an unlimited number of times	@gramio/types/out/params.d.ts:3101
exclude_unsaved?	boolean	Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.	@gramio/types/out/params.d.ts:3093
limit?	number	The maximum number of gifts to be returned; 1-100. Defaults to 100	@gramio/types/out/params.d.ts:3129
offset?	string	Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results	@gramio/types/out/params.d.ts:3125
sort_by_price?	boolean	Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.	@gramio/types/out/params.d.ts:3121