Message
نوع دادهزیرنوعی از MaybeInaccessibleMessage
این شیء یک پیام را نشان می‌دهد.
فیلدها
| نام | نوع | توضیحات |
|---|---|---|
| message_id | Integer | شناسهٔ یکتای پیام در این گفتگو؛ برای پیام‌های موقت (ephemeral) برابر ۰. در موارد خاص (مثلاً پیامی حاوی ویدیو که به یک گفتگوی بزرگ فرستاده می‌شود) ممکن است سرور به‌جای ارسال فوری، پیام را زمان‌بندی کند. در این حالت این فیلد ۰ است و پیام تا زمانی که واقعاً ارسال شود قابل استفاده نیست. |
| message_thread_id | Integer | اختیاری. شناسهٔ یکتای رشتهٔ پیام (message thread) یا تاپیک فرومی که پیام به آن تعلق دارد؛ فقط برای ابرگروه‌ها و گفتگوهای خصوصی |
| direct_messages_topic | DirectMessagesTopic | اختیاری. اطلاعات تاپیک گفتگوی پیام مستقیم که پیام در آن قرار دارد. |
| from | User | اختیاری. فرستندهٔ پیام؛ برای پیام‌هایی که به کانال‌ها فرستاده شده ممکن است خالی باشد. برای سازگاری با نسخه‌های قبل، اگر پیام از طرف یک گفتگو فرستاده شده باشد، در گفتگوهای غیرکانال این فیلد یک کاربر فرستندهٔ ساختگی دارد. |
| sender_chat | Chat | اختیاری. فرستندهٔ پیام وقتی از طرف یک گفتگو فرستاده شده است؛ مثلاً خود ابرگروه برای پیام‌های ادمین‌های ناشناس آن، یا کانال متصل برای پیام‌هایی که خودکار به گروه بحث کانال فوروارد می‌شوند. برای سازگاری با نسخه‌های قبل، اگر پیام از طرف یک گفتگو فرستاده شده باشد، فیلد from در گفتگوهای غیرکانال یک کاربر فرستندهٔ ساختگی دارد. |
| sender_boost_count | Integer | اختیاری. اگر فرستندهٔ پیام گفتگو را بوست کرده باشد، تعداد بوست‌هایی که این کاربر اضافه کرده است. |
| sender_business_bot | User | اختیاری. رباتی که پیام را واقعاً از طرف حساب کسب‌وکار فرستاده است. فقط برای پیام‌های خروجی که از طرف حساب کسب‌وکار متصل فرستاده شده‌اند در دسترس است. |
| sender_tag | String | اختیاری. برچسب (tag) یا عنوان سفارشی فرستندهٔ پیام؛ فقط برای ابرگروه‌ها |
| receiver_user | User | اختیاری. برای پیام‌های موقت (ephemeral)، کاربری که پیام را دریافت کرده است. |
| ephemeral_message_id | Integer | اختیاری. برای پیام‌های موقت، شناسهٔ پیام موقت در این گفتگو. پس از حذف یا انقضای پیام، ممکن است این شناسه برای پیام موقت دیگری دوباره استفاده شود. |
| date | Integer | تاریخ ارسال پیام به زمان یونیکس. همیشه عددی مثبت است و یک تاریخ معتبر را نشان می‌دهد. |
| guest_query_id | String | اختیاری. شناسهٔ یکتای guest query. برای ارسال پیام پاسخ، این شناسه را با متد answerGuestQuery استفاده کنید. اگر خالی نباشد، پیام متعلق به گفتگویی است که ربات مهمان در آن فراخوانده شده و ممکن است با گفتگوهای دیگر ربات که شناسهٔ یکسانی دارند یکی نباشد. |
| business_connection_id | String | اختیاری. شناسهٔ یکتای اتصال کسب‌وکاری که پیام از آن دریافت شده است. اگر خالی نباشد، پیام متعلق به گفتگوی حساب کسب‌وکار مربوطه است و از هر گفتگوی احتمالی ربات که شناسهٔ یکسانی دارد مستقل است. |
| chat | Chat | گفتگویی که پیام به آن تعلق دارد. |
| forward_origin | MessageOrigin | اختیاری. اطلاعات پیام اصلی برای پیام‌های فورواردشده |
| is_topic_message | Boolean | اختیاری. True اگر پیام به یک تاپیک در ابرگروه فروم یا گفتگوی خصوصی با ربات فرستاده شده باشد. |
| is_automatic_forward | Boolean | اختیاری. True اگر پیام، پست کانالی باشد که خودکار به گروه بحث متصل فوروارد شده است. |
| reply_to_message | Message | اختیاری. برای پاسخ‌ها در همان گفتگو و رشتهٔ پیام، پیام اصلی. توجه کنید شیء Message در این فیلد، حتی اگر خودش پاسخ باشد، فیلدهای reply_to_message بیشتری نخواهد داشت. اگر پیام پاسخ به یک پیام موقت باشد، ممکن است این فیلد ذکر نشود. |
| external_reply | ExternalReplyInfo | اختیاری. اطلاعات پیامی که به آن پاسخ داده شده و ممکن است از گفتگو یا تاپیک دیگری باشد. |
| quote | TextQuote | اختیاری. برای پاسخ‌هایی که بخشی از پیام اصلی را نقل‌قول می‌کنند، بخش نقل‌شده از پیام |
| reply_to_story | Story | اختیاری. برای پاسخ به یک استوری، استوری اصلی |
| reply_to_checklist_task_id | Integer | اختیاری. شناسهٔ وظیفهٔ مشخص چک‌لیستی که به آن پاسخ داده شده است. |
| reply_to_poll_option_id | String | اختیاری. شناسهٔ پایدار گزینهٔ مشخص نظرسنجی که به آن پاسخ داده شده است. |
| via_bot | User | اختیاری. رباتی که پیام از طریق آن فرستاده شده است. |
| guest_bot_caller_user | User | اختیاری. برای پیامی که ربات مهمان فرستاده، کاربری که پیام اصلی‌اش باعث پاسخ ربات شده است. |
| guest_bot_caller_chat | Chat | اختیاری. برای پیامی که ربات مهمان فرستاده، گفتگویی که پیام اصلی‌اش باعث پاسخ ربات شده است. |
| edit_date | Integer | اختیاری. تاریخ آخرین ویرایش پیام به زمان یونیکس |
| has_protected_content | Boolean | اختیاری. True اگر پیام را نتوان فوروارد کرد. |
| is_from_offline | Boolean | اختیاری. True اگر پیام با یک کنش ضمنی فرستاده شده باشد؛ مثلاً به‌عنوان پیام «غیبت» یا «خوش‌آمدگویی» کسب‌وکار، یا به‌عنوان پیام زمان‌بندی‌شده. |
| is_paid_post | Boolean | اختیاری. True اگر پیام یک پست پولی باشد. توجه کنید چنین پست‌هایی برای دریافت پرداخت نباید تا ۲۴ ساعت حذف شوند و قابل ویرایش نیستند. |
| media_group_id | String | اختیاری. شناسهٔ یکتای گروه پیام‌های رسانه‌ای (media group) که این پیام به آن تعلق دارد، در این گفتگو |
| author_signature | String | اختیاری. امضای نویسندهٔ پست برای پیام‌های کانال‌ها، یا عنوان سفارشی ادمین ناشناس گروه |
| paid_star_count | Integer | اختیاری. تعداد ستارهٔ تلگرام که فرستندهٔ پیام برای ارسال آن پرداخته است. |
| text | String | اختیاری. برای پیام‌های متنی، متن واقعی پیام به UTF-8 |
| entities | Array of MessageEntity | اختیاری. برای پیام‌های متنی، موجودیت‌های ویژه (entities) مانند نام‌های کاربری، آدرس‌ها، دستورهای ربات و غیره که در متن آمده‌اند. |
| link_preview_options | LinkPreviewOptions | اختیاری. گزینه‌های تولید پیش‌نمایش لینک برای پیام، اگر پیام متنی باشد و گزینه‌های پیش‌نمایش لینک تغییر کرده باشند. |
| suggested_post_info | SuggestedPostInfo | اختیاری. اطلاعات پارامترهای پست پیشنهادی، اگر پیام یک پست پیشنهادی در گفتگوی پیام‌های مستقیم کانال باشد. اگر پیام یک پست پیشنهادیِ تأییدشده یا ردشده باشد، قابل ویرایش نیست. |
| effect_id | String | اختیاری. شناسهٔ یکتای افکت پیامی که به پیام اضافه شده است. |
| rich_message | RichMessage | اختیاری. پیام یک پیام با قالب‌بندی غنی (rich) است. |
| animation | Animation | اختیاری. پیام یک انیمیشن است؛ اطلاعات انیمیشن. برای سازگاری با نسخه‌های قبل، وقتی این فیلد مقدار دارد فیلد document هم مقدار می‌گیرد. |
| audio | Audio | اختیاری. پیام یک فایل صوتی است؛ اطلاعات فایل |
| document | Document | اختیاری. پیام یک فایل عمومی است؛ اطلاعات فایل |
| live_photo | LivePhoto | اختیاری. پیام یک عکس زنده (live photo) است؛ اطلاعات آن. برای سازگاری با نسخه‌های قبل، وقتی این فیلد مقدار دارد فیلد photo هم مقدار می‌گیرد. |
| paid_media | PaidMediaInfo | اختیاری. پیام حاوی رسانهٔ پولی است؛ اطلاعات رسانهٔ پولی |
| photo | Array of PhotoSize | اختیاری. پیام یک عکس است؛ اندازه‌های موجود عکس |
| sticker | Sticker | اختیاری. پیام یک استیکر است؛ اطلاعات استیکر |
| story | Story | اختیاری. پیام یک استوری فورواردشده است. |
| video | Video | اختیاری. پیام یک ویدیو است؛ اطلاعات ویدیو |
| video_note | VideoNote | اختیاری. پیام یک ویدیو نوت (پیام ویدیویی گرد) است؛ اطلاعات پیام ویدیویی |
| voice | Voice | اختیاری. پیام یک پیام صوتی (voice) است؛ اطلاعات فایل |
| caption | String | اختیاری. عنوان (caption) برای انیمیشن، صوت، سند، رسانهٔ پولی، عکس، ویدیو یا پیام صوتی |
| caption_entities | Array of MessageEntity | اختیاری. برای پیام‌های دارای عنوان، موجودیت‌های ویژه (entities) مانند نام‌های کاربری، آدرس‌ها، دستورهای ربات و غیره که در عنوان آمده‌اند. |
| show_caption_above_media | Boolean | اختیاری. True اگر عنوان باید بالای رسانهٔ پیام نمایش داده شود. |
| has_media_spoiler | Boolean | اختیاری. True اگر رسانهٔ پیام با انیمیشن اسپویلر پوشانده شده باشد. |
| checklist | Checklist | اختیاری. پیام یک چک‌لیست است. |
| contact | Contact | اختیاری. پیام یک مخاطب اشتراکی است؛ اطلاعات مخاطب |
| dice | Dice | اختیاری. پیام یک تاس با مقدار تصادفی است. |
| game | Game | اختیاری. پیام یک بازی است؛ اطلاعات بازی. دربارهٔ بازی‌ها بیشتر بخوانید: https://core.telegram.org/bots/api#games |
| poll | Poll | اختیاری. پیام یک نظرسنجی بومی (native poll) است؛ اطلاعات نظرسنجی |
| venue | Venue | اختیاری. پیام یک مکان (venue) است؛ اطلاعات مکان. برای سازگاری با نسخه‌های قبل، وقتی این فیلد مقدار دارد فیلد location هم مقدار می‌گیرد. |
| location | Location | اختیاری. پیام یک موقعیت مکانی اشتراکی است؛ اطلاعات موقعیت |
| new_chat_members | Array of User | اختیاری. اعضای جدیدی که به گروه یا ابرگروه اضافه شده‌اند و اطلاعات آن‌ها (ممکن است خود ربات یکی از آن‌ها باشد) |
| left_chat_member | User | اختیاری. عضوی از گروه حذف شده است؛ اطلاعات او (ممکن است خود ربات باشد) |
| chat_owner_left | ChatOwnerLeft | اختیاری. پیام سرویسی: مالک گفتگو آن را ترک کرد. |
| chat_owner_changed | ChatOwnerChanged | اختیاری. پیام سرویسی: مالک گفتگو تغییر کرد. |
| new_chat_title | String | اختیاری. عنوان گفتگو به این مقدار تغییر کرد. |
| new_chat_photo | Array of PhotoSize | اختیاری. عکس گفتگو به این مقدار تغییر کرد. |
| delete_chat_photo | Boolean | اختیاری. پیام سرویسی: عکس گفتگو حذف شد. |
| group_chat_created | Boolean | اختیاری. پیام سرویسی: گروه ساخته شد. |
| supergroup_chat_created | Boolean | اختیاری. پیام سرویسی: ابرگروه ساخته شد. این فیلد در پیامی که از طریق آپدیت‌ها می‌رسد قابل دریافت نیست، چون ربات هنگام ساخت ابرگروه نمی‌تواند عضو آن باشد. فقط اگر کسی به اولین پیام یک ابرگروهِ مستقیماً ساخته‌شده پاسخ دهد، در reply_to_message پیدا می‌شود. |
| channel_chat_created | Boolean | اختیاری. پیام سرویسی: کانال ساخته شد. این فیلد در پیامی که از طریق آپدیت‌ها می‌رسد قابل دریافت نیست، چون ربات هنگام ساخت کانال نمی‌تواند عضو آن باشد. فقط اگر کسی به اولین پیام یک کانال پاسخ دهد، در reply_to_message پیدا می‌شود. |
| message_auto_delete_timer_changed | MessageAutoDeleteTimerChanged | اختیاری. پیام سرویسی: تنظیمات تایمر حذف خودکار گفتگو تغییر کرد. |
| migrate_to_chat_id | Integer | اختیاری. گروه به ابرگروهی با شناسهٔ مشخص‌شده منتقل شده است. این عدد ممکن است بیش از ۳۲ بیت معنادار داشته باشد و بعضی زبان‌های برنامه‌نویسی در تفسیر آن دچار مشکل یا خطای بی‌صدا شوند؛ اما حداکثر ۵۲ بیت معنادار دارد، بنابراین عدد صحیح ۶۴ بیتی علامت‌دار یا اعشاری با دقت دوگانه برای نگهداری آن امن است. |
| migrate_from_chat_id | Integer | اختیاری. ابرگروه از گروهی با شناسهٔ مشخص‌شده منتقل شده است. این عدد ممکن است بیش از ۳۲ بیت معنادار داشته باشد و بعضی زبان‌های برنامه‌نویسی در تفسیر آن دچار مشکل یا خطای بی‌صدا شوند؛ اما حداکثر ۵۲ بیت معنادار دارد، بنابراین عدد صحیح ۶۴ بیتی علامت‌دار یا اعشاری با دقت دوگانه برای نگهداری آن امن است. |
| pinned_message | MaybeInaccessibleMessage | اختیاری. پیام مشخص‌شده سنجاق شد. توجه کنید شیء Message در این فیلد، حتی اگر خودش پاسخ باشد، فیلدهای reply_to_message بیشتری نخواهد داشت. |
| invoice | Invoice | اختیاری. پیام یک صورتحساب پرداخت است؛ اطلاعات صورتحساب. دربارهٔ پرداخت‌ها بیشتر بخوانید: https://core.telegram.org/bots/api#payments |
| successful_payment | SuccessfulPayment | اختیاری. پیام یک پیام سرویسی دربارهٔ پرداخت موفق است؛ اطلاعات پرداخت. دربارهٔ پرداخت‌ها بیشتر بخوانید: https://core.telegram.org/bots/api#payments |
| refunded_payment | RefundedPayment | اختیاری. پیام یک پیام سرویسی دربارهٔ پرداخت بازپرداخت‌شده است؛ اطلاعات پرداخت. دربارهٔ پرداخت‌ها بیشتر بخوانید: https://core.telegram.org/bots/api#payments |
| users_shared | UsersShared | اختیاری. پیام سرویسی: کاربران با ربات به اشتراک گذاشته شدند. |
| chat_shared | ChatShared | اختیاری. پیام سرویسی: یک گفتگو با ربات به اشتراک گذاشته شد. |
| gift | GiftInfo | اختیاری. پیام سرویسی: یک هدیهٔ معمولی فرستاده یا دریافت شد. |
| unique_gift | UniqueGiftInfo | اختیاری. پیام سرویسی: یک هدیهٔ یکتا فرستاده یا دریافت شد. |
| gift_upgrade_sent | GiftInfo | اختیاری. پیام سرویسی: ارتقای هدیه پس از ارسال آن خریداری شد. |
| connected_website | String | اختیاری. نام دامنهٔ وب‌سایتی که کاربر در آن وارد شده است. دربارهٔ ورود با تلگرام بیشتر بخوانید: https://core.telegram.org/widgets/login |
| write_access_allowed | WriteAccessAllowed | اختیاری. پیام سرویسی: کاربر پس از افزودن ربات به منوی پیوست یا منوی کناری، اجرای یک Web App از طریق لینک، یا پذیرفتن درخواست صریح Web App که با متد requestWriteAccess فرستاده شده، به ربات اجازهٔ نوشتن پیام داد. |
| passport_data | PassportData | اختیاری. داده‌های پاسپورت تلگرام |
| proximity_alert_triggered | ProximityAlertTriggered | اختیاری. پیام سرویسی: کاربری در گفتگو هنگام اشتراک موقعیت زنده (Live Location)، هشدار مجاورت کاربر دیگری را فعال کرد. |
| boost_added | ChatBoostAdded | اختیاری. پیام سرویسی: کاربر گفتگو را بوست کرد. |
| chat_background_set | ChatBackground | اختیاری. پیام سرویسی: پس‌زمینهٔ گفتگو تنظیم شد. |
| checklist_tasks_done | ChecklistTasksDone | اختیاری. پیام سرویسی: برخی وظایف یک چک‌لیست انجام‌شده یا انجام‌نشده علامت خوردند. |
| checklist_tasks_added | ChecklistTasksAdded | اختیاری. پیام سرویسی: وظایفی به یک چک‌لیست اضافه شد. |
| community_chat_added | CommunityChatAdded | اختیاری. پیام سرویسی: گفتگو یا ربات به یک جامعه (Community) اضافه شد. |
| community_chat_joined | CommunityChatJoined | اختیاری. پیام سرویسی: کاربری از یک جامعه (Community) به گفتگو پیوست. |
| community_chat_removed | CommunityChatRemoved | اختیاری. پیام سرویسی: گفتگو یا ربات از یک جامعه (Community) حذف شد. |
| direct_message_price_changed | DirectMessagePriceChanged | اختیاری. پیام سرویسی: قیمت پیام‌های پولی در گفتگوی پیام مستقیم متناظر یک کانال تغییر کرد. |
| forum_topic_created | ForumTopicCreated | اختیاری. پیام سرویسی: تاپیک فروم ساخته شد. |
| forum_topic_edited | ForumTopicEdited | اختیاری. پیام سرویسی: تاپیک فروم ویرایش شد. |
| forum_topic_closed | ForumTopicClosed | اختیاری. پیام سرویسی: تاپیک فروم بسته شد. |
| forum_topic_reopened | ForumTopicReopened | اختیاری. پیام سرویسی: تاپیک فروم دوباره باز شد. |
| general_forum_topic_hidden | GeneralForumTopicHidden | اختیاری. پیام سرویسی: تاپیک «General» فروم پنهان شد. |
| general_forum_topic_unhidden | GeneralForumTopicUnhidden | اختیاری. پیام سرویسی: تاپیک «General» فروم دوباره نمایان شد. |
| giveaway_created | GiveawayCreated | اختیاری. پیام سرویسی: یک قرعه‌کشی (giveaway) زمان‌بندی‌شده ساخته شد. |
| giveaway | Giveaway | اختیاری. پیام یک قرعه‌کشی زمان‌بندی‌شده است. |
| giveaway_winners | GiveawayWinners | اختیاری. قرعه‌کشی‌ای با برندگان عمومی به پایان رسید. |
| giveaway_completed | GiveawayCompleted | اختیاری. پیام سرویسی: قرعه‌کشی‌ای بدون برندگان عمومی به پایان رسید. |
| managed_bot_created | ManagedBotCreated | اختیاری. پیام سرویسی: کاربر رباتی ساخت که توسط ربات فعلی مدیریت می‌شود. |
| paid_message_price_changed | PaidMessagePriceChanged | اختیاری. پیام سرویسی: قیمت پیام‌های پولی در گفتگو تغییر کرد. |
| poll_option_added | PollOptionAdded | اختیاری. پیام سرویسی: گزینهٔ پاسخ به یک نظرسنجی اضافه شد. |
| poll_option_deleted | PollOptionDeleted | اختیاری. پیام سرویسی: گزینهٔ پاسخ از یک نظرسنجی حذف شد. |
| suggested_post_approved | SuggestedPostApproved | اختیاری. پیام سرویسی: یک پست پیشنهادی تأیید شد. |
| suggested_post_approval_failed | SuggestedPostApprovalFailed | اختیاری. پیام سرویسی: تأیید یک پست پیشنهادی ناموفق بود. |
| suggested_post_declined | SuggestedPostDeclined | اختیاری. پیام سرویسی: یک پست پیشنهادی رد شد. |
| suggested_post_paid | SuggestedPostPaid | اختیاری. پیام سرویسی: پرداخت یک پست پیشنهادی دریافت شد. |
| suggested_post_refunded | SuggestedPostRefunded | اختیاری. پیام سرویسی: پرداخت یک پست پیشنهادی بازپرداخت شد. |
| video_chat_scheduled | VideoChatScheduled | اختیاری. پیام سرویسی: چت ویدیویی زمان‌بندی شد. |
| video_chat_started | VideoChatStarted | اختیاری. پیام سرویسی: چت ویدیویی شروع شد. |
| video_chat_ended | VideoChatEnded | اختیاری. پیام سرویسی: چت ویدیویی پایان یافت. |
| video_chat_participants_invited | VideoChatParticipantsInvited | اختیاری. پیام سرویسی: شرکت‌کنندگان جدیدی به چت ویدیویی دعوت شدند. |
| web_app_data | WebAppData | اختیاری. پیام سرویسی: داده‌ای که یک Web App فرستاده است. |
| reply_markup | InlineKeyboardMarkup | اختیاری. کیبورد اینلاین ضمیمه‌شده به پیام. دکمه‌های login_url مانند دکمه‌های url معمولی نمایش داده می‌شوند. |