Skip to content

تنظیمات

get_privacy_setting

این متد برای دریافت تنظیمات حریم خصوصی فعلی کاربر به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    privacy = app.get_privacy_setting()
    print(privacy)

get_notification_setting

این متد برای دریافت تنظیمات اعلان‌های فعلی حساب کاربری به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    notifications = app.get_notification_setting()
    print(notifications)

set_notification

این متد برای به‌روزرسانی تنظیمات اعلان‌ها به کار می‌رود.

پارامترها:

  • user_notification: فعال/غیرفعال کردن اعلان کاربران.
  • user_message_preview: نمایش/عدم نمایش پیش‌نمایش پیام کاربران.
  • group_notification: فعال/غیرفعال کردن اعلان گروه‌ها.
  • group_message_preview: نمایش/عدم نمایش پیش‌نمایش پیام گروه‌ها.
  • channel_notification: فعال/غیرفعال کردن اعلان کانال‌ها.
  • channel_message_preview: نمایش/عدم نمایش پیش‌نمایش پیام کانال‌ها.
  • in_app_sound: فعال/غیرفعال کردن صدای درون برنامه.
  • in_app_preview: فعال/غیرفعال کردن پیش‌نمایش درون برنامه.
  • new_contacts: فعال/غیرفعال کردن اعلان مخاطبین جدید.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.set_notification(
        user_notification=True,
        group_notification=False,
        in_app_sound=True
    )
    print(result)

set_setting

این متد برای تنظیم حریم خصوصی و تنظیمات حذف خودکار به کار می‌رود.

پارامترهای حریم خصوصی (مقادیر قابل قبول: Everybody، MyContacts، Nobody):

  • show_my_last_online: چه کسانی آخرین بازدید شما را ببینند.
  • show_my_phone_number: چه کسانی شماره تلفن شما را ببینند.
  • show_my_profile_photo: چه کسانی عکس پروفایل شما را ببینند.
  • link_forward_message: چه کسانی لینک پیام‌های شما را فوروارد کنند.
  • can_join_chat_by: چه کسانی بتوانند از طریق لینک به چت شما ملحق شوند.
  • show_my_birth_date: چه کسانی تاریخ تولد شما را ببینند.
  • can_called_by: چه کسانی بتوانند با شما تماس بگیرند.

پارامترهای استثنا (exceptions):

هر کدام می‌توانند یک دیکشنری با کلیدهای include_users و exclude_users باشند.

نکته: قوانین استثناها: - برای Everybody فقط exclude_users مجاز است. - برای Nobody فقط include_users مجاز است. - برای MyContacts هر دو مجاز هستند. - برای پاک کردن استثناها، {'exclude_users': []} بفرستید.

پارامترهای حذف خودکار:

  • auto_delete_messages: مدت زمان حذف خودکار پیام‌ها. مقادیر قابل قبول:
  • Off (غیرفعال)
  • عدد (۱ تا ۳۶۵ روز)
  • رشته‌هایی مثل 1d، 7d، 30d، 1w، 1m، 1y
  • کلمات کلیدی: never، disabled، day، week، month، year
  • inactive_account_delete: حذف حساب پس از چند ماه عدم فعالیت. (مقادیر: 3، 6، 12، 24)

مثال‌ها:

  1. تنظیم آخرین بازدید فقط برای مخاطبین:
Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.set_setting(show_my_last_online="MyContacts")
    print(result)
  1. تنظیم با استثنا:
Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.set_setting(
        show_my_last_online="Nobody",
        show_my_last_online_exceptions={
            "include_users": ["u0abc123..."]
        }
    )
    print(result)

edit_show_last_online

این متد میانبری برای تنظیم نمایش آخرین بازدید است.

پارامترها:

  • setting: Everybody، MyContacts یا Nobody.
  • exceptions: دیکشنری استثناها (include_users و exclude_users).

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.edit_show_last_online("MyContacts")
    print(result)

