version: 2.1.3







setWebhook

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, we 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/. Since nobody else knows your bot's token, you can be pretty sure it's us.

Parameters

url string HTTPS url to send updates to. Use an empty string to remove webhook integration Optional
certificate InputFile Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. Optional
ip_address string The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS Optional
max_connections int 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. Optional
allowed_updates Array of string 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 update types except chat_member (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. Optional
drop_pending_updates bool Pass True to drop all pending updates Optional
token String You can use this method on another bot with specify this parameter Optional
return_array Boolean Specify the result type , if pass true results will be array otherwise will be object Optional
forgot Boolean You can set to not receive request result, dont set it or pass null for turn it off Optional
answer Boolean You can set to answer to webhook, dont set it or pass null for turn it off Optional

Method errors

ErrorNamedescription
required parameters not found required parameter for this method is not founded. you can see them in log
answer mode not allowed you can use answer mode only once for each webhook update and you already did
answer mode not allowed bc multi you can't use answer mode when multi is on

Method examples

$this->setWebhook(['url' => string, 'certificate' => InputFile, 'ip_address' => string, 'max_connections' => int, 'allowed_updates' => Array of string, 'drop_pending_updates' => bool]);
$this->setWebhook();

Method alices

Method output :

bool