-
Notifications
You must be signed in to change notification settings - Fork 1
setWebhook
Eric Damian edited this page Feb 16, 2021
·
3 revisions
Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, telegram will give up after a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>
. Since nobody else knows your bot's token, you can be pretty sure it's telegram.
Parameter | Type | Required | Description |
---|---|---|---|
url | String | Yes | HTTPS url to send updates to. Use an empty string to remove webhook integration. |
ip_address | String | Optional | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS. |
max_connections | Integer | Optional | Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. |
allowed_updates | Array of String | Optional | A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. |
- You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
- Ports currently supported for Webhooks: 443, 80, 88, 8443.
from python_telegram_api import telegram_bot_api
bot = telegram_bot_api.TelegramBotApi('xxxxxxxxxx:yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy')
print(bot.setWebhook('https://d846cca677ee.ngrok.io'))
>>> True