edit_show_phone_number

این متد میانبری برای تنظیم نمایش شماره تلفن است.

پارامترها:

  • setting: Everybody، MyContacts یا Nobody.
  • exceptions: دیکشنری استثناها.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.edit_show_phone_number("Nobody")
    print(result)

edit_show_profile_photo

این متد میانبری برای تنظیم نمایش عکس پروفایل است.

پارامترها:

  • setting: Everybody، MyContacts یا Nobody.
  • exceptions: دیکشنری استثناها.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.edit_show_profile_photo("MyContacts")
    print(result)

edit_show_birthday

این متد میانبری برای تنظیم نمایش تاریخ تولد است.

پارامترها:

  • setting: Everybody، MyContacts یا Nobody.
  • exceptions: دیکشنری استثناها.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.edit_show_birthday("Nobody")
    print(result)

edit_can_join_chat_by

این متد میانبری برای تنظیم امکان ملحق شدن از طریق لینک است.

پارامترها:

  • setting: Everybody، MyContacts یا Nobody.
  • exceptions: دیکشنری استثناها.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.edit_can_join_chat_by("MyContacts")
    print(result)

edit_can_called_by

این متد میانبری برای تنظیم امکان تماس گرفتن با شما است.

پارامترها:

  • setting: Everybody، MyContacts یا Nobody.
  • exceptions: دیکشنری استثناها.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.edit_can_called_by("Nobody")
    print(result)

auto_delete_account

این متد برای تنظیم حذف خودکار حساب پس از مدت مشخصی عدم فعالیت به کار می‌رود.

پارامتر:

  • setting: تعداد ماه‌ها. مقادیر قابل قبول: 3، 6، 12، 24 یا رشته‌هایی مثل "3m"، "6m"، "12m"، "24m".

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.auto_delete_account(6)
    print(result)

update_my_name

این متد برای به‌روزرسانی نام و نام خانوادگی کاربر به کار می‌رود.

پارامترها:

  • first_name: نام جدید. (حداکثر ۳۰ کاراکتر)
  • last_name: نام خانوادگی جدید. (حداکثر ۵۰ کاراکتر)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.update_my_name(first_name="علی", last_name="حسینی")
    print(result)

update_my_username

این متد برای به‌روزرسانی نام‌کاربری کاربر به کار می‌رود.

پارامتر:

  • username: نام‌کاربری جدید. (حداقل ۷ و حداکثر ۳۲ کاراکتر، فقط حروف انگلیسی، اعداد و زیرخط)

نکته: نام‌کاربری نمی‌تواند با عدد یا زیرخط شروع شود یا به زیرخط ختم شود و باید حداقل شامل یک حرف باشد.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.update_my_username("new_username")
    print(result)

update_my_bio

این متد برای به‌روزرسانی بیوگرافی کاربر به کار می‌رود.

پارامتر:

  • bio: متن بیوگرافی جدید. (حداکثر ۱۵۰ کاراکتر)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.update_my_bio("این بیوگرافی من است.")
    print(result)

update_my_birthday

این متد برای به‌روزرسانی تاریخ تولد کاربر به کار می‌رود.

پارامتر:

  • birthday: تاریخ تولد با فرمت YYYY-MM-DD یا یک شیء datetime.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.update_my_birthday("2000-05-20")
    print(result)

update_my_profile

این متد برای به‌روزرسانی هم‌زمان چند بخش از پروفایل به کار می‌رود.

پارامترها:

  • first_name: نام جدید.
  • last_name: نام خانوادگی جدید.
  • bio: بیوگرافی جدید.
  • birthday: تاریخ تولد با فرمت YYYY-MM-DD.
  • location: اطلاعات موقعیت مکانی شامل:
  • longitude: طول جغرافیایی
  • latitude: عرض جغرافیایی
  • map_view: دیکشنری شامل tile_side_count، tile_urls، x_loc، y_loc

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.update_my_profile(
        first_name="علی",
        bio="برنامه‌نویس پایتون"
    )
    print(result)

