contacts.ContactBirthdays

class pyrogram.raw.types.contacts.ContactBirthdays

Birthday information of our contacts.

Constructor of ContactBirthdays.

Details:

  • Layer: 223

  • ID: 114FF30D

Parameters:

  • contacts (List of ContactBirthday) – Birthday info

  • users (List of User) – User information

Functions:

This object can be returned by 1 function.

contacts.GetBirthdays

Fetch all users with birthdays that fall within +1/-1 days, relative to the current day: this method should be invoked by clients every 6-8 hours, and if the result is non-empty, it should be used to appropriately update locally cached birthday information in user.birthday.

TL Schema

contacts.contactBirthdays#114ff30d
contacts:Vector<ContactBirthday>
users:Vector<User>

= contacts.ContactBirthdays

Parameter Tree

ContactBirthdays
├── contacts → Vector < ContactBirthday >
│ └── ContactBirthday
│ ├── contact_id → long
│ └── birthday → Birthday
│ └── Birthday
│ ├── day → int
│ ├── month → int
│ └── year → int (optional)
└── users → Vector < User >
├── UserEmpty
│ └── id → long
└── User
├── is_self → true (optional)
├── contact → true (optional)
├── mutual_contact → true (optional)
├── deleted → true (optional)
├── bot → true (optional)
├── bot_chat_history → true (optional)
├── bot_nochats → true (optional)
├── verified → true (optional)
├── restricted → true (optional)
├── min → true (optional)
├── bot_inline_geo → true (optional)
├── support → true (optional)
├── scam → true (optional)
├── apply_min_photo → true (optional)
├── fake → true (optional)
├── bot_attach_menu → true (optional)
├── premium → true (optional)
├── attach_menu_enabled → true (optional)
├── bot_can_edit → true (optional)
├── close_friend → true (optional)
├── stories_hidden → true (optional)
├── stories_unavailable → true (optional)
├── contact_require_premium → true (optional)
├── bot_business → true (optional)
├── bot_has_main_app → true (optional)
├── bot_forum_view → true (optional)
├── bot_forum_can_manage_topics → true (optional)
├── id → long
├── access_hash → long (optional)
├── first_name → string (optional)
├── last_name → string (optional)
├── username → string (optional)
├── phone → string (optional)
├── photo → UserProfilePhoto (optional)
│ ├── UserProfilePhotoEmpty
│ └── UserProfilePhoto
│ ├── has_video → true (optional)
│ ├── personal → true (optional)
│ ├── photo_id → long
│ ├── stripped_thumb → bytes (optional)
│ └── dc_id → int
├── status → UserStatus (optional)
│ ├── UserStatusEmpty
│ ├── UserStatusOnline
│ │ └── expires → int
│ ├── UserStatusOffline
│ │ └── was_online → int
│ ├── UserStatusRecently
│ │ └── by_me → true (optional)
│ ├── UserStatusLastWeek
│ │ └── by_me → true (optional)
│ └── UserStatusLastMonth
│ └── by_me → true (optional)
├── bot_info_version → int (optional)
├── restriction_reason → Vector < RestrictionReason > (optional)
│ └── RestrictionReason
│ ├── platform → string
│ ├── reason → string
│ └── text → string
├── bot_inline_placeholder → string (optional)
├── lang_code → string (optional)
├── emoji_status → EmojiStatus (optional)
│ ├── EmojiStatusEmpty
│ ├── EmojiStatus
│ │ ├── document_id → long
│ │ └── until → int (optional)
│ ├── EmojiStatusCollectible
│ │ ├── collectible_id → long
│ │ ├── document_id → long
│ │ ├── title → string
│ │ ├── slug → string
│ │ ├── pattern_document_id → long
│ │ ├── center_color → int
│ │ ├── edge_color → int
│ │ ├── pattern_color → int
│ │ ├── text_color → int
│ │ └── until → int (optional)
│ └── InputEmojiStatusCollectible
│ ├── collectible_id → long
│ └── until → int (optional)
├── usernames → Vector < Username > (optional)
│ └── Username
│ ├── editable → true (optional)
│ ├── active → true (optional)
│ └── username → string
├── stories_max_id → RecentStory (optional)
│ └── RecentStory
│ ├── live → true (optional)
│ └── max_id → int (optional)
├── color → PeerColor (optional)
│ ├── PeerColor
│ │ ├── color → int (optional)
│ │ └── background_emoji_id → long (optional)
│ ├── PeerColorCollectible
│ │ ├── collectible_id → long
│ │ ├── gift_emoji_id → long
│ │ ├── background_emoji_id → long
│ │ ├── accent_color → int
│ │ ├── colors → Vector < int >
│ │ ├── dark_accent_color → int (optional)
│ │ └── dark_colors → Vector < int > (optional)
│ └── InputPeerColorCollectible
│ └── collectible_id → long
├── profile_color → PeerColor (optional)
│ ├── PeerColor
│ │ ├── color → int (optional)
│ │ └── background_emoji_id → long (optional)
│ ├── PeerColorCollectible
│ │ ├── collectible_id → long
│ │ ├── gift_emoji_id → long
│ │ ├── background_emoji_id → long
│ │ ├── accent_color → int
│ │ ├── colors → Vector < int >
│ │ ├── dark_accent_color → int (optional)
│ │ └── dark_colors → Vector < int > (optional)
│ └── InputPeerColorCollectible
│ └── collectible_id → long
├── bot_active_users → int (optional)
├── bot_verification_icon → long (optional)
└── send_paid_messages_stars → long (optional)

Example

ContactBirthdays(
    contacts=[
            ContactBirthday(
                contact_id=0,
                birthday=Birthday(
                    day=0,
                    month=0
                )
            )
        ],
    users=[
            UserEmpty(id=0)
        ],
)