setWebhook
متداز این متد برای تعیین یک URL و دریافت آپدیت‌ها از طریق وب‌هوک خروجی استفاده کنید. هرگاه برای ربات آپدیتی باشد، یک درخواست HTTPS POST با یک Update سریالایز‌شده به JSON به آدرس مشخص‌شده می‌فرستیم. اگر درخواست ناموفق باشد (پاسخ با کد وضعیت HTTP غیر از 2XX)، درخواست را تکرار می‌کنیم و پس از تعداد معقولی تلاش، صرف‌نظر می‌کنیم. در صورت موفقیت True برمی‌گرداند.
اگر می‌خواهید مطمئن شوید وب‌هوک را خودتان تنظیم کرده‌اید، می‌توانید داده‌ای محرمانه را در پارامتر secret_token بدهید. در این صورت درخواست‌ها هدری به نام «X-Telegram-Bot-Api-Secret-Token» با مقدار همان توکن محرمانه خواهند داشت.
خروجی: Boolean
پارامترها
| نام | نوع | الزام | توضیحات |
|---|---|---|---|
| url | String | الزامی | آدرس HTTPS که آپدیت‌ها به آن ارسال می‌شود. برای حذف وب‌هوک، رشتهٔ خالی بدهید. |
| certificate | InputFile | اختیاری | گواهی کلید عمومی خود را آپلود کنید تا گواهی ریشهٔ مورد استفاده بررسی شود. برای جزئیات، راهنمای گواهی خودامضا را ببینید. |
| ip_address | String | اختیاری | آدرس IP ثابتی که به‌جای IP حاصل از DNS برای ارسال درخواست‌های وب‌هوک استفاده می‌شود. |
| max_connections | Integer | اختیاری | بیشینهٔ تعداد اتصال HTTPS هم‌زمان به وب‌هوک برای تحویل آپدیت‌ها، بین ۱ تا ۱۰۰. پیش‌فرض ۴۰ است. برای کم‌کردن بار روی سرور ربات مقدار کمتر و برای افزایش توان عملیاتی ربات مقدار بیشتر بدهید. |
| allowed_updates | Array of String | اختیاری | فهرست JSON از انواع آپدیتی که می‌خواهید ربات دریافت کند. مثلاً ["message", "edited_channel_post", "callback_query"] را بدهید تا فقط همین انواع را بگیرید. فهرست کامل انواع آپدیت را در Update ببینید. فهرست خالی یعنی همهٔ انواع آپدیت به‌جز chat_member، message_reaction و message_reaction_count (پیش‌فرض). اگر مشخص نشود، تنظیم قبلی استفاده می‌شود. توجه کنید این پارامتر روی آپدیت‌هایی که پیش از فراخوانی setWebhook ساخته شده‌اند اثر ندارد، بنابراین ممکن است برای مدت کوتاهی آپدیت‌های ناخواسته دریافت شود. |
| drop_pending_updates | Boolean | اختیاری | برای دور انداختن همهٔ آپدیت‌های در انتظار، True بدهید. |
| secret_token | String | اختیاری | توکن محرمانه‌ای که در هدر «X-Telegram-Bot-Api-Secret-Token» هر درخواست وب‌هوک فرستاده می‌شود؛ ۱ تا ۲۵۶ نویسه. فقط نویسه‌های A-Z، a-z، 0-9، _ و - مجازند. این هدر برای اطمینان از اینکه درخواست از وب‌هوکِ تنظیم‌شده توسط خودتان آمده مفید است. |