get_two_passcode_status

این متد برای دریافت وضعیت تأیید دو مرحله‌ای حساب به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    status = app.get_two_passcode_status()
    print(status)

set_two_step_verification

این متد برای تنظیم تأیید دو مرحله‌ای به کار می‌رود.

پارامترها:

  • password: رمز عبور فعلی.
  • hint: راهنمایی برای یادآوری رمز. (پیش‌فرض: None)
  • recovery_email: ایمیل بازیابی. (پیش‌فرض: None)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.set_two_step_verification(
        password="current_password",
        hint="رمز من"
    )
    print(result)

check_two_step_passcode

این متد برای بررسی صحت رمز تأیید دو مرحله‌ای به کار می‌رود.

پارامتر:

  • password: رمز تأیید دو مرحله‌ای.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.check_two_step_passcode("my_password")
    print(result)

turn_off_two_step

این متد برای غیرفعال کردن تأیید دو مرحله‌ای به کار می‌رود.

پارامتر:

  • password: رمز تأیید دو مرحله‌ای فعلی.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.turn_off_two_step("my_password")
    print(result)

abort_two_step_setup

این متد برای لغو فرایند راه‌اندازی تأیید دو مرحله‌ای به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.abort_two_step_setup()
    print(result)

change_password

این متد برای تغییر رمز عبور حساب به کار می‌رود.

پارامترها:

  • password: رمز عبور فعلی.
  • new_password: رمز عبور جدید.
  • new_hint: راهنمایی جدید برای رمز.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.change_password(
        password="old_pass",
        new_password="new_pass",
        new_hint="راهنمایی جدید"
    )
    print(result)

request_forget_password

این متد برای درخواست بازنشانی رمز عبور فراموش‌شده به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.request_forget_password()
    print(result)

request_recovery_email

این متد برای درخواست ارسال کد بازیابی به ایمیل بازیابی به کار می‌رود.

پارامترها:

  • password: رمز عبور فعلی.
  • recovery_email: ایمیل بازیابی.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.request_recovery_email(
        password="my_password",
        recovery_email="example@email.com"
    )
    print(result)

verify_recovery_email

این متد برای تأیید کد ارسال‌شده به ایمیل بازیابی به کار می‌رود.

پارامترها:

  • password: رمز عبور فعلی.
  • code: کد تأیید دریافتی در ایمیل. (می‌تواند رشته یا عدد باشد)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.verify_recovery_email(
        password="my_password",
        code="123456"
    )
    print(result)

login_disable_two_step

این متد برای غیرفعال کردن تأیید دو مرحله‌ای در فرایند ورود به حساب به کار می‌رود.

پارامترها:

  • phone_number: شماره تلفن مرتبط با حساب.
  • email_code: کد تأیید ارسال‌شده به ایمیل.
  • forget_password_code_hash: هش کد بازیابی رمز عبور.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.login_disable_two_step(
        phone_number="09123456789",
        email_code="123456",
        forget_password_code_hash="hash_here"
    )
    print(result)

login_two_step_forget_password

این متد برای شروع فرایند بازیابی رمز تأیید دو مرحله‌ای فراموش‌شده به کار می‌رود.

پارامتر:

  • phone_number: شماره تلفن مرتبط با حساب.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.login_two_step_forget_password("09123456789")
    print(result)

request_change_phone_number

این متد برای درخواست تغییر شماره تلفن حساب به کار می‌رود.

پارامتر:

  • new_phone_number: شماره تلفن جدید.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.request_change_phone_number("09123456789")
    print(result)

verify_change_phone_number

این متد برای تأیید تغییر شماره تلفن با کد دریافتی به کار می‌رود.

