get_chat_gifts_count()¶

Client.get_chat_gifts_count()¶

Get the total count of owned gifts of specified chat.

Usable by Users Bots

Parameters:¶

• chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

• exclude_unsaved (bool, optional) – Exclude unsaved star gifts.

• exclude_saved (bool, optional) – Exclude saved star gifts.

• exclude_unlimited (bool, optional) – Exclude unlimited star gifts.

• exclude_limited (bool, optional) – Exclude limited star gifts.

• exclude_upgraded (bool, optional) – Exclude upgraded star gifts.

Returns:¶

int – On success, the star gifts count is returned.

Example

await app.get_chat_gifts_count(chat_id)