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

Models

Update

این کلاس اطلاعات مربوط به یک Update دریافتی از API را نگهداری می‌کند.

فیلد نوع توضیحات
update_id int شناسه یکتای Update.
message_id int شناسه پیام.
date int زمان ارسال پیام به‌صورت Unix Timestamp.
text str متن پیام.
caption str کپشن رسانه.
author User اطلاعات فرستنده پیام.
chat Chat اطلاعات چت.
document Document اطلاعات فایل ارسال‌شده.
voice Voice اطلاعات پیام صوتی.
entities Entities Entityهای موجود در متن پیام.
caption_entities Entities Entityهای موجود در کپشن پیام.
reply_to_message ReplyMessage اطلاعات پیام ریپلای‌شده.
location Location اطلاعات موقعیت مکانی.
contact Contact اطلاعات مخاطب.
callback_query CallbackQuery اطلاعات Callback Query.
new_chat_member List[User] لیستی از اطلاعات کاربران جدید.
left_chat_member User اطلاعات کاربری که از چت خارج شده یا حذف شده است.
pre_checkout_query PreCheckoutQuery اطلاعات درخواست تأیید پرداخت.
forward_origin ForwardOrigin اطلاعات مبدأ پیام فورواردشده.
forward_from User اطلاعات فرستنده اصلی پیام فورواردشده.
forward_date int زمان فوروارد شدن پیام به‌صورت Unix Timestamp.
photo Photo اطلاعات تصاویر پیام.
animation Media اطلاعات فایل Animation.
video Media اطلاعات فایل ویدئویی.
sticker Sticker اطلاعات استیکر.
successful_payment SuccessfulPayment اطلاعات پرداخت موفق.
invoice Invoice اطلاعات Invoice.
sender_chat Chat اطلاعات چتی که پیام از طرف آن ارسال شده است.

User

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

فیلد نوع توضیحات
id int شناسه کاربر.
is_bot bool مشخص می‌کند کاربر ربات است یا خیر.
first_name str نام کاربر.
last_name str نام خانوادگی کاربر.
full_name str نام کامل کاربر.
username str نام کاربری (Username).

Chat

این کلاس اطلاعات مربوط به یک چت را نگهداری می‌کند.

فیلد نوع توضیحات
id int شناسه چت.
type str نوع چت.
username str نام کاربری چت.
first_name str نام چت یا کاربر.
last_name str نام خانوادگی چت یا کاربر.
full_name str نام کامل چت یا کاربر.
title str عنوان گروه یا کانال.

ReplyMessage

این کلاس اطلاعات پیامی را که Update فعلی در پاسخ به آن ارسال شده است، نگهداری می‌کند.

فیلد نوع توضیحات
message_id int شناسه پیام.
date int زمان ارسال پیام به‌صورت Unix Timestamp.
text str متن پیام.
caption str کپشن رسانه.
audio Audio اطلاعات فایل صوتی.
document Document اطلاعات فایل ارسال‌شده.
photo Photo اطلاعات تصاویر پیام.
voice Voice اطلاعات پیام صوتی.
video Media اطلاعات فایل ویدئویی.
sticker Sticker اطلاعات استیکر.
animation Media اطلاعات فایل Animation.
author User اطلاعات فرستنده پیام.
chat Chat اطلاعات چت.

Voice

این کلاس اطلاعات مربوط به یک پیام صوتی را نگهداری می‌کند.

فیلد نوع توضیحات
id str شناسه فایل صوتی.
unique_id str شناسه یکتای فایل صوتی.
duration int مدت زمان فایل صوتی بر حسب ثانیه.
mime_type str نوع MIME فایل صوتی.
size int حجم فایل بر حسب بایت.

Document

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

فیلد نوع توضیحات
id str شناسه فایل.
unique_id str شناسه یکتای فایل.
name str نام فایل.
mime_type str نوع MIME فایل.
size int حجم فایل بر حسب بایت.

Location

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

فیلد نوع توضیحات
latitude float عرض جغرافیایی.
longitude float طول جغرافیایی.

Contact

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

فیلد نوع توضیحات
phone_number str شماره تلفن مخاطب.
first_name str نام مخاطب.
last_name str نام خانوادگی مخاطب.
user_id int شناسه کاربر مرتبط با مخاطب.

CallbackQuery

این کلاس اطلاعات مربوط به Callback Query را نگهداری می‌کند.

فیلد نوع توضیحات
id str شناسه Callback Query.
data str داده ارسال‌شده توسط دکمه.
chat_instance str شناسه یکتای چت مربوط به Callback Query.
message CallbackMessage اطلاعات پیامی که دکمه آن فشرده شده است.
author User اطلاعات کاربری که Callback Query را ارسال کرده است.

