TelegramRequest

Types

AddStickerToSetRequest

data class AddStickerToSetRequest(user_id: Long, name: String, png_sticker: String?, tgs_sticker: Any?, emojis: String, mask_position: MaskPosition?) : TelegramRequest

Use this method to add a new sticker to a set created by the bot.

AnswerCallbackQueryRequest

data class AnswerCallbackQueryRequest(callback_query_id: String, text: String?, show_alert: Boolean?, url: String?, cache_time: Long?) : TelegramRequest

Use this method to send answers to callback queries sent from inline keyboards.

AnswerInlineQueryRequest

data class AnswerInlineQueryRequest(inline_query_id: String, results: List<InlineQueryResult>, cache_time: Long?, is_personal: Boolean?, next_offset: String?, switch_pm_text: String?, switch_pm_parameter: String?) : TelegramRequest

Use this method to send answers to an inline query.

AnswerPreCheckoutQueryRequest

data class AnswerPreCheckoutQueryRequest(pre_checkout_query_id: String, ok: Boolean, error_message: String?) : TelegramRequest

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query.

AnswerShippingQueryRequest

data class AnswerShippingQueryRequest(shipping_query_id: String, ok: Boolean, shipping_options: List<ShippingOption>?, error_message: String?) : TelegramRequest

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot.

BanChatMemberRequest

data class BanChatMemberRequest(chat_id: String, user_id: Long, until_date: Long?, revoke_messages: Boolean?) : TelegramRequest

Use this method to ban a user in a group, a supergroup or a channel.

CopyMessageRequest