پارامترها:

  • code: کد تأیید ارسال شده.
  • hash: هش دریافتی از متد request_change_phone_number.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.verify_change_phone_number(
        code="12345",
        hash="hash_from_request"
    )
    print(result)

get_my_sessions

این متد برای دریافت اطلاعات نشست‌های فعال حساب کاربری به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    sessions = app.get_my_sessions()
    print(sessions)

get_unconfirmed_sessions

این متد برای دریافت نشست‌های تأیید نشده (در انتظار تأیید) حساب کاربری به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    pending = app.get_unconfirmed_sessions()
    print(pending)

confirm_unconfirmed_session

این متد برای تأیید یک نشست در انتظار به کار می‌رود.

پارامتر:

  • unconfirmed_session_key: کلید نشست تأیید نشده.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.confirm_unconfirmed_session("session_key_123")
    print(result)

deny_unconfirmed_session

این متد برای رد یک نشست در انتظار به کار می‌رود.

پارامتر:

  • unconfirmed_session_key: کلید نشست تأیید نشده.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.deny_unconfirmed_session("session_key_123")
    print(result)

terminate_session

این متد برای پایان دادن به یک نشست خاص به کار می‌رود.

پارامتر:

  • session_key: کلید نشست.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.terminate_session("session_key_123")
    print(result)

terminate_other_sessions

این متد برای پایان دادن به تمام نشست‌های دیگر (به جز نشست فعلی) به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.terminate_other_sessions()
    print(result)

logout

این متد برای خروج از نشست فعلی به کار می‌رود.

پارامترها:

  • confirm: در صورت True بودن، قبل از خروج از کاربر تأیید گرفته می‌شود (y/n). در صورت False بودن، بدون پرسش خارج می‌شود. (پیش‌فرض: True)

توجه: در حالت confirm=True، برای تکمیل عملیات خروج باید حرف y را در کنسول وارد نمایید.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.logout()
    print(result)

    # خروج بدون تأیید
    result = app.logout(confirm=False)
    print(result)

delete_account

این متد برای درخواست حذف دائمی حساب به کار می‌رود.

توجه: پس از اجرا، یک پیامک تأیید حاوی لینک حذف حساب به شماره شما ارسال خواهد شد.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.delete_account()
    print(result)

get_folders

این متد برای دریافت لیست پوشه‌ها (Folders) به کار می‌رود.

پارامتر:

  • last_state: آخرین وضعیت برای دریافت پوشه‌ها. (پیش‌فرض: زمان فعلی منهای ۱۵۰ ثانیه)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    folders = app.get_folders()
    print(folders)

get_suggested_folders

این متد برای دریافت پوشه‌های پیشنهادی کاربر به کار می‌رود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    suggested = app.get_suggested_folders()
    print(suggested)

add_folder

این متد برای افزودن یک پوشه جدید برای سازمان‌دهی چت‌ها به کار می‌رود.

پارامترها:

  • name: نام پوشه.
  • include_chats: چت‌هایی که در پوشه قرار گیرند (GUID، لینک یا نام‌کاربری).
  • exclude_chats: چت‌هایی که از پوشه مستثنی شوند.
  • include_chat_types: انواع چت برای شمول (مانند Contacts، Users، Groups، Channels، Bots، Services).
  • exclude_chat_types: انواع چت برای استثنا (مانند Mute، Read، Archive).
  • is_add_to_top: افزودن پوشه به بالای لیست. (پیش‌فرض: True)
  • suggestion_folder_id: شناسه پوشه پیشنهادی.
  • folder_id: شناسه پوشه.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.add_folder(
        name="دوستان",
        include_chats=["@User1", "@User2"]
    )
    print(result)

delete_folder

این متد برای حذف یک پوشه به کار می‌رود.

پارامتر:

  • folder_id: شناسه پوشه.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.delete_folder("folder_id_123")
    print(result)

reorder_folder