CallbackMessage

این کلاس اطلاعات پیام مربوط به یک Callback Query را نگهداری می‌کند.

فیلد نوع توضیحات
message_id int شناسه پیام.
date int زمان ارسال پیام به‌صورت Unix Timestamp.
text str متن پیام.
author User اطلاعات فرستنده پیام.
chat Chat اطلاعات چت.

Button

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

پارامتر نوع توضیحات
text str متن دکمه. (اجباری)
request_contact bool در صورت True، با فشردن دکمه شماره تماس کاربر ارسال می‌شود. (اختیاری)
request_location bool در صورت True، با فشردن دکمه موقعیت مکانی کاربر ارسال می‌شود. (اختیاری)

KeypadRow

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

پارامتر نوع توضیحات
buttons List[Button \| str] لیست دکمه‌های موجود در این ردیف. (اجباری)

Keypad

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

پارامتر نوع توضیحات
rows List[KeypadRow] ردیف‌های کیبورد. (اجباری)
one_time bool در صورت True، کیبورد پس از یک بار استفاده مخفی می‌شود. (اختیاری)
resize bool در صورت True، اندازه کیبورد متناسب با تعداد دکمه‌ها تنظیم می‌شود. (اختیاری)

PreCheckoutQuery

این کلاس اطلاعات مربوط به درخواست تأیید پرداخت را نگهداری می‌کند.

فیلد نوع توضیحات
id str شناسه درخواست پرداخت.
currency str کد ارز پرداخت.
total_amount int مبلغ کل پرداخت.
invoice_payload str Payload مربوط به Invoice.
author User اطلاعات کاربری که پرداخت را انجام داده است.

Entity

این کلاس اطلاعات مربوط به یک Entity در متن پیام را نگهداری می‌کند.

فیلد نوع توضیحات
type str نوع Entity.
offset int محل شروع Entity در متن.
length int طول Entity.

Entities

این کلاس اطلاعات Entityهای موجود در یک پیام را نگهداری می‌کند.

فیلد نوع توضیحات
entities list[Entity] لیست Entityهای موجود در پیام.

ForwardOrigin

این کلاس اطلاعات مربوط به مبدأ اصلی یک پیام فورواردشده را نگهداری می‌کند.

فیلد نوع توضیحات
type str نوع مبدأ فوروارد.
date int زمان ارسال پیام اصلی به‌صورت Unix Timestamp.
sender_user User اطلاعات فرستنده اصلی پیام.

PhotoSize

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

فیلد نوع توضیحات
id str شناسه فایل تصویر.
unique_id str شناسه یکتای تصویر.
width int عرض تصویر بر حسب پیکسل.
height int ارتفاع تصویر بر حسب پیکسل.
size int حجم تصویر بر حسب بایت.

Photo

این کلاس اطلاعات تصاویر یک پیام را نگهداری می‌کند.

فیلد نوع توضیحات
photos list[PhotoSize] لیست اطلاعات تصاویر موجود در پیام.

Media

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

فیلد نوع توضیحات
id str شناسه فایل.
unique_id str شناسه یکتای فایل.
width int عرض رسانه بر حسب پیکسل.
height int ارتفاع رسانه بر حسب پیکسل.
duration int مدت زمان رسانه بر حسب ثانیه.
mime_type str نوع MIME فایل.
size int حجم فایل بر حسب بایت.
thumb Thumb اطلاعات تصویر پیش‌نمایش (Thumbnail) فایل.

Sticker

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

فیلد نوع توضیحات
id str شناسه فایل استیکر.
unique_id str شناسه یکتای استیکر.
type str نوع استیکر.
width int عرض استیکر بر حسب پیکسل.
height int ارتفاع استیکر بر حسب پیکسل.
is_animated bool مشخص می‌کند استیکر متحرک است یا خیر.
is_video bool مشخص می‌کند استیکر ویدیویی است یا خیر.
set_name str نام مجموعه استیکر.
size int حجم فایل استیکر بر حسب بایت.
thumb Thumb اطلاعات تصویر پیش‌نمایش (Thumbnail) استیکر.

Thumb

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

فیلد نوع توضیحات
id str شناسه فایل تصویر پیش‌نمایش.
unique_id str شناسه یکتای تصویر پیش‌نمایش.
width int عرض تصویر بر حسب پیکسل.
height int ارتفاع تصویر بر حسب پیکسل.
size int حجم تصویر بر حسب بایت.

