🎛 Models

🕹 Base model

class meapi.models.me_model.MeModel

Base class for all models.

• Allow instances to be comparable, subscript, hashable, immutable (In some cases), and json serializable.

Examples

>>> my_profile = me.get_my_profile() # Get your profile.
>>> my_profile.name # regular access
>>> my_profile['name'] # subscript access
>>> my_profile.get('name', default='') # safe access
>>> my_profile.as_dict() # get all data as dict
>>> my_profile.as_json() # get all data as json string
>>> my_profile == other_profile # compare two objects

Methods:

as_dict(only: Optional[Union[str, List[str]]] = None, exclude: Optional[Union[str, List[str]]] = None, recursive: bool = True) → Dict[str, Any]

Return class data as dict.

Examples

>>> my_profile = me.get_my_profile() # Get your profile.
>>> my_profile.as_dict()
{'phone_number': 972123456789, 'first_name': 'David', 'last_name': 'Lev', 'socials': {'lin ...}
>>> my_profile.as_dict(only=('phone_number', 'first_name'), recursive=False)
{'phone_number': 972123456789, 'first_name': 'David'}

Parameters:

• only (str | list[str]) – Return only the given keys.

• exclude (str | list[str]) – Exclude the given keys.

• recursive (bool) – If True (default), return all nested objects as dict.

as_json(only: Optional[Union[str, List[str]]] = None, exclude: Optional[Union[str, List[str]]] = None, recursive: bool = True, ensure_ascii: bool = False) → str

Return class data in json format.

Parameters:

• only (str | list[str]) – Return only the given keys.

• exclude (str | list[str]) – Exclude the given keys.

• recursive (bool) – If True (default), return all nested objects as dict.

• ensure_ascii (bool) – If True, all non-ASCII characters in the output are escaped with \uXXXX sequences.

get(item: str, default: Optional[Any] = None)

Return the value of the attribute with the given name.

• Example:

  >>> my_profile = me.get_my_profile() # Get your profile.
  >>> my_profile.get('phone_number')
  

Parameters:

• item (str) – The name of the attribute.

• default (any) –

  The default value to return if the attribute does not exist.

  • Default: None

Returns:

The value of the attribute, or default if the attribute does not exist.

😎 Profile model

class meapi.models.profile.Profile

Represents the user’s profile. can also be used to update you profile details.

• Modifiable attributes are marked with modifiable.

• For more information about the modifiable attributes, see update_profile_details().

Example

>>> # Update your profile details.
>>> my_profile = me.get_my_profile()
>>> my_profile.name = "Chandler Bing"
>>> my_profile.date_of_birth = "1968-04-08"
>>> my_profile.slogan = "Hi, I'm Chandler. I make jokes when I'm uncomfortable."
>>> my_profile.profile_picture = "/home/chandler/Downloads/my_profile.jpg"

Parameters:

• name (str optional, modifiable) – The user’s full name (first_name + last_name).

• first_name (str optional, modifiable) – The user’s first name.

• last_name (str optional, modifiable) – The user’s last name.

• profile_picture (str optional, modifiable) – The user’s profile picture url.

• slogan (str optional, modifiable) – The user’s bio.

• email (str optional, modifiable) – The user’s email.

• gender (str optional, modifiable) – The user’s gender: M for male and F for female.

• date_of_birth (date optional, modifiable) – The user’s date of birth.

• age (int) – The user’s age. calculated from date_of_birth if exists, else 0.

• social (Social optional) – The user’s social media networks.

• phone_number (int) – The user’s phone number.

• uuid (str) – The user’s unique ID.

• phone_prefix (str) – The user’s phone prefix.

• device_type (str optional, modifiable) – The user’s device type: android or ios.

• login_type (str optional, modifiable) – The user’s login type: email or apple.

• who_deleted_enabled (bool) – Whether the user can see who deleted him (Only if is_premium, Or if he uses meapi ;).

• who_deleted (List[Deleter] optional) – The users who deleted him.

• who_watched_enabled (bool) – Whether the user can see who watched his profile (Only if is_premium, Or if he uses meapi ;).

• who_watched (List[Watcher] optional) – The users who watched him.

• friends_distance (List[User] optional) – The users who shared their location with you.

• carrier (str optional, modifiable) – The user’s cell phone carrier.

• comments_enabled (bool) – Whether the user is allowing comments. You can ask the user to turn on comments with suggest_turn_on_comments().

• comments_blocked (bool) – Whether the user blocked you from commenting on his profile.

• country_code (str) – The user’s two-letter country code.

• location_enabled (bool optional) – Whether the user is allowing location.

• is_shared_location (bool optional) – Whether the user is sharing their location with you. You can ask the user to share his location with suggest_turn_on_location().

• share_location (bool optional) – Whether the user is sharing their location with you.

• distance (float optional) – The user’s distance from you.

• location_longitude (float optional) – The user’s location longitude coordinate.

• location_latitude (float optional) – The user’s location latitude coordinate.

• location_name (str optional, modifiable) – The user’s location name.

• is_he_blocked_me (bool optional) –

  Whether the user has blocked you from seeing his profile (me_full_block, See block_profile()).

  • If True, this profile will contain only the basic information, like name, uuid and phone_number.

• is_permanent (bool optional) – Whether the user is permanent.

• mutual_contacts_available (bool optional) – Whether the user has mutual contacts available. You can ask the user to turn on this feature with suggest_turn_on_mutual().

• mutual_contacts (List[MutualContact] optional) – For more information about mutual contacts.

• is_premium (bool) – Whether the user is a premium user.

• is_verified (bool) – Whether the user is verified.

• gdpr_consent (bool) – Whether the user has given consent to the GDPR.

• facebook_url (str optional, modifiable) – The user’s Facebook ID.

• google_url (str optional, modifiable) – The user’s Google ID.

• me_in_contacts (bool optional) – Whether you are in the user’s contacts.

• user_type (str optional) –

  The user’s type: the color of the user in the app:

  • BLUE: Verified Caller ID from ME users (100% ID).

  • GREEN: Identified call with a very reliable result.

  • YELLOW: Uncertain Identification (Unverified).

  • ORANGE: No identification (can be reported).

  • RED: Spam calls.

• verify_subscription (bool optional) – Whether the user has verified their subscription.

Get friendship

friendship().

Get comments

get_comments().

Get the profile as Vcard

as_vcard().

Block the profile

block().

Unblock this profile

unblock().

Report this profile as spam

report_spam().

🧑 User model

class meapi.models.user.User

Represents a user.

• A user is a person who log in to the app.

• If you search a phone number with phone_search(), you will get a contact, but if this contact registered on the app, you get a user attribute.

Parameters:

• name (str) – The fullname of the user. combined with first_name and last_name.

• first_name (str) – The first name of the user.

• last_name (str) – The last name of the user.

• uuid (str) – The unique identifier of the user. can be used to perform actions on the user.

• phone_number (int) – The phone number of the user.

• gender (str optional) – The gender of the user. M for male, F for female, and None if the user didn’t specify.

• email (str optional) – The email of the user.

• profile_picture (str optional) – Url to profile picture of the user.

• slogan (str optional) – The bio of the user.

• is_verified (bool optional) – Whether the user is verified (Has at least two social connected accounts).

• is_premium – Whether the user is paying for premium features (Like the ability to use who watch his profile, who deleted him from his contacts, no ads, and more).

Get friendship

friendship().

Get comments

get_comments().

Get the user as Vcard

as_vcard().

Block the user

block().

Unblock this user

unblock().

Report this user as spam

report_spam().

👤 Contact model

class meapi.models.contact.Contact

Represents a contact.

Parameters:

• name (str) – The name of the contact.

• phone_number (int) – The phone number of the contact.

• id (int) – The id of the contact.

• picture (str optional) – The url picture of the contact.

• user (User optional) – The user of the contact. if the user register on the app.

• suggested_as_spam (int optional) – The number of times the contact has been suggested as spam.

• user_type (str optional) –

  The user’s type: the color of the user in the app:

  • BLUE: Verified Caller ID from ME users (100% ID).

  • GREEN: Identified call with a very reliable result.

  • YELLOW: Uncertain Identification (Unverified).

  • ORANGE: No identification (can be reported).

  • RED: Spam calls.

• is_permanent (bool optional) – Whether the contact is permanent.

• is_pending_name_change (bool optional) – Whether the contact is pending name change.

• cached (bool optional) – Whether the results from the api is cached.

• is_shared_location (bool optional) – Whether the contact is shared location.

• created_at (datetime optional) – The date of the contact creation.

• modified_at (datetime optional) – The date of the contact modification.

• in_contact_list (bool optional) – Whether the contact is in the contact list.

• is_my_contact (bool optional) – Whether the contact is my contact.

Get friendship

friendship().

Get comments

get_comments().

Get the contact as Vcard

as_vcard().

Block this contact

block().

Unblock this contact

unblock().

Report this contact as spam

report_spam().

🤲 Common model

class meapi.models.common._CommonMethodsForUserContactProfile

Common methods for Profile, User and Contact.

as_vcard(prefix_name: str = '', dl_profile_picture: bool = False, **kwargs) → str

Get contact data in vcard format in order to add it to your contacts book.

Usage examples:

# Get your profile as vcard
my_profile = me.get_my_profile()
print(my_profile.as_vcard(twitter='social.twitter.profile_id', gender='gender')

# Save profiles as vcard file
uuids = ['xx-xx-xx-xx', 'yy-yy-yy-yy', 'zz-zz-zz-zz']
profiles = [me.get_profile(uuid) for uuid in uuids] # can raise rate limit exception.
vcards = [profile.as_vcard(prefix_name="Imported", dl_profile_picture=False,
    location='location_name') for profile in profiles]
with open('contacts.vcf', 'w') as contacts:
    contacts.write('\n'.join(vcards))

Parameters:

• prefix_name – (str): If you want to add prefix to the name of the contact, like Mr., Mrs., Imported etc. Default: empty string "".

• dl_profile_picture – (bool): If you want to download and add profile picture to the vcard (if available). Default: False.

• kwargs –

  Add any other data to the notes field of the vcard. The key must be, of course, exists in the object as attr eith value of str or int.

  • For example, if you want to add a gender information to the contact, you can pass the parameter gender='gender'

  • The key uses as the title in the notes (you name it as you like), and the value is the attribute name of the object.

  • You can go even deeper: if Profile object provided, you may want to do something like twitter='social.twitter.profile_id'.

  • No exception will be raised if the key doesn’t exist.

Returns:

Vcard format as string. See Wikipedia for more information.

Return type:

str

Results example:

BEGIN:VCARD
VERSION:3.0
FN;CHARSET=UTF-8;ENCODING=QUOTED-PRINTABLE:Rachel Green
TEL;CELL:1234567890
PHOTO;ENCODING=BASE64;JPEG:/9j/4AAQSgyIR..........
EMAIL:rachelg@friends.tv
BDAY:1969-05-05
NOTE;CHARSET=UTF-8;ENCODING=QUOTED-PRINTABLE:Twitter: RachelGreeen | Gender: F
END:VCARD

block(block_contact=True, me_full_block=True) → bool

Block a contact.

Parameters:

• block_contact – (bool): If you want to block the contact from calls. Default: True.

• me_full_block – (bool): If you want to block the contact from Me platform. Default: True.

Returns:

True if the contact was blocked successfully, else False.

Return type:

bool

Raises:

TypeError – If you try to block yourself.

friendship() → Friendship

Returns the friendship status of the contact.

Returns:

True if the contact is your friend, else False.

Return type:

bool

get_comments() → List[Comment]

Returns the comments of the contact.

Returns:

The comments of the contact.

Return type:

List[Comment]

get_profile() → Optional[Profile]

Returns the profile of the contact.

Returns:

The profile of the contact or None if the contact has no user.

Return type:

Profile | None

report_spam(spam_name: str, country_code: str) → bool

Report this contact as spam.

• The same as report_spam().

Parameters:

• spam_name – (str): Name of the spammer.

• country_code – (str): Country code of the spammer.

Returns:

True if the contact was reported successfully, else False.

Return type:

bool

unblock(unblock_contact=True, me_full_unblock=True) → bool

Unblock a contact.

Parameters:

• unblock_contact – (bool): If you want to unblock the contact from calls. Default: True.

• me_full_unblock – (bool): If you want to unblock the contact from Me platform. Default: True.

Returns:

True if the contact was unblocked successfully, else False.

Return type:

bool

Raises:

TypeError – If you try to unblock yourself.

👥 Group model

class meapi.models.group.Group

Represents a group of users that save you in their contact list in the same name

• For more information about this feature

Examples

>>> my_groups = me.get_groups()
>>> group = my_groups[0]
>>> group.name
'Phoebe Buffay'
>>> group.count
6
>>> group.last_contact_at
datetime.datetime(2004, 5, 6, 21, 0)
>>> group.ask_to_rename(new_name='Regina Phalange')

Parameters:

• name (str) – The name of the group, how your number saved in their contact list.

• count (int) – The number of users in the group.

• last_contact_at (datetime optional) – The last time that you saved in someone’s contact list.

• contacts (List[User]) – The users that are in the group.

• contact_ids (List[int]) – The ids of the users that are in the group.

• is_active (bool) – Is the group active. - You can use delete() to hide the group and restore() to restore it.

Methods:

delete() → bool

Deletes the group.

• The same as delete_group().

• You get True even if the group is already hidden.

Returns:

True if the group was deleted, False otherwise.

Return type:

bool

restore() → bool

Restores the group.

• The same as restore_group().

• You get True even if the group is already active.

Returns:

True if the group was restored, False otherwise.

Return type:

bool

ask_to_rename(new_name) → bool

Asks from the users in the group to rename you in their contact list.

• The same as ask_group_rename().

• You can’t adk rename a group if it’s hidden (is_active=False).

Parameters:

new_name (str) – The new name that you want them to rename you in their contact list.

Returns:

True if the suggested send, False otherwise.

Return type:

bool

📱 Social model

class meapi.models.social.Social

Represents user’s social media accounts.

Examples

>>> my_socials = me.get_socials()
>>> my_socials.instagram.add(token_or_url="xxxxxxxxxxxxxxx")
True
>>> my_socials.instagram.profile_url
https://instagram.com/courteneycoxofficial
>>> my_socials.instagram.posts[0].text
"Okay, hypothetically, why won’t I be married when I’m 40?"

Parameters:

• facebook (SocialMediaAccount) – Facebook account.

• fakebook (SocialMediaAccount) – Fakebook account.

• instagram (SocialMediaAccount) – Instagram account.

• linkedin (SocialMediaAccount) – LinkedIn account.

• pinterest (SocialMediaAccount) – Pinterest account.

• spotify (SocialMediaAccount) – Spotify account.

• tiktok (SocialMediaAccount) – Tiktok account.

• twitter (SocialMediaAccount) – Twitter account.

class meapi.models.social.SocialMediaAccount

Represents user’s social media account.

Examples

>>> my_socials = me.get_socials()
>>> my_socials.spotify.add(token_or_url="xxxxxxxxxxxxxxx") # connect spotify account
True
>>> my_socials.spotify.hide() # hide account from public
True
>>> my_socials.spotify.unhide() # unhide account from public
True
>>> my_socials.spotify.remove() # remove account

Parameters:

• name (str) – Name of social media account.

• profile_id (str optional) – Profile ID or username of social media account.

• profile_url (str optional) – The profile url of social media account.

• posts (List[Post]) – List of posts from social media account.

• is_active (bool) – Is social media account active.

• is_hidden (bool) – Is social media account hidden by the user (You can see it because the API sends it anyway ;).

Methods:

add(token_or_url: str) → bool

Add social media account to your Me profile.

• If you have at least two social media accounts, you get verification tag on your profile. is_verified = True.

Parameters:

token_or_url (str) –

Token or URL of social media account.

• See add_social() for more information.

Returns:

True if successfully added, False otherwise.

Return type:

bool

remove() → bool

Remove social media account from your Me profile.

Returns:

True if successfully removed, False otherwise.

• You get True even if the social media account not active.

Return type:

bool

hide() → bool

Hide social media account in your Me profile.

• You get True even if the social media account not active or already hidden.

Returns:

True if successfully hidden, False otherwise.

Return type:

bool

unhide() → bool

Unhide social media account in your Me profile.

• You get True even if the social media already unhidden.

Returns:

True if successfully unhidden, False otherwise.

Return type:

bool

class meapi.models.social.Post

Represents Social Media post.

• Not every social media account has posts.

Parameters:

• author (str optional) – Author of post.

• owner (str optional) – Owner of post.

• text_first (str optional) – First text of post.

• text_second (str optional) – Second text of post.

• redirect_id (str optional) – Redirect ID of post.

• photo (str optional) – Photo of post.

💬 Comment model

class meapi.models.comment.Comment

Represents a comment.

Examples

>>> my_comments = me.get_comments()
>>> my_comments[0].message
'We were on a break!'
>>> my_comments[0].like_count
7
>>> my_comments[0].author.name
'Ross Geller'
>>> my_comments[0].like()
True
>>> my_comments[0].reply("I got off the plane.")
<Comment id=123 status=waiting msg=I got off the plane. author=Rachel Green>

Parameters:

• message (str) – The message of the comment.

• id (int) – The id of the comment.

• status (str) – The status of the comment: approved, ignored, waiting, deleted.

• author (User) – The creator of the comment.

• like_count (int) – The number of likes of the comment.

• comment_likes (list of User) – The list of users who liked the comment.

• created_at (datetime | None) – The date of the comment creation.

• is_liked (bool) – Whether the creator liked his comment.

• comments_blocked (bool) – Whether the user blocked the comments of the comment.

Methods:

approve() → bool

Approve the comment.

• You can only approve comments that posted by others on your own profile.

• The same as approve_comment().

Returns:

Is approve success.

Return type:

bool

edit(new_msg: str, remove_credit: bool = False) → bool

Edit the comment.

• You can only edit comments that posted by you.

• The same as publish_comment().

Parameters:

• new_msg (str) – The new message of the comment.

• remove_credit (bool) – Whether to remove the credit to meapi from the comment.

Returns:

Is edit success.

Return type:

bool

ignore() → bool

Ignore and hide the comment.

• You can only ignore and hide comments that posted by others on your own profile.

• The same as ignore_comment().

Returns:

Is ignore success.

Return type:

bool

delete() → bool

Delete the comment.

• You can only delete comments that posted on your own profile or by you.

• The same as delete_comment().

Returns:

Is delete success.

Return type:

bool

like() → bool

Like the comment.

• The same as like_comment().

Returns:

Is like success.

Return type:

bool

unlike() → bool

Unlike the comment.

• The same as unlike_comment().

Returns:

Is unlike success.

Return type:

bool

reply(your_comment: str) → Optional[Comment]

Publish a comment in the profile of the comment author.

• The same as publish_comment().

• if you already replied to the comment, this will edit the comment like edit().

Parameters:

your_comment (str) – The message of the comment.

Returns:

The new comment.

Return type:

Comment

block()

Block the author of the comment from posting comments on your profile.

• The same as block_comments().

• This will not delete the comment. It will just block the author from editing or posting comments on your profile.

Returns:

Is block success.

Return type:

bool

👁 Watcher model

class meapi.models.watcher.Watcher

Represents a Watcher, user who watch your profile.

• For more information about Watcher

Examples

>>> my_watchers = me.who_watched()
>>> watcher = my_watchers[0]
>>> watcher.user.name
'Mike Hannigan'
>>> watcher.count
15
>>> me.publish_comment(uuid=watcher.user,your_comment="So, what are your intentions with my Phoebe?")
<Comment id=321 status=waiting msg=o, what are your intentions with my Phoebe? author=Joey Tribbiani>

Parameters:

• last_view (datetime) – Date of last view.

• user (User) – The user who watch your profile.

• count (int) – The number of views.

• is_search (bool) – Whether the user is searching your profile.

❌ Deleter model

class meapi.models.deleter.Deleter

Represents a Deleter, user who delete you from his contacts.

• For more information about Deleter

Examples

>>> my_deleters = me.who_deleted()
>>> deleter = my_deleters[0]
>>> deleter.user.name
'Janine Lecroix'
>>> me.publish_comment(uuid=deleter.user,your_comment="How You Doin'?")
<Comment id=456 status=waiting msg=How You Doin'? author=Joey Tribbiani>

Parameters:

• created_at (str) – Date of delete.

• user (User) – User who delete you.

🤝 Friendship model

class meapi.models.friendship.Friendship

Represents a Friendship.

• Friendship is a relationship between you and another user.

• For more information about Friendship

Examples

>>> janice_and_i = me.friendship(phone_number=1969030000000)
>>> janice_and_i.he_named
'Little bingaling'
>>> janice_and_i.i_named
'Oh. My. God.'
>>> janice_and_i.his_comment
'You're my little love muffin'
>>> janice_and_i.my_comment
'I seek you out!

Parameters:

• calls_duration (int) – The duration of your calls in seconds.

• he_called (int) – The number of times the other user has called you.

• i_called (int) – The number of times you have called the other user.

• he_named (str) – How the other user named you in his contacts book.

• i_named (str) – How you named the other user in your contacts book.

• he_watched (int) – The number of times the other user has watched your profile.

• his_comment (str) – The comment the other user has comment on your profile.

• my_comment (str optional) – The comment you have comment on the other user’s profile.

• i_watched (int) – The number of times you have watched the other user’s profile.

• mutual_friends_count (int) – The number of mutual contacts between you and the other user.

• is_premium (bool) – Whether the other user is a premium user.

🔔 Notification model

class meapi.models.notification.Notification

Represents a Notification from the app.

• Notification could be new comment, new profile watch, new deleted, contact birthday, suggestion, etc.

• For more information about Notification

Examples

>>> my_notifications = me.get_notifications()
>>> notification = my_notifications[0][0]
>>> notification.category
'UPDATED_CONTACT'
>>> notification.name
'Mike Hannigan'
>>> notification.new_name
'Princess Consuela Banana-Hammock'
>>> me.publish_comment(uuid=notification.uuid,your_comment="Hi *** bag!")
<Comment id=678 status=waiting msg=Hi *** bag! author=Phoebe Buffay>

Parameters:

• id (int) – The id of the notification.

• created_at (datetime`) – Date of creation.

• modified_at (datetime`) – Date of last modification.

• is_read (bool) – Whether the notification is read.

• sender (str) – UUID of the sender of the notification.

• status (str) – Status of the notification.

• delivery_method (str) – Delivery method of the notification. Most likely push.

• distribution_date (datetime) – Date of distribution.

• category (str) – Category of the notification.

• message_lang (str) – Language of the notification, en, he etc.

• message_subject (str optional) – Subject of the notification.

• message_body (str optional) – Body of the notification.

• context (dict optional) – The context of the notification: name, uuid, new_name, tag, profile_picture and more.

Methods:

read() → bool

Mark the notification as read.

• The same as read_notification().

Returns:

Whether the notification was marked as read.

Return type:

bool

⚙️ Settings model

class meapi.models.settings.Settings

Manage your social, notification and app settings.

• You can edit your settings by simply assigning a new value to the attribute.

• Modifiable attributes are marked with modifiable.

• For more information about the modifiable attributes, see change_settings().

Example

>>> # Take control of your privacy:
>>> my_settings = me.get_settings()
>>> my_settings.who_watched_enabled = False
>>> my_settings.who_deleted_enabled = False
>>> my_settings.mutual_contacts_available = False
>>> my_settings.comments_enabled = False
>>> my_settings.location_enabled = False

Parameters:

• who_deleted_enabled (bool modifiable) –

  If True, other users can see if you deleted them from your contact book

  • The users can see it only if they is_premium users, or by using meapi ;)

  • Must be enabled in order to use who_deleted().

• who_watched_enabled (bool modifiable) –

  If True, other users can see if you watch their profile.

  • The users can see it only if they is_premium users, or by using meapi ;)

  • Must be enabled in order to use who_watched().

• comments_enabled (bool modifiable) –

  Allow other users to publish_comment() on your profile.

  • You always need to approve_comment() before they are published.

  • You can block spesfic users from commenting on your profile with block_comments().

• location_enabled (bool modifiable) – Allow other users ask to see your location.

• mutual_contacts_available (bool modifiable) –

  If True, other users can see your mutual contacts.

  • See friendship() for more information.

• notifications_enabled (bool modifiable) –

  Get notify on new messages.

  • See get_notifications() for more information.

• who_deleted_notification_enabled (bool modifiable) –

  Get notify on who deleted you from your contact book.

  • You will only receive notifications if who_deleted_enabled is True.

• who_watched_notification_enabled (bool modifiable) –

  Get notify on who watched your profile.

  • You will only receive notifications if who_watched_enabled is True.

• comments_notification_enabled (bool modifiable) –

  Get notify on new comments, likes etc.

  • You will only receive notifications if comments_enabled is True.

• birthday_notification_enabled (bool modifiable) – Get notify on contact birthday.

• distance_notification_enabled (bool modifiable) – Get notify on contacts distance.

• names_notification_enabled (bool modifiable) – Get notify when someone saved you in is contacts book, new joined contacts to Me, new rename approve and more.

• system_notification_enabled (bool modifiable) – Get notify on system messages: spam reports, mutual requests and more.

• contact_suspended (bool) – If True, the contact is suspended.

• language (str modifiable) – Language of the notifications.

• last_backup_at (datetime optional) – Last backup time.

• last_restore_at (datetime optional) – Last restore time.

• spammers_count (int) – Number of spammers.

🚫 BlockedNumber model

class meapi.models.blocked_number.BlockedNumber

Represents a blocked number.

• For more information about blocked numbers

Example

>>> from meapi import Me
>>> blocked_numbers = Me.get_blocked_numbers()
>>> for blocked_number in blocked_numbers: blocked_number.unblock()

Parameters:

• block_contact (bool) – This contact cannot call or text you.

• me_full_block (bool) – This contact cannot watch your Me profile (And neither will you be able to view his).

• phone_number (int) – The phone number of the contact.

🖖 MutualContact model

class meapi.models.mutual_contact.MutualContact

Represents a Mutual contact between you and another user.

Parameters:

• name (str) – The user’s fullname.

• phone_number (int) – The user’s phone number.

• date_of_birth (date) – The user’s date of birth.

• uuid (str optional) – The user’s unique ID.

Get the contact as Vcard

as_vcard().

Block this contact

block().

Unblock this contact

unblock().

Report this contact as spam

report_spam().

📑 Others

class meapi.models.others.NewAccountDetails

Account details for new account registration.

Parameters:

• first_name (str) – First name to use.

• last_name (str | None) – Last name to use. Default: None.

• email (str | None) – Email to use. Default: None.

class meapi.models.others.Call

class meapi.models.others.Contact

class meapi.models.others.CallType

Call type enum.

class meapi.models.others.RequestType

Request type enum.