sendPoll
متداز این متد برای ارسال نظرسنجی بومی (native poll) استفاده کنید. در صورت موفقیت، Message ارسال‌شده برگردانده می‌شود.
خروجی: Message
پارامترها
| نام | نوع | الزام | توضیحات |
|---|---|---|---|
| business_connection_id | String | اختیاری | شناسهٔ یکتای اتصال کسب‌وکاری که پیام از طرف آن فرستاده می‌شود. |
| chat_id | Integer or String | الزامی | شناسهٔ یکتای گفتگوی هدف یا نام‌کاربری ربات، ابرگروه یا کانال هدف با قالب @username. نظرسنجی را نمی‌توان به گفتگوهای پیام مستقیم کانال فرستاد. |
| message_thread_id | Integer | اختیاری | شناسهٔ یکتای رشتهٔ پیام (تاپیک) فروم هدف؛ فقط برای ابرگروه‌های فروم و گفتگوهای خصوصی ربات‌هایی که حالت تاپیک فروم برایشان فعال است. |
| question | String | الزامی | پرسش نظرسنجی؛ ۱ تا ۳۰۰ نویسه |
| question_parse_mode | String | اختیاری | حالت تجزیهٔ موجودیت‌ها در پرسش. جزئیات بیشتر را در گزینه‌های قالب‌بندی ببینید. در حال حاضر فقط موجودیت‌های custom emoji مجازند. |
| question_entities | Array of MessageEntity | اختیاری | فهرست JSON از موجودیت‌های ویژه‌ای که در پرسش نظرسنجی آمده‌اند. می‌توان آن را به‌جای question_parse_mode داد. |
| options | Array of InputPollOption | الزامی | فهرست JSON از ۱ تا ۱۲ گزینهٔ پاسخ |
| is_anonymous | Boolean | اختیاری | True اگر نظرسنجی باید ناشناس باشد؛ پیش‌فرض True |
| type | String | اختیاری | نوع نظرسنجی، «quiz» یا «regular»؛ پیش‌فرض «regular» |
| allows_multiple_answers | Boolean | اختیاری | اگر نظرسنجی اجازهٔ چند پاسخ را بدهد، True بدهید؛ پیش‌فرض False |
| allows_revoting | Boolean | اختیاری | اگر نظرسنجی اجازهٔ تغییر گزینه‌های انتخاب‌شده را بدهد، True بدهید؛ پیش‌فرض برای آزمون‌ها False و برای نظرسنجی‌های معمولی True |
| shuffle_options | Boolean | اختیاری | اگر گزینه‌های نظرسنجی باید به ترتیب تصادفی نمایش داده شوند، True بدهید. |
| allow_adding_options | Boolean | اختیاری | اگر بتوان پس از ساخت نظرسنجی گزینه به آن اضافه کرد، True بدهید؛ برای نظرسنجی‌های ناشناس و آزمون‌ها پشتیبانی نمی‌شود. |
| hide_results_until_closes | Boolean | اختیاری | اگر نتایج نظرسنجی باید فقط پس از بسته‌شدن آن نمایش داده شود، True بدهید. |
| members_only | Boolean | اختیاری | اگر رأی‌دادن محدود به کاربرانی است که بیش از ۲۴ ساعت عضو گفتگویی بوده‌اند که نظرسنجی در آن فرستاده می‌شود، True بدهید؛ فقط برای کانال‌ها |
| country_codes | Array of String | اختیاری | فهرست JSON از ۰ تا ۱۲ کد دوحرفی کشور بر پایهٔ ISO 3166-1 alpha-2 که کشورهایی را نشان می‌دهد که کاربرانشان می‌توانند در نظرسنجی رأی دهند؛ فقط برای کانال‌ها. برای اجازهٔ رأی به کاربران با شمارهٔ ناشناس، «FT» را به‌عنوان کد کشور بدهید. اگر ذکر نشود یا خالی باشد، کاربران از هر کشوری می‌توانند شرکت کنند. |
| correct_option_ids | Array of Integer | اختیاری | فهرست JSON از شناسه‌های (با شماره‌گذاری از ۰) گزینه‌های پاسخ درست که به‌طور یکنواخت صعودی‌اند؛ برای نظرسنجی‌های حالت آزمون الزامی است. |
| explanation | String | اختیاری | متنی که وقتی کاربر گزینهٔ نادرست را انتخاب می‌کند یا روی نماد لامپ در نظرسنجی آزمونی می‌زند نمایش داده می‌شود؛ ۰ تا ۲۰۰ نویسه با حداکثر ۲ خط‌جدید پس از تجزیهٔ موجودیت‌ها |
| explanation_parse_mode | String | اختیاری | حالت تجزیهٔ موجودیت‌ها در توضیح. جزئیات بیشتر را در گزینه‌های قالب‌بندی ببینید. |
| explanation_entities | Array of MessageEntity | اختیاری | فهرست JSON از موجودیت‌های ویژه‌ای که در توضیح نظرسنجی آمده‌اند. می‌توان آن را به‌جای explanation_parse_mode داد. |
| explanation_media | InputPollMedia | اختیاری | رسانهٔ اضافه‌شده به توضیح پاسخ آزمون |
| open_period | Integer | اختیاری | مدت زمانی (ثانیه) که نظرسنجی پس از ساخت فعال خواهد بود؛ ۵ تا ۲۶۲۸۰۰۰. همراه با close_date قابل استفاده نیست. |
| close_date | Integer | اختیاری | زمان (برچسب زمانی یونیکس) بسته‌شدن خودکار نظرسنجی. باید دست‌کم ۵ و حداکثر ۲۶۲۸۰۰۰ ثانیه در آینده باشد. همراه با open_period قابل استفاده نیست. |
| is_closed | Boolean | اختیاری | اگر نظرسنجی باید بلافاصله بسته شود، True بدهید. برای پیش‌نمایش نظرسنجی مفید است. |
| description | String | اختیاری | توضیح نظرسنجی که باید فرستاده شود؛ ۰ تا ۱۰۲۴ نویسه پس از تجزیهٔ موجودیت‌ها |
| description_parse_mode | String | اختیاری | حالت تجزیهٔ موجودیت‌ها در توضیح نظرسنجی. جزئیات بیشتر را در گزینه‌های قالب‌بندی ببینید. |
| description_entities | Array of MessageEntity | اختیاری | فهرست JSON از موجودیت‌های ویژه‌ای که در توضیح نظرسنجی آمده‌اند و می‌توان آن را به‌جای description_parse_mode داد. |
| media | InputPollMedia | اختیاری | رسانهٔ اضافه‌شده به توضیح نظرسنجی |
| disable_notification | Boolean | اختیاری | پیام را بی‌صدا می‌فرستد. کاربران اعلانی بدون صدا دریافت می‌کنند. |
| protect_content | Boolean | اختیاری | محتوای پیام ارسالی را از فوروارد و ذخیره‌شدن محافظت می‌کند. |
| allow_paid_broadcast | Boolean | اختیاری | برای مجاز شدن ارسال تا ۱۰۰۰ پیام در ثانیه و نادیده‌گرفتن محدودیت‌های ارسال انبوه، با هزینهٔ ۰٫۱ ستارهٔ تلگرام برای هر پیام، True بدهید. ستارهٔ مربوط از موجودی ربات کسر می‌شود. |
| message_effect_id | String | اختیاری | شناسهٔ یکتای افکتی که به پیام اضافه می‌شود؛ فقط برای گفتگوهای خصوصی |
| reply_parameters | ReplyParameters | اختیاری | توضیحات پیامی که به آن پاسخ داده می‌شود. |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | اختیاری | گزینه‌های اضافی رابط. شیء سریالایز‌شده به JSON برای کیبورد اینلاین، کیبورد پاسخ سفارشی، دستور حذف کیبورد پاسخ یا اجبار به پاسخ از طرف کاربر. |