MessageEntity

نوع داده

این شیء یک موجودیت ویژه (entity) در پیام متنی را نشان می‌دهد؛ مثلاً هشتگ، نام‌کاربری، آدرس و غیره.

فیلدها

نامنوعتوضیحات
typeStringنوع موجودیت. در حال حاضر می‌تواند یکی از این‌ها باشد: «mention» (‏@username)، «hashtag» (‏#hashtag یا #hashtag@chatusername)، «cashtag» (‏$USD یا $USD@chatusername)، «bot_command» (‏/start@jobs_bot)، «url» (‏https://telegram.org)، «email» (‏do-not-reply@telegram.org)، «phone_number» (‏+1-212-555-0123)، «bold» (متن پررنگ)، «italic» (متن مورب)، «underline» (متن زیرخط‌دار)، «strikethrough» (متن خط‌خورده)، «spoiler» (پیام اسپویلر)، «blockquote» (نقل‌قول بلوکی)، «expandable_blockquote» (نقل‌قول بلوکی که پیش‌فرض بسته است)، «code» (رشتهٔ تک‌فاصله)، «pre» (بلوک تک‌فاصله)، «text_link» (برای آدرس‌های قابل‌کلیک در متن)، «text_mention» (برای کاربران بدون نام‌کاربری)، «custom_emoji» (برای استیکرهای ایموجی سفارشی درون‌خطی) یا «date_time» (برای تاریخ و ساعت قالب‌بندی‌شده).
offsetIntegerفاصلهٔ شروع موجودیت از ابتدای متن، بر حسب واحد کد UTF-16
lengthIntegerطول موجودیت بر حسب واحد کد UTF-16
urlStringاختیاری. فقط برای «text_link»؛ آدرسی که با ضربه روی متن باز می‌شود.
userUserاختیاری. فقط برای «text_mention»؛ کاربر منشن‌شده
languageStringاختیاری. فقط برای «pre»؛ زبان برنامه‌نویسی متن موجودیت
custom_emoji_idStringاختیاری. فقط برای «custom_emoji»؛ شناسهٔ یکتای ایموجی سفارشی. برای اطلاعات کامل استیکر از getCustomEmojiStickers استفاده کنید.
unix_timeIntegerاختیاری. فقط برای «date_time»؛ زمان یونیکس مرتبط با موجودیت
date_time_formatStringاختیاری. فقط برای «date_time»؛ رشته‌ای که قالب نمایش تاریخ و ساعت را تعیین می‌کند. جزئیات بیشتر را در قالب‌بندی موجودیت تاریخ و ساعت ببینید.
MessageEntity — نوع داده (API تلگرام) | ایران ناتیفیکیشن