Interface: SendGiftParams

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

Params object for sendGift method

Properties

Property	Type	Description	Defined in
`chat_id?`	`string` \| `number`	Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format `@channelusername`) that will receive the gift.	@gramio/types/out/params.d.ts:2687
`gift_id`	`string`	Identifier of the gift; limited gifts can't be sent to channel chats	@gramio/types/out/params.d.ts:2691
`pay_for_upgrade?`	`boolean`	Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver	@gramio/types/out/params.d.ts:2695
`text?`	`string` \| { `toString`: `string`; }	Text that will be shown along with the gift; 0-128 characters	@gramio/types/out/params.d.ts:2699
`text_entities?`	`TelegramMessageEntity`[]	A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.	@gramio/types/out/params.d.ts:2707
`text_parse_mode?`	`"HTML"` \| `"MarkdownV2"` \| `"Markdown"`	Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.	@gramio/types/out/params.d.ts:2703
`user_id?`	`number`	Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.	@gramio/types/out/params.d.ts:2683