SuccessfulPayment

این کلاس اطلاعات مربوط به یک پرداخت موفق را نگهداری می‌کند.

فیلد نوع توضیحات
currency str کد ارز پرداخت.
total_amount int مبلغ کل پرداخت.
invoice_payload str Payload مربوط به پرداخت.
telegram_payment_charge_id str شناسه پرداخت در تلگرام.
provider_payment_charge_id str شناسه پرداخت در درگاه پرداخت.

Invoice

این کلاس اطلاعات مربوط به یک Invoice را نگهداری می‌کند.

فیلد نوع توضیحات
title str عنوان Invoice.
description str توضیحات Invoice.
start_parameter str پارامتر شروع Invoice.
currency str کد ارز پرداخت.
total_amount int مبلغ کل Invoice.

CopyTextButton

این کلاس برای ایجاد دکمه‌ای استفاده می‌شود که با فشردن آن، متن مشخص‌شده در کلیپ‌بورد کاربر کپی می‌شود.

پارامتر نوع توضیحات
text str اجباری. متنی که با فشردن دکمه کپی می‌شود.

InlineButton

این کلاس برای ایجاد یک دکمه در کیبورد شیشه‌ای (Inline Keyboard) استفاده می‌شود.

پارامتر نوع توضیحات
text str اجباری. متن نمایش داده‌شده روی دکمه.
url str اختیاری. آدرسی که با فشردن دکمه باز می‌شود.
callback_data str اختیاری. داده‌ای که هنگام فشردن دکمه به Callback Query ارسال می‌شود.
copy_text CopyTextButton \| dict اختیاری. تنظیمات مربوط به دکمه کپی متن.
web_app Any اختیاری. اطلاعات مربوط به Web App.

InlineRow

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

پارامتر نوع توضیحات
buttons List[InlineButton] اجباری. لیست دکمه‌های موجود در این ردیف.

InlineKeypad

این کلاس کیبورد شیشه‌ای (Inline Keyboard) را نگهداری می‌کند.

پارامتر نوع توضیحات
rows List[InlineRow] اجباری. لیست ردیف‌های کیبورد شیشه‌ای.

LabeledPrice

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

پارامتر نوع توضیحات
label str اجباری. عنوان بخش هزینه.
amount int اجباری. مبلغ بخش هزینه به کوچک‌ترین واحد ارز.

ChatFullInfoPhoto

این کلاس اطلاعات تصاویر پروفایل چت را نگهداری می‌کند.

فیلد نوع توضیحات
small_id str شناسه تصویر کوچک پروفایل.
small_unique_id str شناسه یکتای تصویر کوچک پروفایل.
big_id str شناسه تصویر بزرگ پروفایل.
big_unique_id str شناسه یکتای تصویر بزرگ پروفایل.

ChatFullInfoSelfAcceptedGiftTypes

این کلاس انواع هدایای قابل دریافت توسط چت را مشخص می‌کند.

فیلد نوع توضیحات
unlimited_gifts bool امکان دریافت هدایای نامحدود.
limited_gifts bool امکان دریافت هدایای محدود.
unique_gifts bool امکان دریافت هدایای منحصربه‌فرد.
premium_subscription bool امکان دریافت هدیه اشتراک Premium.

InputMediaPhoto

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

پارامتر نوع توضیحات
media str اجباری. شناسه فایل، URL یا مسیر فایل محلی تصویر.
caption str اختیاری. کپشن تصویر.
is_local_file bool اختیاری. مشخص می‌کند مقدار media مسیر یک فایل محلی است یا خیر.

Audio

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

فیلد نوع توضیحات
id str شناسه فایل صوتی.
unique_id str شناسه یکتای فایل صوتی.
duration int مدت زمان فایل صوتی بر حسب ثانیه.
title str عنوان فایل صوتی.
name str نام فایل صوتی.
mime_type str نوع MIME فایل.
size int حجم فایل بر حسب بایت.

ChatFullInfo

این کلاس اطلاعات کامل یک چت را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست API.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
id int شناسه چت.
type str نوع چت.
title str عنوان چت.
username str نام کاربری چت.
accent_color_id int شناسه رنگ اصلی پروفایل چت.
max_reaction_count int حداکثر تعداد ری‌اکشن مجاز برای پیام‌ها.
photo ChatFullInfoPhoto اطلاعات تصویر پروفایل چت.
accepted_gift_types ChatFullInfoSelfAcceptedGiftTypes انواع هدایای قابل دریافت.
description str توضیحات چت.
invite_link str لینک دعوت چت.

File