data class CopyMessageRequest(chat_id: String, from_chat_id: String, message_id: Long, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to copy messages of any kind.

CreateChatInviteLinkRequest

data class CreateChatInviteLinkRequest(chat_id: String, expire_date: Long?, member_limit: Long?) : TelegramRequest

Use this method to create an additional invite link for a chat.

CreateNewStickerSetRequest

data class CreateNewStickerSetRequest(user_id: Long, name: String, title: String, png_sticker: String?, tgs_sticker: Any?, emojis: String, contains_masks: Boolean?, mask_position: MaskPosition?) : TelegramRequest

Use this method to create a new sticker set owned by a user.

DeleteChatPhotoRequest

data class DeleteChatPhotoRequest(chat_id: String) : TelegramRequest

Use this method to delete a chat photo.

DeleteChatStickerSetRequest

data class DeleteChatStickerSetRequest(chat_id: String) : TelegramRequest

Use this method to delete a group sticker set from a supergroup.

DeleteMessageRequest

data class DeleteMessageRequest(chat_id: String, message_id: Long) : TelegramRequest

Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
Returns True on success.

DeleteMyCommandsRequest

data class DeleteMyCommandsRequest(scope: BotCommandScope?, language_code: String?) : TelegramRequest

Use this method to delete the list of the bot's commands for the given scope and user language.

DeleteStickerFromSetRequest

data class DeleteStickerFromSetRequest(sticker: String) : TelegramRequest

Use this method to delete a sticker from a set created by the bot.

DeleteWebhookRequest

data class DeleteWebhookRequest(drop_pending_updates: Boolean?) : TelegramRequest

Use this method to remove webhook integration if you decide to switch back to getUpdates.

EditChatInviteLinkRequest

data class EditChatInviteLinkRequest(chat_id: String, invite_link: String, expire_date: Long?, member_limit: Long?) : TelegramRequest

Use this method to edit a non-primary invite link created by the bot.

EditMessageCaptionRequest

data class EditMessageCaptionRequest(chat_id: String?, message_id: Long?, inline_message_id: String?, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to edit captions of messages.

EditMessageLiveLocationRequest

data class EditMessageLiveLocationRequest(chat_id: String?, message_id: Long?, inline_message_id: String?, latitude: Float, longitude: Float, horizontal_accuracy: Float?, heading: Long?, proximity_alert_radius: Long?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to edit live location messages.

EditMessageMediaRequest

data class EditMessageMediaRequest(chat_id: String?, message_id: Long?, inline_message_id: String?, media: InputMedia, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to edit animation, audio, document, photo, or video messages.

EditMessageReplyMarkupRequest

data class EditMessageReplyMarkupRequest(chat_id: String?, message_id: Long?, inline_message_id: String?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to edit only the reply markup of messages.

EditMessageTextRequest

data class EditMessageTextRequest(chat_id: String?, message_id: Long?, inline_message_id: String?, text: String, parse_mode: ParseMode?, entities: List<MessageEntity>?, disable_web_page_preview: Boolean?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to edit text and game messages.

ExportChatInviteLinkRequest

data class ExportChatInviteLinkRequest(chat_id: String) : TelegramRequest

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked.

ForwardMessageRequest

data class ForwardMessageRequest(chat_id: String, from_chat_id: String, disable_notification: Boolean?, message_id: Long) : TelegramRequest

Use this method to forward messages of any kind.

GetChatAdministratorsRequest

data class GetChatAdministratorsRequest(chat_id: String) : TelegramRequest

Use this method to get a list of administrators in a chat.

GetChatMemberCountRequest

data class GetChatMemberCountRequest(chat_id: String) : TelegramRequest

Use this method to get the number of members in a chat.

GetChatMemberRequest

data class GetChatMemberRequest(chat_id: String, user_id: Long) : TelegramRequest

Use this method to get information about a member of a chat.

GetChatRequest

data class GetChatRequest(chat_id: String) : TelegramRequest

Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.).

GetFileRequest

data class GetFileRequest(file_id: String) : TelegramRequest

Use this method to get basic info about a file and prepare it for downloading.

GetGameHighScoresRequest

data class GetGameHighScoresRequest(user_id: Long, chat_id: Long?, message_id: Long?, inline_message_id: String?) : TelegramRequest

Use this method to get data for high score tables.

GetMyCommandsRequest

data class GetMyCommandsRequest(scope: BotCommandScope?, language_code: String?) : TelegramRequest

Use this method to get the current list of the bot's commands for the given scope and user language.

GetStickerSetRequest

data class GetStickerSetRequest(name: String) : TelegramRequest

Use this method to get a sticker set.

GetUpdatesRequest

data class GetUpdatesRequest(offset: Long?, limit: Long?, timeout: Long?, allowed_updates: List<String>?) : TelegramRequest

Use this method to receive incoming updates using long polling (wiki).

GetUserProfilePhotosRequest

data class GetUserProfilePhotosRequest(user_id: Long, offset: Long?, limit: Long?) : TelegramRequest

Use this method to get a list of profile pictures for a user.

LeaveChatRequest

data class LeaveChatRequest(chat_id: String) : TelegramRequest

Use this method for your bot to leave a group, supergroup or channel.

PinChatMessageRequest

data class PinChatMessageRequest(chat_id: String, message_id: Long, disable_notification: Boolean?) : TelegramRequest

Use this method to add a message to the list of pinned messages in a chat.

PromoteChatMemberRequest

data class PromoteChatMemberRequest(chat_id: String, user_id: Long, is_anonymous: Boolean?, can_manage_chat: Boolean?, can_post_messages: Boolean?, can_edit_messages: Boolean?, can_delete_messages: Boolean?, can_manage_voice_chats: Boolean?, can_restrict_members: Boolean?, can_promote_members: Boolean?, can_change_info: Boolean?, can_invite_users: Boolean?, can_pin_messages: Boolean?) : TelegramRequest

Use this method to promote or demote a user in a supergroup or a channel.

RestrictChatMemberRequest

data class RestrictChatMemberRequest(chat_id: String, user_id: Long, permissions: ChatPermissions, until_date: Long?) : TelegramRequest

Use this method to restrict a user in a supergroup.

RevokeChatInviteLinkRequest

data class RevokeChatInviteLinkRequest(chat_id: String, invite_link: String) : TelegramRequest

Use this method to revoke an invite link created by the bot.

SendAnimationRequest

data class SendAnimationRequest(chat_id: String, animation: String, duration: Long?, width: Long?, height: Long?, thumb: String?, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).

SendAudioRequest

data class SendAudioRequest(chat_id: String, audio: String, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, duration: Long?, performer: String?, title: String?, thumb: String?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send audio files, if you want Telegram clients to display them in the music player.

SendChatActionRequest

data class SendChatActionRequest(chat_id: String, action: String) : TelegramRequest

Use this method when you need to tell the user that something is happening on the bot's side.

SendContactRequest

data class SendContactRequest(chat_id: String, phone_number: String, first_name: String, last_name: String?, vcard: String?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send phone contacts.

SendDiceRequest

data class SendDiceRequest(chat_id: String, emoji: String?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send an animated emoji that will display a random value.

SendDocumentRequest

data class SendDocumentRequest(chat_id: String, document: String, thumb: String?, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, disable_content_type_detection: Boolean?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send general files.

SendGameRequest

data class SendGameRequest(chat_id: Long, game_short_name: String, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to send a game.

SendInvoiceRequest

data class SendInvoiceRequest(chat_id: String, title: String, description: String, payload: String, provider_token: String, currency: String, prices: List<LabeledPrice>, max_tip_amount: Long?, suggested_tip_amounts: List<Long>?, start_parameter: String?, provider_data: String?, photo_url: String?, photo_size: Long?, photo_width: Long?, photo_height: Long?, need_name: Boolean?, need_phone_number: Boolean?, need_email: Boolean?, need_shipping_address: Boolean?, send_phone_number_to_provider: Boolean?, send_email_to_provider: Boolean?, is_flexible: Boolean?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to send invoices.

SendLocationRequest

data class SendLocationRequest(chat_id: String, latitude: Float, longitude: Float, horizontal_accuracy: Float?, live_period: Long?, heading: Long?, proximity_alert_radius: Long?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send point on the map.

SendMediaGroupRequest

data class SendMediaGroupRequest(chat_id: String, media: List<InputMedia>, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?) : TelegramRequest

Use this method to send a group of photos, videos, documents or audios as an album.

SendMessageRequest

data class SendMessageRequest(chat_id: String, text: String, parse_mode: ParseMode?, entities: List<MessageEntity>?, disable_web_page_preview: Boolean?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send text messages.

SendPhotoRequest

data class SendPhotoRequest(chat_id: String, photo: String, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send photos.

SendPollRequest

data class SendPollRequest(chat_id: String, question: String, options: List<String>, is_anonymous: Boolean?, type: String?, allows_multiple_answers: Boolean?, correct_option_id: Long?, explanation: String?, explanation_parse_mode: String?, explanation_entities: List<MessageEntity>?, open_period: Long?, close_date: Long?, is_closed: Boolean?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send a native poll.

SendStickerRequest

data class SendStickerRequest(chat_id: String, sticker: String, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send static .WEBP or animated .TGS stickers.

SendVenueRequest

data class SendVenueRequest(chat_id: String, latitude: Float, longitude: Float, title: String, address: String, foursquare_id: String?, foursquare_type: String?, google_place_id: String?, google_place_type: String?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send information about a venue.

SendVideoNoteRequest

data class SendVideoNoteRequest(chat_id: String, video_note: String, duration: Long?, length: Long?, thumb: String?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long.

SendVideoRequest

data class SendVideoRequest(chat_id: String, video: String, duration: Long?, width: Long?, height: Long?, thumb: String?, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, supports_streaming: Boolean?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).

SendVoiceRequest

data class SendVoiceRequest(chat_id: String, voice: String, caption: String?, parse_mode: ParseMode?, caption_entities: List<MessageEntity>?, duration: Long?, disable_notification: Boolean?, reply_to_message_id: Long?, allow_sending_without_reply: Boolean?, reply_markup: KeyboardOption?) : TelegramRequest

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.

SetChatAdministratorCustomTitleRequest

data class SetChatAdministratorCustomTitleRequest(chat_id: String, user_id: Long, custom_title: String) : TelegramRequest

Use this method to set a custom title for an administrator in a supergroup promoted by the bot.

SetChatDescriptionRequest

data class SetChatDescriptionRequest(chat_id: String, description: String?) : TelegramRequest

Use this method to change the description of a group, a supergroup or a channel.

SetChatPermissionsRequest

data class SetChatPermissionsRequest(chat_id: String, permissions: ChatPermissions) : TelegramRequest

Use this method to set default chat permissions for all members.

SetChatPhotoRequest

data class SetChatPhotoRequest(chat_id: String, photo: Any) : TelegramRequest

Use this method to set a new profile photo for the chat.

SetChatStickerSetRequest

data class SetChatStickerSetRequest(chat_id: String, sticker_set_name: String) : TelegramRequest

Use this method to set a new group sticker set for a supergroup.

SetChatTitleRequest

data class SetChatTitleRequest(chat_id: String, title: String) : TelegramRequest

Use this method to change the title of a chat.

SetGameScoreRequest

data class SetGameScoreRequest(user_id: Long, score: Long, force: Boolean?, disable_edit_message: Boolean?, chat_id: Long?, message_id: Long?, inline_message_id: String?) : TelegramRequest

Use this method to set the score of the specified user in a game message.

SetMyCommandsRequest

data class SetMyCommandsRequest(commands: List<BotCommand>, scope: BotCommandScope?, language_code: String?) : TelegramRequest

Use this method to change the list of the bot's commands.

SetPassportDataErrorsRequest

data class SetPassportDataErrorsRequest(user_id: Long, errors: List<PassportElementError>) : TelegramRequest

Informs a user that some of the Telegram Passport elements they provided contains errors.

SetStickerPositionInSetRequest

data class SetStickerPositionInSetRequest(sticker: String, position: Long) : TelegramRequest

Use this method to move a sticker in a set created by the bot to a specific position.

SetStickerSetThumbRequest

data class SetStickerSetThumbRequest(name: String, user_id: Long, thumb: String?) : TelegramRequest

Use this method to set the thumbnail of a sticker set.

SetWebhookRequest

data class SetWebhookRequest(url: String, certificate: Any?, ip_address: String?, max_connections: Long?, allowed_updates: List<String>?, drop_pending_updates: Boolean?) : TelegramRequest

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

StopMessageLiveLocationRequest

data class StopMessageLiveLocationRequest(chat_id: String?, message_id: Long?, inline_message_id: String?, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to stop updating a live location message before live_period expires.

StopPollRequest

data class StopPollRequest(chat_id: String, message_id: Long, reply_markup: InlineKeyboardMarkup?) : TelegramRequest

Use this method to stop a poll which was sent by the bot.

UnbanChatMemberRequest

data class UnbanChatMemberRequest(chat_id: String, user_id: Long, only_if_banned: Boolean?) : TelegramRequest

Use this method to unban a previously banned user in a supergroup or channel.

UnpinAllChatMessagesRequest

data class UnpinAllChatMessagesRequest(chat_id: String) : TelegramRequest

Use this method to clear the list of pinned messages in a chat.

UnpinChatMessageRequest

data class UnpinChatMessageRequest(chat_id: String, message_id: Long?) : TelegramRequest

Use this method to remove a message from the list of pinned messages in a chat.

UploadStickerFileRequest

data class UploadStickerFileRequest(user_id: Long, png_sticker: Any) : TelegramRequest

Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times).

Inheritors

TelegramRequest