پرش به محتویات

متد ها

کلاس کلاینت

  • متد : __init__(Client)
  • ورودی
فیلد نوع توضیحات
session str or None اسم سشن برای ذخیره سازی اطلاعات
auth str or None شناسه اوث
private str or None شناسه کلید پرایو
platform str = "web" پلتفرم
api_version int = 6 نسخه ای پی آی ها
proxy bool or None پروکسی برای ارسال درخواست ها
time_out int = 10 زمان خروج برای درخواست ها
show_progress_bar bool = True نمایش عملیات های در حال انجام
    • مثال

      گرفتن اطلاعات بات

      • متد : get_me
      • خروجی
      فیلد نوع توضیحات
      get_me get_me بات
      • مثال

        سینک(sync)
        آیسینک(async)

      ارسال پیام

      • متد : send_text
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      text str متن پیام
      message_id str or None در جوابِ پیامِ؟
      • خروجی
      فیلد نوع توضیحات
      message_id str شناسه پیام
      • مثال

        سینک(sync)
        ایسینک(async)

      ارسال نظرسنجی

      • متد : send_poll
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      question str متن سوال
      options list گزینه‌های سوال
      message_id str or None در جواب پیام؟
      • خروجی
      فیلد نوع توضیحات
      message_id str or None شناسه پیام
      multiple_answers bool or None چند گزینه ای
      anonymous bool or None ناشناس بودن نظرسنجی
      quiz bool or None حالت کوییز
      • مثال

        سینک(sync)
        آیسینک(async)

      ارسال موقعیت مکانی

      • متد : send_location
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      latitude str عرض جغرافیایی
      longitude str طول جغرافیایی
      message_id str or None در جوابِ پیامِ؟
      • خروجی
      فیلد نوع توضیحات
      message_id str شناسه پیام
      • مثال

        سینک(sync)
        آیسینک(async)

      ارسال مخاطب

      • متد : send_contact
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      first_name str نام مخاطب
      last_name str نام‌خانوادگی مخاطب
      phone_number str شماره مخاطب
      user_guid str گوید کاربر
      message_id str در جوابِ پیامِ؟
      • خروجی
      فیلد نوع توضیحات
      message_id str شناسه پیام
      • مثال

        سینک(sync)
        آیسینک(async)

      گرفتن آپدیت پیام ها

      • متد : on_message
      • ورودی
      فیلد نوع توضیحات
      filters filters or None فیلتر کردن گرفتن پیام
      • خروجی
      فیلد نوع توضیحات
      Message Message مسیج آپدیت
      • مثال

        سینک(sync)
        آیسینک(async)

      گرفتن اطلاعات چت

      • متد : get_chat_info
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید کاربر/گروه/کانال
      • خروجی
      فیلد نوع توضیحات
      chat chat اطلاعات چت
      • مثال

        سینک(sync)
        آیسینک(async)

      فوروارد کردن پیام

      • متد : forward_messages
      • ورودی
      فیلد نوع توضیحات
      object_guid str از آبجکت گوید
      message_ids list شناسه های پیام ها
      to_object_guid str به آبجکت گوید
      • خروجی
      فیلد نوع توضیحات
      new_message_id str شناسه پیام جدید
      • مثال

        سینک(sync)
        آیسینک(async)

      ویرایش متن پیام

      • متد : edit_message
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      text str پیام
      message_id str شناسه پیام
      • مثال

        سینک(sync)
        آیسینک(async)

      حذف پیام

      • متد : delete_messages
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      message_ids list شناسه های پیام ها
      delete_for_all bool = True حذف برای همه
      • مثال

        سینک(sync)
        آیسینک(async)

      ارسال فایل/ویدیو/تصویر/پیغام صوتی/موسیقی/گیف/ویدیو مسیج

      • متد : send_file , send_video , send_image , send_voice , send_music , send_gif , send_video_message
      • ورودی
      فیلد نوع توضیحات
      object guid str چت آیدی
      file str فایل
      name_file str or None(name_file = "file") نام فایل
      message_id str or None در جواب ؟
      text str or None کپشن فایل
      thumbnail str or None thumbnail
      file_name str or None اسم فایل
      • مثال

        سینک(sync)
        آیسینک(async)

      دانلود فایل

      • متد : download
      • ورودی
      فیلد نوع توضیحات
      object_guid str آبجکت گوید
      message_id str مسیج آیدی
      save bool = False ذخیره
      save_as str or None ذخیره در
      save_as str or None ذخیره در
      file_inline dict or None فایل
      • مثال

        سینک(sync)
        آیسینک(async)

        گرفتن لینک دانلود فایل

        • متد : get_download_link
        • ورودی
        فیلد نوع توضیحات
        objcet_guid str آبجکت گوید
        message_id str مسیج آیدی
        file_inline str or None فایل
        • مثال

          سینک(sync)
          آیسینک(async)

          پیوستن به چت

          • متد : join_chat
          • مثال

            سینک(sync)
            آیسینک(async)

            ترک چت

            • متد : leave_chat
            • ورودی ها
            • فیلد نوع توضیحات
              object_guid str آبجکت گوید
            • مثال

              سینک(sync)
              آیسینک(async)

              حذف چت

              • متد : remove_chat
              • ورودی ها
              • فیلد نوع توضیحات
                object_guid str آبجکت گوید
              • مثال

                سینک(sync)
                آیسینک(async)

                گرفتن اطلاعات چت با نام کاربری

                • متد : get_chat_info_by_username
                • ورودی ها
                • فیلد نوع توضیحات
                  username str نام کاربری
                • مثال

                  سینک(sync)
                  آیسینک(async)