simbot-component-telegram-api/love.forte.simbot.telegram.api.update/SetWebhookApi/Params

Params

data class Params(var url: String, var certificate: InputFile? = null, var ipAddress: String? = null, var maxConnections: Int? = null, var allowedUpdates: Collection<String>? = null, var dropPendingUpdates: String? = null, var secretToken: String? = null)(source)

Request body of SetWebhookApi.

Constructors

Params

constructor(urlValue: String)

constructor(url: String, certificate: InputFile? = null, ipAddress: String? = null, maxConnections: Int? = null, allowedUpdates: Collection<String>? = null, dropPendingUpdates: String? = null, secretToken: String? = null)

Properties

allowedUpdates

@SerialName(value = "allowed_updates")

var allowedUpdates: Collection<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 update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.

certificate

var certificate: InputFile?

Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.

dropPendingUpdates

@SerialName(value = "drop_pending_updates")

var dropPendingUpdates: String?

Optional. Pass True to drop all pending updates

ipAddress

@SerialName(value = "ip_address")

var ipAddress: String?

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

maxConnections

@SerialName(value = "max_connections")

var maxConnections: Int?

Optional. 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.

secretToken

@SerialName(value = "secret_token")

var secretToken: String?

Optional. 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.

url

var url: String

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