botapi

Use this method to specify a url and receive incoming updates via an outgoing webhook

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

Body Required

  • url string Required

    HTTPS url to send updates to. Use an empty string to remove webhook integration

  • certificate

    This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.

  • ip_address string

    The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

  • max_connections integer

    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.

    Default value is 40.

  • allowed_updates array[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 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.

  • drop_pending_updates boolean

    Pass True to drop all pending updates

Responses

  • default
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is false.

    • error_code integer Required
    • description string Required
    • parameters object

      Contains information about why a request was unsuccessful.

      Hide parameters attributes Show parameters attributes object
      • migrate_to_chat_id integer

        Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

      • retry_after integer

        Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
  • 200
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is true.

    • result boolean Required

      Default value is true.
POST /setWebhook 
curl \
 -X POST https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/setWebhook \
 -H "Content-Type: multipart/form-data" \
 -F "url=string" \
 -F "ip_address=string" \
 -F "max_connections=40" \
 -F "allowed_updates[]=string" \
 -F "drop_pending_updates=true"
Request example 
{
  "url": "string",
  "ip_address": "string",
  "max_connections": 40,
  "allowed_updates": [
    "string"
  ],
  "drop_pending_updates": true
}
Request examples 
{
  "url": "string",
  "ip_address": "string",
  "max_connections": 40,
  "allowed_updates": [
    "string"
  ],
  "drop_pending_updates": true
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (200) 
{
  "ok": true,
  "result": true
}
Response examples (200) 
{
  "ok": true,
  "result": true
}