Poll
نوع دادهاین شیء اطلاعات یک نظرسنجی را شامل می‌شود.
فیلدها
| نام | نوع | توضیحات |
|---|---|---|
| id | String | شناسهٔ یکتای نظرسنجی |
| question | String | پرسش نظرسنجی؛ ۱ تا ۳۰۰ نویسه |
| question_entities | Array of MessageEntity | اختیاری. موجودیت‌های ویژه‌ای که در پرسش آمده‌اند. در حال حاضر در پرسش نظرسنجی‌ها فقط موجودیت‌های custom emoji مجازند. |
| options | Array of PollOption | فهرست گزینه‌های نظرسنجی |
| total_voter_count | Integer | تعداد کل کاربرانی که در نظرسنجی رأی داده‌اند. |
| is_closed | Boolean | True اگر نظرسنجی بسته شده باشد. |
| is_anonymous | Boolean | True اگر نظرسنجی ناشناس باشد. |
| type | String | نوع نظرسنجی؛ در حال حاضر می‌تواند «regular» یا «quiz» باشد. |
| allows_multiple_answers | Boolean | True اگر نظرسنجی اجازهٔ چند پاسخ را بدهد. |
| allows_revoting | Boolean | True اگر نظرسنجی اجازهٔ تغییر گزینه‌های انتخاب‌شده را بدهد. |
| members_only | Boolean | True اگر رأی‌دادن محدود به کاربرانی باشد که بیش از ۲۴ ساعت عضو گفتگویی بوده‌اند که نظرسنجی در اصل در آن فرستاده شده است. |
| country_codes | Array of String | اختیاری. فهرستی از کدهای دوحرفی کشور بر پایهٔ ISO 3166-1 alpha-2 که کشورهایی را نشان می‌دهد که کاربرانشان می‌توانند در نظرسنجی رأی دهند. کد کشور «FT» برای کاربران با شمارهٔ ناشناس استفاده می‌شود. اگر ذکر نشود، کاربران از هر کشوری می‌توانند شرکت کنند. |
| correct_option_ids | Array of Integer | اختیاری. آرایه‌ای از شناسه‌های گزینه‌های پاسخ درست (با شماره‌گذاری از ۰). فقط برای نظرسنجی‌های حالت آزمون (quiz) که بسته شده‌اند یا توسط خود ربات (نه فورواردشده) یا در گفتگوی خصوصی با ربات فرستاده شده‌اند، در دسترس است. |
| explanation | String | اختیاری. متنی که وقتی کاربر گزینهٔ نادرست را انتخاب می‌کند یا روی نماد لامپ در نظرسنجی آزمونی می‌زند نمایش داده می‌شود؛ ۰ تا ۲۰۰ نویسه |
| explanation_entities | Array of MessageEntity | اختیاری. موجودیت‌های ویژه مانند نام‌های کاربری، آدرس‌ها، دستورهای ربات و غیره که در توضیح آمده‌اند. |
| explanation_media | PollMedia | اختیاری. رسانهٔ اضافه‌شده به توضیح پاسخ آزمون |
| open_period | Integer | اختیاری. مدت زمانی (ثانیه) که نظرسنجی پس از ساخت فعال خواهد بود. |
| close_date | Integer | اختیاری. زمان (برچسب زمانی یونیکس) بسته‌شدن خودکار نظرسنجی |
| description | String | اختیاری. توضیح نظرسنجی؛ فقط برای نظرسنجی‌های داخل شیء Message |
| description_entities | Array of MessageEntity | اختیاری. موجودیت‌های ویژه مانند نام‌های کاربری، آدرس‌ها، دستورهای ربات و غیره که در توضیح آمده‌اند. |
| media | PollMedia | اختیاری. رسانهٔ اضافه‌شده به توضیح نظرسنجی؛ فقط برای نظرسنجی‌های داخل شیء Message |