این متد برای تغییر ترتیب پوشه‌ها به کار می‌رود.

پارامتر:

  • folder_ids: یک شناسه یا لیستی از شناسه‌های پوشه‌ها به ترتیب جدید.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.reorder_folder(["id3", "id1", "id2"])
    print(result)

add_saved_music_playlist

این متد برای افزودن آهنگ به لیست موسیقی ذخیره شده در پروفایل به کار می‌رود.

پارامترها:

  • files: یک مسیر فایل یا لیستی از مسیرهای فایل‌های موسیقی.
  • file_inlines: لیست دیکشنری‌های file_inline از پیش آپلود شده.
  • time: مدت زمان سفارشی به ثانیه. (در صورت عدم ارسال، تشخیص خودکار)
  • performer: نام خواننده سفارشی. (در صورت عدم ارسال، تشخیص خودکار)
  • file_name: نام فایل سفارشی. (در صورت عدم ارسال، از نام اصلی فایل استفاده می‌شود)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.add_saved_music_playlist(
        files=["song1.mp3", "song2.mp3"]
    )
    print(result)

add_saved_music_track

این متد برای افزودن یک آهنگ تکی به لیست موسیقی ذخیره شده در پروفایل به کار می‌رود.

پارامترها:

  • track: مسیر فایل موسیقی یا bytes خام.
  • file_inline: دیکشنری file_inline از پیش آپلود شده.
  • time: مدت زمان سفارشی به ثانیه. (در صورت عدم ارسال، تشخیص خودکار)
  • performer: نام خواننده سفارشی. (در صورت عدم ارسال، تشخیص خودکار)
  • file_name: نام فایل سفارشی.

نکته: باید یا track یا file_inline ارسال شود.

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.add_saved_music_track("song.mp3")
    print(result)

set_saved_music_playlist

این متد برای جایگزینی کامل لیست موسیقی ذخیره شده در پروفایل به کار می‌رود.

پارامترها:

  • files: یک مسیر فایل یا لیستی از مسیرهای فایل‌های موسیقی.
  • file_inlines: لیست دیکشنری‌های file_inline از پیش آپلود شده.
  • time: مدت زمان سفارشی به ثانیه. (در صورت عدم ارسال، تشخیص خودکار)
  • performer: نام خواننده سفارشی. (در صورت عدم ارسال، تشخیص خودکار)
  • file_name: نام فایل سفارشی. (در صورت عدم ارسال، از نام اصلی فایل استفاده می‌شود)

مثال:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.set_saved_music_playlist(
        files=["song1.mp3", "song2.mp3"]
    )
    print(result)

delete_saved_music_playlist

این متد برای حذف آهنگ‌ها از لیست موسیقی ذخیره شده به کار می‌رود.

پارامتر:

  • position: موقعیت آهنگ برای حذف. اگر None باشد، تمام آهنگ‌ها حذف می‌شوند. (پیش‌فرض: None)

مثال‌ها:

حذف یک آهنگ خاص:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.delete_saved_music_playlist(position=1)
    print(result)

حذف تمام آهنگ‌ها:

Python
from maxrubika import Messenger

with Messenger("mySession") as app:
    result = app.delete_saved_music_playlist()
    print(result)

upgrade_to_api6

این متد برای ارتقاء از API نسخه ۵ به نسخه ۶ با تنظیم کلید عمومی RSA به کار می‌رود.

پارامترها:

  • save_as: در صورت True بودن، auth و private_key در فایل JSON ذخیره می‌شود. (پیش‌فرض: True)
  • file_name: نام فایل سفارشی برای ذخیره. (پیش‌فرض: maxrubika_{auth[:10]})

نکته: این متد فقط با api_version = 5 کار می‌کند.

مثال:

Python
from maxrubika import Messenger

with Messenger(auth = "ahkjbsawthnh...", api_version=5) as app:
    result = app.upgrade_to_api6()
    print(result)