این کلاس اطلاعات یک فایل را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست API.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
id str شناسه فایل.
unique_id str شناسه یکتای فایل.
size int حجم فایل بر حسب بایت.
path str مسیر فایل روی سرور.

GetMeResponse

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

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست API.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
id int شناسه ربات.
is_bot bool مشخص می‌کند حساب، ربات است یا خیر.
first_name str نام ربات.
last_name str نام خانوادگی ربات.
full_name str نام کامل ربات.
username str نام کاربری ربات.

MessageResponse

این کلاس اطلاعات پیام ارسال‌شده توسط متدهای ارسال پیام را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست API.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
message_id int شناسه پیام.
author User اطلاعات فرستنده پیام.
date int زمان ارسال پیام به‌صورت Unix Timestamp.
chat Chat اطلاعات چت.
text str متن پیام.
forward_date int زمان فوروارد شدن پیام.
invoice Invoice اطلاعات Invoice پیام.

ChatAdministrator

این کلاس اطلاعات مربوط به یک مدیر چت را نگهداری می‌کند.

فیلد نوع توضیحات
status str وضعیت کاربر در چت.
user User اطلاعات مدیر.
is_anonymous bool مشخص می‌کند مدیر به‌صورت ناشناس فعالیت می‌کند یا خیر.
can_be_edited bool مشخص می‌کند دسترسی‌های مدیر قابل ویرایش هستند یا خیر.
can_manage_chat bool امکان مدیریت چت.
can_delete_messages bool امکان حذف پیام‌ها.
can_manage_video_chats bool امکان مدیریت چت‌های تصویری.
can_restrict_members bool امکان محدود کردن اعضا.
can_promote_members bool امکان ارتقای اعضا به مدیر.
can_change_info bool امکان تغییر اطلاعات چت.
can_invite_users bool امکان دعوت کاربران.
can_pin_messages bool امکان سنجاق کردن پیام‌ها.
can_manage_topics bool امکان مدیریت موضوعات.

ChatAdministratorsResponse

این کلاس نتیجه متد get_chat_administrators را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست API.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
administrators List[ChatAdministrator] لیست مدیران چت.

ChatMember

این کلاس اطلاعات مربوط به یک عضو چت را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
status str وضعیت کاربر در چت.
user User اطلاعات کاربر.
is_anonymous bool مشخص می‌کند کاربر به‌صورت ناشناس فعالیت می‌کند یا خیر.

EditedMessage

این کلاس اطلاعات پیام ویرایش‌شده را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
message_id int شناسه پیام.
date int زمان ارسال پیام به‌صورت Unix Timestamp.
edit_date int زمان ویرایش پیام به‌صورت Unix Timestamp.
author User اطلاعات فرستنده پیام.
chat Chat اطلاعات چت.
reply_markup dict اطلاعات کیبورد متصل به پیام.

WebhookInfo

این کلاس اطلاعات Webhook ربات را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
url str آدرس Webhook تنظیم‌شده.
has_custom_certificate bool مشخص می‌کند از گواهی SSL سفارشی استفاده می‌شود یا خیر.
pending_update_count int تعداد Updateهای در انتظار ارسال.

SendMediaResult

این کلاس اطلاعات یک رسانه ارسال‌شده را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
message_id int شناسه پیام.
author User اطلاعات فرستنده پیام.
date int زمان ارسال پیام به‌صورت Unix Timestamp.
chat Chat اطلاعات چت.
photo Photo اطلاعات تصویر ارسال‌شده.
document Document اطلاعات فایل ارسال‌شده.
audio Audio اطلاعات فایل صوتی.
video Media اطلاعات فایل ویدئویی.
animation Media اطلاعات فایل انیمیشن.
voice Voice اطلاعات پیام صوتی.
media_group_id str شناسه گروه رسانه‌ای پیام.

SendMediaGroupResult

این کلاس نتیجه ارسال یک گروه رسانه‌ای را نگهداری می‌کند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.
messages list[SendMediaResult] لیست پیام‌های ارسال‌شده در گروه رسانه‌ای.

ApiResponse

این کلاس نتیجهٔ متدهایی را نگهداری می‌کند که دادهٔ خاصی برنمی‌گردانند و تنها وضعیت موفق یا ناموفق بودن درخواست، به‌همراه اطلاعات خطا (در صورت وجود) را ارائه می‌دهند.

فیلد نوع توضیحات
ok bool وضعیت موفق بودن درخواست.
error_code int کد خطا در صورت ناموفق بودن درخواست.
error_description str توضیح خطای بازگشتی از سرور.