GramIO API Reference / gramio/dist / SetWebhookParams
Interface: SetWebhookParams
Defined in: @gramio/types/out/params.d.ts:46
Params object for setWebhook method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allowed_updates? | ("message" | "edited_message" | "channel_post" | "edited_channel_post" | "business_connection" | "business_message" | "edited_business_message" | "deleted_business_messages" | "message_reaction" | "message_reaction_count" | "inline_query" | "chosen_inline_result" | "callback_query" | "shipping_query" | "pre_checkout_query" | "purchased_paid_media" | "poll" | "poll_answer" | "my_chat_member" | "chat_member" | "chat_join_request" | "chat_boost" | "removed_chat_boost")[] | 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, message_reaction, and message_reaction_count (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. | @gramio/types/out/params.d.ts:67 |
certificate? | Blob | Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. | @gramio/types/out/params.d.ts:54 |
drop_pending_updates? | boolean | Pass True to drop all pending updates | @gramio/types/out/params.d.ts:71 |
ip_address? | string | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS | @gramio/types/out/params.d.ts:58 |
max_connections? | number | The 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. | @gramio/types/out/params.d.ts:62 |
secret_token? | string | A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. | @gramio/types/out/params.d.ts:75 |
url | string | HTTPS URL to send updates to. Use an empty string to remove webhook integration | @gramio/types/out/params.d.ts:50 |