Package com.github.lamba92.kotlingram.api.generated

Types

AddStickerToSetRequest

common

data class AddStickerToSetRequest(userId: Int, name: String, pngSticker: String?, tgsSticker: String?, emojis: String, maskPosition: MaskPosition?)

Request body for addStickerToSet

Animation

common

data class Animation(fileId: String, fileUniqueId: String, width: Int, height: Int, duration: Int, thumb: PhotoSize?, fileName: String?, mimeType: String?, fileSize: Int?)

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

AnswerCallbackQueryRequest

common

data class AnswerCallbackQueryRequest(callbackQueryId: String, text: String?, showAlert: Boolean, url: String?, cacheTime: Int?)

Request body for answerCallbackQuery

AnswerInlineQueryRequest

common

data class AnswerInlineQueryRequest(inlineQueryId: String, results: List<InlineQueryResult>, cacheTime: Int?, isPersonal: Boolean, nextOffset: String?, switchPmText: String?, switchPmParameter: String?)

Request body for answerInlineQuery

AnswerPreCheckoutQueryRequest

common

data class AnswerPreCheckoutQueryRequest(preCheckoutQueryId: String, ok: Boolean, errorMessage: String?)

Request body for answerPreCheckoutQuery

AnswerShippingQueryRequest

common

data class AnswerShippingQueryRequest(shippingQueryId: String, ok: Boolean, shippingOptions: List<ShippingOption>, errorMessage: String?)

Request body for answerShippingQuery

Audio

common

data class Audio(fileId: String, fileUniqueId: String, duration: Int, performer: String?, title: String?, fileName: String?, mimeType: String?, fileSize: Int?, thumb: PhotoSize?)

This object represents an audio file to be treated as music by the Telegram clients.

BotCommand

common

data class BotCommand(command: String, description: String)

This object represents a bot command.

CallbackGame

common

typealias CallbackGame = String

A placeholder, currently holds no information. Use BotFather to set up your game.

CallbackQuery

common

data class CallbackQuery(id: String, from: User, message: Message?, inlineMessageId: String?, chatInstance: String, data: String?, gameShortName: String?)

This object represents an incoming callback query from a callback button in an inline keyboard.

Chat

common

data class Chat(id: Int, title: String?, username: String?, firstName: String?, lastName: String?, photo: ChatPhoto?, bio: String?, description: String?, inviteLink: String?, pinnedMessage: Message?, permissions: ChatPermissions?, slowModeDelay: Int?, stickerSetName: String?, canSetStickerSet: Boolean, linkedChatId: Int?, location: ChatLocation?, type: String)

This object represents a chat.

ChatLocation

common

data class ChatLocation(location: Location, address: String)

Represents a location to which a chat is connected.

ChatMember

common

data class ChatMember(user: User, status: String, customTitle: String?, isAnonymous: Boolean, canBeEdited: Boolean, canPostMessages: Boolean, canEditMessages: Boolean, canDeleteMessages: Boolean, canRestrictMembers: Boolean, canPromoteMembers: Boolean, canChangeInfo: Boolean, canInviteUsers: Boolean, canPinMessages: Boolean, isMember: Boolean, canSendMessages: Boolean, canSendMediaMessages: Boolean, canSendPolls: Boolean, canSendOtherMessages: Boolean, canAddWebPagePreviews: Boolean, untilDate: Int?)

This object contains information about one member of a chat.

ChatPermissions

common

data class ChatPermissions(canSendMessages: Boolean, canSendMediaMessages: Boolean, canSendPolls: Boolean, canSendOtherMessages: Boolean, canAddWebPagePreviews: Boolean, canChangeInfo: Boolean, canInviteUsers: Boolean, canPinMessages: Boolean)

Describes actions that a non-administrator user is allowed to take in a chat.

ChatPhoto

common

data class ChatPhoto(smallFileId: String, smallFileUniqueId: String, bigFileId: String, bigFileUniqueId: String)

This object represents a chat photo.

ChosenInlineResult

common

data class ChosenInlineResult(resultId: String, from: User, location: Location?, inlineMessageId: String?, query: String)

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

Contact

common

data class Contact(phoneNumber: String, firstName: String, lastName: String?, userId: Int?, vcard: String?)

This object represents a phone contact.

CopyMessageRequest

common

data class CopyMessageRequest(chatId: Int, fromChatId: Int, messageId: Int, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for copyMessage

CreateNewStickerSetRequest

common

data class CreateNewStickerSetRequest(userId: Int, name: String, title: String, pngSticker: String?, tgsSticker: String?, emojis: String, containsMasks: Boolean, maskPosition: MaskPosition?)

Request body for createNewStickerSet

DeleteChatPhotoRequest

common

data class DeleteChatPhotoRequest(chatId: Int)

Request body for deleteChatPhoto

DeleteChatStickerSetRequest

common

data class DeleteChatStickerSetRequest(chatId: Int)

Request body for deleteChatStickerSet

DeleteMessageRequest

common

data class DeleteMessageRequest(chatId: Int, messageId: Int)

Request body for deleteMessage

DeleteStickerFromSetRequest

common

data class DeleteStickerFromSetRequest(sticker: String)

Request body for deleteStickerFromSet

DeleteWebhookRequest

common

data class DeleteWebhookRequest(dropPendingUpdates: Boolean)

Request body for deleteWebhook

Dice

common

data class Dice(emoji: String, value: Int)

This object represents an animated emoji that displays a random value.

Document

common

data class Document(fileId: String, fileUniqueId: String, thumb: PhotoSize?, fileName: String?, mimeType: String?, fileSize: Int?)

This object represents a general file (as opposed to photos, voice messages and audio files).

EditMessageCaptionRequest

common

data class EditMessageCaptionRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?)

Request body for editMessageCaption

EditMessageLiveLocationRequest

common

data class EditMessageLiveLocationRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, latitude: Float, longitude: Float, horizontalAccuracy: Float?, heading: Int?, proximityAlertRadius: Int?, replyMarkup: InlineKeyboardMarkup?)

Request body for editMessageLiveLocation

EditMessageMediaRequest

common

data class EditMessageMediaRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, media: InputMedia, replyMarkup: InlineKeyboardMarkup?)

Request body for editMessageMedia

EditMessageReplyMarkupRequest

common

data class EditMessageReplyMarkupRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, replyMarkup: InlineKeyboardMarkup?)

Request body for editMessageReplyMarkup

EditMessageTextRequest

common

data class EditMessageTextRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, text: String, parseMode: String?, entities: List<MessageEntity>, disableWebPagePreview: Boolean, replyMarkup: InlineKeyboardMarkup?)

Request body for editMessageText

EncryptedCredentials

common

data class EncryptedCredentials(data: String, hash: String, secret: String)

Contains data required for decrypting and authenticating EncryptedPassportElement.

EncryptedPassportElement

common

data class EncryptedPassportElement(data: String?, phoneNumber: String?, email: String?, files: List<PassportFile>, frontSide: PassportFile?, reverseSide: PassportFile?, selfie: PassportFile?, translation: List<PassportFile>, hash: String, type: String)

Contains information about documents or other Telegram Passport elements shared with the bot by the user.

ExportChatInviteLinkRequest

common

data class ExportChatInviteLinkRequest(chatId: Int)

Request body for exportChatInviteLink

File

common

data class File(fileId: String, fileUniqueId: String, fileSize: Int?, filePath: String?)

This object represents a file ready to be downloaded.

ForceReply

common

data class ForceReply(forceReply: Boolean, selective: Boolean) : ReplyMarkup

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').

ForwardMessageRequest

common

data class ForwardMessageRequest(chatId: Int, fromChatId: Int, disableNotification: Boolean, messageId: Int)

Request body for forwardMessage

Game

common

data class Game(title: String, description: String, photo: List<PhotoSize>, text: String?, textEntities: List<MessageEntity>, animation: Animation?)

This object represents a game.

GameHighScore

common

data class GameHighScore(position: Int, user: User, score: Int)

This object represents one row of the high scores table for a game.

GetChatAdministratorsRequest

common

data class GetChatAdministratorsRequest(chatId: Int)

Request body for getChatAdministrators

GetChatMemberRequest

common

data class GetChatMemberRequest(chatId: Int, userId: Int)

Request body for getChatMember

GetChatMembersCountRequest

common

data class GetChatMembersCountRequest(chatId: Int)

Request body for getChatMembersCount

GetChatRequest

common

data class GetChatRequest(chatId: Int)

Request body for getChat

GetFileRequest

common

data class GetFileRequest(fileId: String)

Request body for getFile

GetGameHighScoresRequest

common

data class GetGameHighScoresRequest(userId: Int, chatId: Int?, messageId: Int?, inlineMessageId: String?)

Request body for getGameHighScores

GetStickerSetRequest

common

data class GetStickerSetRequest(name: String)

Request body for getStickerSet

GetUpdatesRequest

common

data class GetUpdatesRequest(offset: Int?, limit: Int?, timeout: Int?, allowedUpdates: List<String>)

Request body for getUpdates

GetUserProfilePhotosRequest

common

data class GetUserProfilePhotosRequest(userId: Int, offset: Int?, limit: Int?)

Request body for getUserProfilePhotos

InlineKeyboardButton

common

data class InlineKeyboardButton(text: String, url: String?, loginUrl: LoginUrl?, callbackData: String?, switchInlineQuery: String?, switchInlineQueryCurrentChat: String?, callbackGame: CallbackGame?, pay: Boolean)

This object represents one button of an inline keyboard.

InlineKeyboardMarkup

common

data class InlineKeyboardMarkup(inlineKeyboard: List<List<InlineKeyboardButton>>) : ReplyMarkup

This object represents an inline keyboard that appears right next to the message it belongs to.

InlineQuery

common

data class InlineQuery(id: String, from: User, location: Location?, query: String, offset: String)

This object represents an incoming inline query.

InlineQueryResult

common

sealed class InlineQueryResult

This object represents one result of an inline query.

InlineQueryResultArticle

common

data class InlineQueryResultArticle(id: String, title: String, inputMessageContent: InputMessageContent, replyMarkup: InlineKeyboardMarkup?, url: String?, hideUrl: Boolean, description: String?, thumbUrl: String?, thumbWidth: Int?, thumbHeight: Int?, type: String) : InlineQueryResult

Represents a link to an article or web page.

InlineQueryResultAudio

common

data class InlineQueryResultAudio(id: String, audioUrl: String, title: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, performer: String?, audioDuration: Int?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to an MP3 audio file.

InlineQueryResultCachedAudio

common

data class InlineQueryResultCachedAudio(id: String, audioFileId: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to an MP3 audio file stored on the Telegram servers.

InlineQueryResultCachedDocument

common

data class InlineQueryResultCachedDocument(id: String, title: String, documentFileId: String, description: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a file stored on the Telegram servers.

InlineQueryResultCachedGif

common

data class InlineQueryResultCachedGif(id: String, gifFileId: String, title: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to an animated GIF file stored on the Telegram servers.

InlineQueryResultCachedMpeg4Gif

common

data class InlineQueryResultCachedMpeg4Gif(id: String, mpeg4FileId: String, title: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers.

InlineQueryResultCachedPhoto

common

data class InlineQueryResultCachedPhoto(id: String, photoFileId: String, title: String?, description: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a photo stored on the Telegram servers.

InlineQueryResultCachedSticker

common

data class InlineQueryResultCachedSticker(id: String, stickerFileId: String, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a sticker stored on the Telegram servers.

InlineQueryResultCachedVideo

common

data class InlineQueryResultCachedVideo(id: String, videoFileId: String, title: String, description: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a video file stored on the Telegram servers.

InlineQueryResultCachedVoice

common

data class InlineQueryResultCachedVoice(id: String, voiceFileId: String, title: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a voice message stored on the Telegram servers.

InlineQueryResultContact

common

data class InlineQueryResultContact(id: String, phoneNumber: String, firstName: String, lastName: String?, vcard: String?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, thumbUrl: String?, thumbWidth: Int?, thumbHeight: Int?, type: String) : InlineQueryResult

Represents a contact with a phone number.

InlineQueryResultDocument

common

data class InlineQueryResultDocument(id: String, title: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, documentUrl: String, mimeType: String, description: String?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, thumbUrl: String?, thumbWidth: Int?, thumbHeight: Int?, type: String) : InlineQueryResult

Represents a link to a file.

InlineQueryResultGame

common

data class InlineQueryResultGame(id: String, gameShortName: String, replyMarkup: InlineKeyboardMarkup?, type: String) : InlineQueryResult

Represents a Game.

InlineQueryResultGif

common

data class InlineQueryResultGif(id: String, gifUrl: String, gifWidth: Int?, gifHeight: Int?, gifDuration: Int?, thumbUrl: String, thumbMimeType: String?, title: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to an animated GIF file.

InlineQueryResultLocation

common

data class InlineQueryResultLocation(id: String, latitude: Float, longitude: Float, title: String, horizontalAccuracy: Float?, livePeriod: Int?, heading: Int?, proximityAlertRadius: Int?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, thumbUrl: String?, thumbWidth: Int?, thumbHeight: Int?, type: String) : InlineQueryResult

Represents a location on a map.

InlineQueryResultMpeg4Gif

common

data class InlineQueryResultMpeg4Gif(id: String, mpeg4Url: String, mpeg4Width: Int?, mpeg4Height: Int?, mpeg4Duration: Int?, thumbUrl: String, thumbMimeType: String?, title: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound).

InlineQueryResultPhoto

common

data class InlineQueryResultPhoto(id: String, photoUrl: String, thumbUrl: String, photoWidth: Int?, photoHeight: Int?, title: String?, description: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a photo.

InlineQueryResultVenue

common

data class InlineQueryResultVenue(id: String, latitude: Float, longitude: Float, title: String, address: String, foursquareId: String?, foursquareType: String?, googlePlaceId: String?, googlePlaceType: String?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, thumbUrl: String?, thumbWidth: Int?, thumbHeight: Int?, type: String) : InlineQueryResult

Represents a venue.

InlineQueryResultVideo

common

data class InlineQueryResultVideo(id: String, videoUrl: String, mimeType: String, thumbUrl: String, title: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, videoWidth: Int?, videoHeight: Int?, videoDuration: Int?, description: String?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a page containing an embedded video player or a video file.

InlineQueryResultVoice

common

data class InlineQueryResultVoice(id: String, voiceUrl: String, title: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, voiceDuration: Int?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, type: String) : InlineQueryResult

Represents a link to a voice recording in an .OGG container encoded with OPUS.

InputContactMessageContent

common

data class InputContactMessageContent(phoneNumber: String, firstName: String, lastName: String?, vcard: String?) : InputMessageContent

Represents the content of a contact message to be sent as the result of an inline query.

InputLocationMessageContent

common

data class InputLocationMessageContent(latitude: Float, longitude: Float, horizontalAccuracy: Float?, livePeriod: Int?, heading: Int?, proximityAlertRadius: Int?) : InputMessageContent

Represents the content of a location message to be sent as the result of an inline query.

InputMedia

common

sealed class InputMedia

This object represents the content of a media message to be sent.

InputMediaAnimation

common

data class InputMediaAnimation(media: String, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, width: Int?, height: Int?, duration: Int?)

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

InputMediaAudio

common

data class InputMediaAudio(media: String, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, duration: Int?, performer: String?, title: String?) : InputMedia

Represents an audio file to be treated as music to be sent.

InputMediaDocument

common

data class InputMediaDocument(media: String, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, disableContentTypeDetection: Boolean) : InputMedia

Represents a general file to be sent.

InputMediaPhoto

common

data class InputMediaPhoto(media: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>) : InputMedia

Represents a photo to be sent.

InputMediaVideo

common

data class InputMediaVideo(media: String, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, width: Int?, height: Int?, duration: Int?, supportsStreaming: Boolean) : InputMedia

Represents a video to be sent.

InputMessageContent

common

sealed class InputMessageContent

This object represents the content of a message to be sent as a result of an inline query.

InputTextMessageContent

common

data class InputTextMessageContent(messageText: String, parseMode: String?, entities: List<MessageEntity>, disableWebPagePreview: Boolean) : InputMessageContent

Represents the content of a text message to be sent as the result of an inline query.

InputVenueMessageContent

common

data class InputVenueMessageContent(latitude: Float, longitude: Float, title: String, address: String, foursquareId: String?, foursquareType: String?, googlePlaceId: String?, googlePlaceType: String?) : InputMessageContent

Represents the content of a venue message to be sent as the result of an inline query.

Invoice

common

data class Invoice(title: String, description: String, startParameter: String, currency: String, totalAmount: Int)

This object contains basic information about an invoice.

KeyboardButton

common

data class KeyboardButton(text: String, requestContact: Boolean, requestLocation: Boolean, requestPoll: KeyboardButtonPollType?)

This object represents one button of the reply keyboard.

KeyboardButtonPollType

common

data class KeyboardButtonPollType(type: String?)

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

KickChatMemberRequest

common

data class KickChatMemberRequest(chatId: Int, userId: Int, untilDate: Int?)

Request body for kickChatMember

LabeledPrice

common

data class LabeledPrice(label: String, amount: Int)

This object represents a portion of the price for goods or services.

LeaveChatRequest

common

data class LeaveChatRequest(chatId: Int)

Request body for leaveChat

Location

common

data class Location(longitude: Float, latitude: Float, horizontalAccuracy: Float?, livePeriod: Int?, heading: Int?, proximityAlertRadius: Int?)

This object represents a point on the map.

LoginUrl

common

data class LoginUrl(url: String, forwardText: String?, botUsername: String?, requestWriteAccess: Boolean)

This object represents a parameter of the inline keyboard button used to automatically authorize a user.

MaskPosition

common

data class MaskPosition(point: String, xShift: Float, yShift: Float, scale: Float)

This object describes the position on faces where a mask should be placed by default.

Message

common

data class Message(messageId: Int, from: User?, senderChat: Chat?, date: Int, chat: Chat, forwardFrom: User?, forwardFromChat: Chat?, forwardFromMessageId: Int?, forwardSignature: String?, forwardSenderName: String?, forwardDate: Int?, replyToMessage: Message?, viaBot: User?, editDate: Int?, mediaGroupId: String?, authorSignature: String?, text: String?, entities: List<MessageEntity>, animation: Animation?, audio: Audio?, document: Document?, photo: List<PhotoSize>, sticker: Sticker?, video: Video?, videoNote: VideoNote?, voice: Voice?, caption: String?, captionEntities: List<MessageEntity>, contact: Contact?, dice: Dice?, game: Game?, poll: Poll?, venue: Venue?, location: Location?, newChatMembers: List<User>, leftChatMember: User?, newChatTitle: String?, newChatPhoto: List<PhotoSize>, deleteChatPhoto: Boolean, groupChatCreated: Boolean, supergroupChatCreated: Boolean, channelChatCreated: Boolean, migrateToChatId: Int?, migrateFromChatId: Int?, pinnedMessage: Message?, invoice: Invoice?, successfulPayment: SuccessfulPayment?, connectedWebsite: String?, passportData: PassportData?, proximityAlertTriggered: ProximityAlertTriggered?, replyMarkup: InlineKeyboardMarkup?)

This object represents a message.

MessageEntity

common

data class MessageEntity(offset: Int, length: Int, url: String?, user: User?, language: String?, type: String)

This object represents one special entity in a text message.

MessageId

common

data class MessageId(messageId: Int)

This object represents a unique message identifier.

OrderInfo

common

data class OrderInfo(name: String?, phoneNumber: String?, email: String?, shippingAddress: ShippingAddress?)

This object represents information about an order.

PassportData

common

data class PassportData(data: List<EncryptedPassportElement>, credentials: EncryptedCredentials)

Contains information about Telegram Passport data shared with the bot by the user.

PassportFile

common

data class PassportFile(fileId: String, fileUniqueId: String, fileSize: Int, fileDate: Int)

This object represents a file uploaded to Telegram Passport.

PhotoSize

common

data class PhotoSize(fileId: String, fileUniqueId: String, width: Int, height: Int, fileSize: Int?)

This object represents one size of a photo or a file / sticker thumbnail.

PinChatMessageRequest

common

data class PinChatMessageRequest(chatId: Int, messageId: Int, disableNotification: Boolean)

Request body for pinChatMessage

Poll

common

data class Poll(id: String, question: String, options: List<PollOption>, totalVoterCount: Int, isClosed: Boolean, isAnonymous: Boolean, allowsMultipleAnswers: Boolean, correctOptionId: Int?, explanation: String?, explanationEntities: List<MessageEntity>, openPeriod: Int?, closeDate: Int?, type: String)

This object contains information about a poll.

PollAnswer

common

data class PollAnswer(pollId: String, user: User, optionIds: List<Int>)

This object represents an answer of a user in a non-anonymous poll.

PollOption

common

data class PollOption(text: String, voterCount: Int)

This object contains information about one answer option in a poll.

PreCheckoutQuery

common

data class PreCheckoutQuery(id: String, from: User, currency: String, totalAmount: Int, invoicePayload: String, shippingOptionId: String?, orderInfo: OrderInfo?)

This object contains information about an incoming pre-checkout query.

PromoteChatMemberRequest

common

data class PromoteChatMemberRequest(chatId: Int, userId: Int, isAnonymous: Boolean, canChangeInfo: Boolean, canPostMessages: Boolean, canEditMessages: Boolean, canDeleteMessages: Boolean, canInviteUsers: Boolean, canRestrictMembers: Boolean, canPinMessages: Boolean, canPromoteMembers: Boolean)

Request body for promoteChatMember

ProximityAlertTriggered

common

data class ProximityAlertTriggered(traveler: User, watcher: User, distance: Int)

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

ReplyKeyboardMarkup

common

data class ReplyKeyboardMarkup(keyboard: List<List<KeyboardButton>>, resizeKeyboard: Boolean, oneTimeKeyboard: Boolean, selective: Boolean) : ReplyMarkup

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

ReplyKeyboardRemove

common

data class ReplyKeyboardRemove(removeKeyboard: Boolean, selective: Boolean) : ReplyMarkup

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard.

ReplyMarkup

common

sealed class ReplyMarkup

ResponseParameters

common

data class ResponseParameters(migrateToChatId: Int?, retryAfter: Int?)

Contains information about why a request was unsuccessful.

RestrictChatMemberRequest

common

data class RestrictChatMemberRequest(chatId: Int, userId: Int, permissions: ChatPermissions, untilDate: Int?)

Request body for restrictChatMember

SendAnimationRequest

common

data class SendAnimationRequest(chatId: Int, animation: String, duration: Int?, width: Int?, height: Int?, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendAnimation

SendAudioRequest

common

data class SendAudioRequest(chatId: Int, audio: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, duration: Int?, performer: String?, title: String?, thumb: String?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendAudio

SendChatActionRequest

common

data class SendChatActionRequest(chatId: Int, action: String)

Request body for sendChatAction

SendContactRequest

common

data class SendContactRequest(chatId: Int, phoneNumber: String, firstName: String, lastName: String?, vcard: String?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendContact

SendDiceRequest

common

data class SendDiceRequest(chatId: Int, emoji: String?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendDice

SendDocumentRequest

common

data class SendDocumentRequest(chatId: Int, document: String, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, disableContentTypeDetection: Boolean, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendDocument

SendGameRequest

common

data class SendGameRequest(chatId: Int, gameShortName: String, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: InlineKeyboardMarkup?)

Request body for sendGame

SendInvoiceRequest

common

data class SendInvoiceRequest(chatId: Int, title: String, description: String, payload: String, providerToken: String, startParameter: String, currency: String, prices: List<LabeledPrice>, providerData: String?, photoUrl: String?, photoSize: Int?, photoWidth: Int?, photoHeight: Int?, needName: Boolean, needPhoneNumber: Boolean, needEmail: Boolean, needShippingAddress: Boolean, sendPhoneNumberToProvider: Boolean, sendEmailToProvider: Boolean, isFlexible: Boolean, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: InlineKeyboardMarkup?)

Request body for sendInvoice

SendLocationRequest

common

data class SendLocationRequest(chatId: Int, latitude: Float, longitude: Float, horizontalAccuracy: Float?, livePeriod: Int?, heading: Int?, proximityAlertRadius: Int?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendLocation

SendMediaGroupRequest

common

data class SendMediaGroupRequest(chatId: Int, media: List<InputMedia>, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean)

Request body for sendMediaGroup

SendMessageRequest

common

data class SendMessageRequest(chatId: Int, text: String, parseMode: String?, entities: List<MessageEntity>, disableWebPagePreview: Boolean, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendMessage

SendPhotoRequest

common

data class SendPhotoRequest(chatId: Int, photo: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendPhoto

SendPollRequest

common

data class SendPollRequest(chatId: Int, question: String, options: List<String>, isAnonymous: Boolean, type: String?, allowsMultipleAnswers: Boolean, correctOptionId: Int?, explanation: String?, explanationParseMode: String?, explanationEntities: List<MessageEntity>, openPeriod: Int?, closeDate: Int?, isClosed: Boolean, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendPoll

SendStickerRequest

common

data class SendStickerRequest(chatId: Int, sticker: String, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendSticker

SendVenueRequest

common

data class SendVenueRequest(chatId: Int, latitude: Float, longitude: Float, title: String, address: String, foursquareId: String?, foursquareType: String?, googlePlaceId: String?, googlePlaceType: String?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendVenue

SendVideoNoteRequest

common

data class SendVideoNoteRequest(chatId: Int, videoNote: String, duration: Int?, length: Int?, thumb: String?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendVideoNote

SendVideoRequest

common

data class SendVideoRequest(chatId: Int, video: String, duration: Int?, width: Int?, height: Int?, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, supportsStreaming: Boolean, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendVideo

SendVoiceRequest

common

data class SendVoiceRequest(chatId: Int, voice: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, duration: Int?, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendVoice

SetChatAdministratorCustomTitleRequest

common

data class SetChatAdministratorCustomTitleRequest(chatId: Int, userId: Int, customTitle: String)

Request body for setChatAdministratorCustomTitle

SetChatDescriptionRequest

common

data class SetChatDescriptionRequest(chatId: Int, description: String?)

Request body for setChatDescription

SetChatPermissionsRequest

common

data class SetChatPermissionsRequest(chatId: Int, permissions: ChatPermissions)

Request body for setChatPermissions

SetChatPhotoRequest

common

data class SetChatPhotoRequest(chatId: Int, photo: String)

Request body for setChatPhoto

SetChatStickerSetRequest

common

data class SetChatStickerSetRequest(chatId: Int, stickerSetName: String)

Request body for setChatStickerSet

SetChatTitleRequest

common

data class SetChatTitleRequest(chatId: Int, title: String)

Request body for setChatTitle

SetGameScoreRequest

common

data class SetGameScoreRequest(userId: Int, score: Int, force: Boolean, disableEditMessage: Boolean, chatId: Int?, messageId: Int?, inlineMessageId: String?)

Request body for setGameScore

SetMyCommandsRequest

common

data class SetMyCommandsRequest(commands: List<BotCommand>)

Request body for setMyCommands

SetPassportDataErrorsRequest

common

data class SetPassportDataErrorsRequest(userId: Int, errors: List<PassportElementError>)

Request body for setPassportDataErrors

SetStickerPositionInSetRequest

common

data class SetStickerPositionInSetRequest(sticker: String, position: Int)

Request body for setStickerPositionInSet

SetStickerSetThumbRequest

common

data class SetStickerSetThumbRequest(name: String, userId: Int, thumb: String?)

Request body for setStickerSetThumb

SetWebhookRequest

common

data class SetWebhookRequest(url: String, certificate: String?, ipAddress: String?, maxConnections: Int?, allowedUpdates: List<String>, dropPendingUpdates: Boolean)

Request body for setWebhook

ShippingAddress

common

data class ShippingAddress(countryCode: String, state: String, city: String, streetLine1: String, streetLine2: String, postCode: String)

This object represents a shipping address.

ShippingOption

common

data class ShippingOption(id: String, title: String, prices: List<LabeledPrice>)

This object represents one shipping option.

ShippingQuery

common

data class ShippingQuery(id: String, from: User, invoicePayload: String, shippingAddress: ShippingAddress)

This object contains information about an incoming shipping query.

Sticker

common

data class Sticker(fileId: String, fileUniqueId: String, width: Int, height: Int, isAnimated: Boolean, thumb: PhotoSize?, emoji: String?, setName: String?, maskPosition: MaskPosition?, fileSize: Int?)

This object represents a sticker.

StickerSet

common

data class StickerSet(name: String, title: String, isAnimated: Boolean, containsMasks: Boolean, stickers: List<Sticker>, thumb: PhotoSize?)

This object represents a sticker set.

StopMessageLiveLocationRequest

common

data class StopMessageLiveLocationRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, replyMarkup: InlineKeyboardMarkup?)

Request body for stopMessageLiveLocation

StopPollRequest

common

data class StopPollRequest(chatId: Int, messageId: Int, replyMarkup: InlineKeyboardMarkup?)

Request body for stopPoll

SuccessfulPayment

common

data class SuccessfulPayment(currency: String, totalAmount: Int, invoicePayload: String, shippingOptionId: String?, orderInfo: OrderInfo?, telegramPaymentChargeId: String, providerPaymentChargeId: String)

This object contains basic information about a successful payment.

UnbanChatMemberRequest

common

data class UnbanChatMemberRequest(chatId: Int, userId: Int, onlyIfBanned: Boolean)

Request body for unbanChatMember

UnpinAllChatMessagesRequest

common

data class UnpinAllChatMessagesRequest(chatId: Int)

Request body for unpinAllChatMessages

UnpinChatMessageRequest

common

data class UnpinChatMessageRequest(chatId: Int, messageId: Int?)

Request body for unpinChatMessage

Update

common

data class Update(updateId: Int, message: Message?, editedMessage: Message?, channelPost: Message?, editedChannelPost: Message?, inlineQuery: InlineQuery?, chosenInlineResult: ChosenInlineResult?, callbackQuery: CallbackQuery?, shippingQuery: ShippingQuery?, preCheckoutQuery: PreCheckoutQuery?, poll: Poll?, pollAnswer: PollAnswer?)

This object represents an incoming update.

UploadStickerFileRequest

common

data class UploadStickerFileRequest(userId: Int, pngSticker: String)

Request body for uploadStickerFile

User

common

data class User(id: Int, isBot: Boolean, firstName: String, lastName: String?, username: String?, languageCode: String?, canJoinGroups: Boolean, canReadAllGroupMessages: Boolean, supportsInlineQueries: Boolean)

This object represents a Telegram user or bot.

UserProfilePhotos

common

data class UserProfilePhotos(totalCount: Int, photos: List<List<PhotoSize>>)

This object represent a user's profile pictures.

Venue

common

data class Venue(location: Location, title: String, address: String, foursquareId: String?, foursquareType: String?, googlePlaceId: String?, googlePlaceType: String?)

This object represents a venue.

Video

common

data class Video(fileId: String, fileUniqueId: String, width: Int, height: Int, duration: Int, thumb: PhotoSize?, fileName: String?, mimeType: String?, fileSize: Int?)

This object represents a video file.

VideoNote

common

data class VideoNote(fileId: String, fileUniqueId: String, length: Int, duration: Int, thumb: PhotoSize?, fileSize: Int?)

This object represents a video message (available in Telegram apps as of v.4.0).

Voice

common

data class Voice(fileId: String, fileUniqueId: String, duration: Int, mimeType: String?, fileSize: Int?)

This object represents a voice note.

WebhookInfo

common

data class WebhookInfo(url: String, hasCustomCertificate: Boolean, pendingUpdateCount: Int, ipAddress: String?, lastErrorDate: Int?, lastErrorMessage: String?, maxConnections: Int?, allowedUpdates: List<String>)

Contains information about the current status of a webhook.

Functions

addStickerToSet

common

suspend fun TelegramBotApiClient.addStickerToSet(requestBody: AddStickerToSetRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.addStickerToSet(userId: Int, name: String, pngSticker: String? = null, tgsSticker: String? = null, emojis: String, maskPosition: MaskPosition? = null): TelegramResponse<Boolean>

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

answerCallbackQuery

common

suspend fun TelegramBotApiClient.answerCallbackQuery(requestBody: AnswerCallbackQueryRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.answerCallbackQuery(callbackQueryId: String, text: String? = null, showAlert: Boolean = false, url: String? = null, cacheTime: Int? = null): TelegramResponse<Boolean>

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

answerInlineQuery

common

suspend fun TelegramBotApiClient.answerInlineQuery(requestBody: AnswerInlineQueryRequest): TelegramResponse<Boolean>

Use this method to send answers to an inline query.

suspend fun TelegramBotApiClient.answerInlineQuery(inlineQueryId: String, results: List<InlineQueryResult> = emptyList(), cacheTime: Int? = null, isPersonal: Boolean = false, nextOffset: String? = null, switchPmText: String? = null, switchPmParameter: String? = null): TelegramResponse<Boolean>

Use this method to send answers to an inline query.

answerPreCheckoutQuery

common

suspend fun TelegramBotApiClient.answerPreCheckoutQuery(requestBody: AnswerPreCheckoutQueryRequest): TelegramResponse<Boolean>

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.

suspend fun TelegramBotApiClient.answerPreCheckoutQuery(preCheckoutQueryId: String, ok: Boolean, errorMessage: String? = null): TelegramResponse<Boolean>

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.

answerShippingQuery

common

suspend fun TelegramBotApiClient.answerShippingQuery(requestBody: AnswerShippingQueryRequest): TelegramResponse<Boolean>

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.

suspend fun TelegramBotApiClient.answerShippingQuery(shippingQueryId: String, ok: Boolean, shippingOptions: List<ShippingOption> = emptyList(), errorMessage: String? = null): TelegramResponse<Boolean>

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.

common

suspend fun TelegramBotApiClient.close(): TelegramResponse<Boolean>

Use this method to close the bot instance before moving it from one local server to another.

copyMessage

common

suspend fun TelegramBotApiClient.copyMessage(requestBody: CopyMessageRequest): TelegramResponse<MessageId>

Use this method to copy messages of any kind.

suspend fun TelegramBotApiClient.copyMessage(chatId: Int, fromChatId: Int, messageId: Int, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<MessageId>

Use this method to copy messages of any kind.

createNewStickerSet

common

suspend fun TelegramBotApiClient.createNewStickerSet(requestBody: CreateNewStickerSetRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.createNewStickerSet(userId: Int, name: String, title: String, pngSticker: String? = null, tgsSticker: String? = null, emojis: String, containsMasks: Boolean = false, maskPosition: MaskPosition? = null): TelegramResponse<Boolean>

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

deleteChatPhoto

common

suspend fun TelegramBotApiClient.deleteChatPhoto(requestBody: DeleteChatPhotoRequest): TelegramResponse<Boolean>

Use this method to delete a chat photo.

suspend fun TelegramBotApiClient.deleteChatPhoto(chatId: Int): TelegramResponse<Boolean>

Use this method to delete a chat photo.

deleteChatStickerSet

common

suspend fun TelegramBotApiClient.deleteChatStickerSet(requestBody: DeleteChatStickerSetRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.deleteChatStickerSet(chatId: Int): TelegramResponse<Boolean>

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

deleteMessage

common

suspend fun TelegramBotApiClient.deleteMessage(requestBody: DeleteMessageRequest): TelegramResponse<Boolean>

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.

suspend fun TelegramBotApiClient.deleteMessage(chatId: Int, messageId: Int): TelegramResponse<Boolean>

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.

deleteStickerFromSet

common

suspend fun TelegramBotApiClient.deleteStickerFromSet(requestBody: DeleteStickerFromSetRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.deleteStickerFromSet(sticker: String): TelegramResponse<Boolean>

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

deleteWebhook

common

suspend fun TelegramBotApiClient.deleteWebhook(requestBody: DeleteWebhookRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.deleteWebhook(dropPendingUpdates: Boolean = false): TelegramResponse<Boolean>

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

editMessageCaption

common

suspend fun TelegramBotApiClient.editMessageCaption(requestBody: EditMessageCaptionRequest): TelegramResponse<Message>

Use this method to edit captions of messages.

suspend fun TelegramBotApiClient.editMessageCaption(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

Use this method to edit captions of messages.

editMessageLiveLocation

common

suspend fun TelegramBotApiClient.editMessageLiveLocation(requestBody: EditMessageLiveLocationRequest): TelegramResponse<Message>

Use this method to edit live location messages.

suspend fun TelegramBotApiClient.editMessageLiveLocation(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, latitude: Float, longitude: Float, horizontalAccuracy: Float? = null, heading: Int? = null, proximityAlertRadius: Int? = null, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

Use this method to edit live location messages.

editMessageMedia

common

suspend fun TelegramBotApiClient.editMessageMedia(requestBody: EditMessageMediaRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.editMessageMedia(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, media: InputMedia, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

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

editMessageReplyMarkup

common

suspend fun TelegramBotApiClient.editMessageReplyMarkup(requestBody: EditMessageReplyMarkupRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.editMessageReplyMarkup(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

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

editMessageText

common

suspend fun TelegramBotApiClient.editMessageText(requestBody: EditMessageTextRequest): TelegramResponse<Message>

Use this method to edit text and game messages.

suspend fun TelegramBotApiClient.editMessageText(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, text: String, parseMode: String? = null, entities: List<MessageEntity> = emptyList(), disableWebPagePreview: Boolean = false, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

Use this method to edit text and game messages.

exportChatInviteLink

common

suspend fun TelegramBotApiClient.exportChatInviteLink(requestBody: ExportChatInviteLinkRequest): TelegramResponse<String>

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

suspend fun TelegramBotApiClient.exportChatInviteLink(chatId: Int): TelegramResponse<String>

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

forwardMessage

common

suspend fun TelegramBotApiClient.forwardMessage(requestBody: ForwardMessageRequest): TelegramResponse<Message>

Use this method to forward messages of any kind.

suspend fun TelegramBotApiClient.forwardMessage(chatId: Int, fromChatId: Int, disableNotification: Boolean = false, messageId: Int): TelegramResponse<Message>

Use this method to forward messages of any kind.

getChat

common

suspend fun TelegramBotApiClient.getChat(requestBody: GetChatRequest): TelegramResponse<Chat>

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

suspend fun TelegramBotApiClient.getChat(chatId: Int): TelegramResponse<Chat>

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

getChatAdministrators

common

suspend fun TelegramBotApiClient.getChatAdministrators(requestBody: GetChatAdministratorsRequest): TelegramResponse<List<ChatMember>>

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

suspend fun TelegramBotApiClient.getChatAdministrators(chatId: Int): TelegramResponse<List<ChatMember>>

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

getChatMember

common

suspend fun TelegramBotApiClient.getChatMember(requestBody: GetChatMemberRequest): TelegramResponse<ChatMember>

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

suspend fun TelegramBotApiClient.getChatMember(chatId: Int, userId: Int): TelegramResponse<ChatMember>

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

getChatMembersCount

common

suspend fun TelegramBotApiClient.getChatMembersCount(requestBody: GetChatMembersCountRequest): TelegramResponse<Int>

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

suspend fun TelegramBotApiClient.getChatMembersCount(chatId: Int): TelegramResponse<Int>

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

getFile

common

suspend fun TelegramBotApiClient.getFile(requestBody: GetFileRequest): TelegramResponse<File>

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

suspend fun TelegramBotApiClient.getFile(fileId: String): TelegramResponse<File>

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

getGameHighScores

common

suspend fun TelegramBotApiClient.getGameHighScores(requestBody: GetGameHighScoresRequest): TelegramResponse<List<GameHighScore>>

Use this method to get data for high score tables.

suspend fun TelegramBotApiClient.getGameHighScores(userId: Int, chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null): TelegramResponse<List<GameHighScore>>

Use this method to get data for high score tables.

getMe

common

suspend fun TelegramBotApiClient.getMe(): TelegramResponse<User>

A simple method for testing your bot's auth token.

getMyCommands

common

suspend fun TelegramBotApiClient.getMyCommands(): TelegramResponse<List<BotCommand>>

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

getStickerSet

common

suspend fun TelegramBotApiClient.getStickerSet(requestBody: GetStickerSetRequest): TelegramResponse<StickerSet>

Use this method to get a sticker set.

suspend fun TelegramBotApiClient.getStickerSet(name: String): TelegramResponse<StickerSet>

Use this method to get a sticker set.

getUpdates

common

suspend fun TelegramBotApiClient.getUpdates(requestBody: GetUpdatesRequest): TelegramResponse<List<Update>>

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

suspend fun TelegramBotApiClient.getUpdates(offset: Int? = null, limit: Int? = null, timeout: Int? = null, allowedUpdates: List<String> = emptyList()): TelegramResponse<List<Update>>

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

getUserProfilePhotos

common

suspend fun TelegramBotApiClient.getUserProfilePhotos(requestBody: GetUserProfilePhotosRequest): TelegramResponse<UserProfilePhotos>

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

suspend fun TelegramBotApiClient.getUserProfilePhotos(userId: Int, offset: Int? = null, limit: Int? = null): TelegramResponse<UserProfilePhotos>

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

getWebhookInfo

common

suspend fun TelegramBotApiClient.getWebhookInfo(): TelegramResponse<WebhookInfo>

Use this method to get current webhook status.

kickChatMember

common

suspend fun TelegramBotApiClient.kickChatMember(requestBody: KickChatMemberRequest): TelegramResponse<Boolean>

Use this method to kick a user from a group, a supergroup or a channel.

suspend fun TelegramBotApiClient.kickChatMember(chatId: Int, userId: Int, untilDate: Int? = null): TelegramResponse<Boolean>

Use this method to kick a user from a group, a supergroup or a channel.

leaveChat

common

suspend fun TelegramBotApiClient.leaveChat(requestBody: LeaveChatRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.leaveChat(chatId: Int): TelegramResponse<Boolean>

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

logOut

common

suspend fun TelegramBotApiClient.logOut(): TelegramResponse<Boolean>

Use this method to log out from the cloud Bot API server before launching the bot locally.

pinChatMessage

common

suspend fun TelegramBotApiClient.pinChatMessage(requestBody: PinChatMessageRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.pinChatMessage(chatId: Int, messageId: Int, disableNotification: Boolean = false): TelegramResponse<Boolean>

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

promoteChatMember

common

suspend fun TelegramBotApiClient.promoteChatMember(requestBody: PromoteChatMemberRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.promoteChatMember(chatId: Int, userId: Int, isAnonymous: Boolean = false, canChangeInfo: Boolean = false, canPostMessages: Boolean = false, canEditMessages: Boolean = false, canDeleteMessages: Boolean = false, canInviteUsers: Boolean = false, canRestrictMembers: Boolean = false, canPinMessages: Boolean = false, canPromoteMembers: Boolean = false): TelegramResponse<Boolean>

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

restrictChatMember

common

suspend fun TelegramBotApiClient.restrictChatMember(requestBody: RestrictChatMemberRequest): TelegramResponse<Boolean>

Use this method to restrict a user in a supergroup.

suspend fun TelegramBotApiClient.restrictChatMember(chatId: Int, userId: Int, permissions: ChatPermissions, untilDate: Int? = null): TelegramResponse<Boolean>

Use this method to restrict a user in a supergroup.

sendAnimation

common

suspend fun TelegramBotApiClient.sendAnimation(requestBody: SendAnimationRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendAnimation(chatId: Int, animation: String, duration: Int? = null, width: Int? = null, height: Int? = null, thumb: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

sendAudio

common

suspend fun TelegramBotApiClient.sendAudio(requestBody: SendAudioRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendAudio(chatId: Int, audio: String, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), duration: Int? = null, performer: String? = null, title: String? = null, thumb: String? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

sendChatAction

common

suspend fun TelegramBotApiClient.sendChatAction(requestBody: SendChatActionRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.sendChatAction(chatId: Int, action: String): TelegramResponse<Boolean>

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

sendContact

common

suspend fun TelegramBotApiClient.sendContact(requestBody: SendContactRequest): TelegramResponse<Message>

Use this method to send phone contacts.

suspend fun TelegramBotApiClient.sendContact(chatId: Int, phoneNumber: String, firstName: String, lastName: String? = null, vcard: String? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send phone contacts.

sendDice

common

suspend fun TelegramBotApiClient.sendDice(requestBody: SendDiceRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendDice(chatId: Int, emoji: String? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

sendDocument

common

suspend fun TelegramBotApiClient.sendDocument(requestBody: SendDocumentRequest): TelegramResponse<Message>

Use this method to send general files.

suspend fun TelegramBotApiClient.sendDocument(chatId: Int, document: String, thumb: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), disableContentTypeDetection: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send general files.

sendGame

common

suspend fun TelegramBotApiClient.sendGame(requestBody: SendGameRequest): TelegramResponse<Message>

Use this method to send a game.

suspend fun TelegramBotApiClient.sendGame(chatId: Int, gameShortName: String, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

Use this method to send a game.

sendInvoice

common

suspend fun TelegramBotApiClient.sendInvoice(requestBody: SendInvoiceRequest): TelegramResponse<Message>

Use this method to send invoices.

suspend fun TelegramBotApiClient.sendInvoice(chatId: Int, title: String, description: String, payload: String, providerToken: String, startParameter: String, currency: String, prices: List<LabeledPrice> = emptyList(), providerData: String? = null, photoUrl: String? = null, photoSize: Int? = null, photoWidth: Int? = null, photoHeight: Int? = null, needName: Boolean = false, needPhoneNumber: Boolean = false, needEmail: Boolean = false, needShippingAddress: Boolean = false, sendPhoneNumberToProvider: Boolean = false, sendEmailToProvider: Boolean = false, isFlexible: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

Use this method to send invoices.

sendLocation

common

suspend fun TelegramBotApiClient.sendLocation(requestBody: SendLocationRequest): TelegramResponse<Message>

Use this method to send point on the map.

suspend fun TelegramBotApiClient.sendLocation(chatId: Int, latitude: Float, longitude: Float, horizontalAccuracy: Float? = null, livePeriod: Int? = null, heading: Int? = null, proximityAlertRadius: Int? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send point on the map.

sendMediaGroup

common

suspend fun TelegramBotApiClient.sendMediaGroup(requestBody: SendMediaGroupRequest): TelegramResponse<List<Message>>

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

suspend fun TelegramBotApiClient.sendMediaGroup(chatId: Int, media: List<InputMedia> = emptyList(), disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false): TelegramResponse<List<Message>>

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

sendMessage

common

suspend fun TelegramBotApiClient.sendMessage(requestBody: SendMessageRequest): TelegramResponse<Message>

Use this method to send text messages.

suspend fun TelegramBotApiClient.sendMessage(chatId: Int, text: String, parseMode: String? = null, entities: List<MessageEntity> = emptyList(), disableWebPagePreview: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send text messages.

sendPhoto

common

suspend fun TelegramBotApiClient.sendPhoto(requestBody: SendPhotoRequest): TelegramResponse<Message>

Use this method to send photos.

suspend fun TelegramBotApiClient.sendPhoto(chatId: Int, photo: String, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send photos.

sendPoll

common

suspend fun TelegramBotApiClient.sendPoll(requestBody: SendPollRequest): TelegramResponse<Message>

Use this method to send a native poll.

suspend fun TelegramBotApiClient.sendPoll(chatId: Int, question: String, options: List<String> = emptyList(), isAnonymous: Boolean = false, type: String? = null, allowsMultipleAnswers: Boolean = false, correctOptionId: Int? = null, explanation: String? = null, explanationParseMode: String? = null, explanationEntities: List<MessageEntity> = emptyList(), openPeriod: Int? = null, closeDate: Int? = null, isClosed: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send a native poll.

sendSticker

common

suspend fun TelegramBotApiClient.sendSticker(requestBody: SendStickerRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendSticker(chatId: Int, sticker: String, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

sendVenue

common

suspend fun TelegramBotApiClient.sendVenue(requestBody: SendVenueRequest): TelegramResponse<Message>

Use this method to send information about a venue.

suspend fun TelegramBotApiClient.sendVenue(chatId: Int, latitude: Float, longitude: Float, title: String, address: String, foursquareId: String? = null, foursquareType: String? = null, googlePlaceId: String? = null, googlePlaceType: String? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

Use this method to send information about a venue.

sendVideo

common

suspend fun TelegramBotApiClient.sendVideo(requestBody: SendVideoRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendVideo(chatId: Int, video: String, duration: Int? = null, width: Int? = null, height: Int? = null, thumb: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), supportsStreaming: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

sendVideoNote

common

suspend fun TelegramBotApiClient.sendVideoNote(requestBody: SendVideoNoteRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendVideoNote(chatId: Int, videoNote: String, duration: Int? = null, length: Int? = null, thumb: String? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

sendVoice

common

suspend fun TelegramBotApiClient.sendVoice(requestBody: SendVoiceRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendVoice(chatId: Int, voice: String, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), duration: Int? = null, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

setChatAdministratorCustomTitle

common

suspend fun TelegramBotApiClient.setChatAdministratorCustomTitle(requestBody: SetChatAdministratorCustomTitleRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setChatAdministratorCustomTitle(chatId: Int, userId: Int, customTitle: String): TelegramResponse<Boolean>

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

setChatDescription

common

suspend fun TelegramBotApiClient.setChatDescription(requestBody: SetChatDescriptionRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setChatDescription(chatId: Int, description: String? = null): TelegramResponse<Boolean>

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

setChatPermissions

common

suspend fun TelegramBotApiClient.setChatPermissions(requestBody: SetChatPermissionsRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setChatPermissions(chatId: Int, permissions: ChatPermissions): TelegramResponse<Boolean>

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

setChatPhoto

common

suspend fun TelegramBotApiClient.setChatPhoto(requestBody: SetChatPhotoRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setChatPhoto(chatId: Int, photo: String): TelegramResponse<Boolean>

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

setChatStickerSet

common

suspend fun TelegramBotApiClient.setChatStickerSet(requestBody: SetChatStickerSetRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setChatStickerSet(chatId: Int, stickerSetName: String): TelegramResponse<Boolean>

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

setChatTitle

common

suspend fun TelegramBotApiClient.setChatTitle(requestBody: SetChatTitleRequest): TelegramResponse<Boolean>

Use this method to change the title of a chat.

suspend fun TelegramBotApiClient.setChatTitle(chatId: Int, title: String): TelegramResponse<Boolean>

Use this method to change the title of a chat.

setGameScore

common

suspend fun TelegramBotApiClient.setGameScore(requestBody: SetGameScoreRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.setGameScore(userId: Int, score: Int, force: Boolean = false, disableEditMessage: Boolean = false, chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null): TelegramResponse<Message>

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

setMyCommands

common

suspend fun TelegramBotApiClient.setMyCommands(requestBody: SetMyCommandsRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setMyCommands(commands: List<BotCommand> = emptyList()): TelegramResponse<Boolean>

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

setPassportDataErrors

common

suspend fun TelegramBotApiClient.setPassportDataErrors(requestBody: SetPassportDataErrorsRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setPassportDataErrors(userId: Int, errors: List<PassportElementError> = emptyList()): TelegramResponse<Boolean>

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

setStickerPositionInSet

common

suspend fun TelegramBotApiClient.setStickerPositionInSet(requestBody: SetStickerPositionInSetRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setStickerPositionInSet(sticker: String, position: Int): TelegramResponse<Boolean>

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

setStickerSetThumb

common

suspend fun TelegramBotApiClient.setStickerSetThumb(requestBody: SetStickerSetThumbRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setStickerSetThumb(name: String, userId: Int, thumb: String? = null): TelegramResponse<Boolean>

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

setWebhook

common

suspend fun TelegramBotApiClient.setWebhook(requestBody: SetWebhookRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.setWebhook(url: String, certificate: String? = null, ipAddress: String? = null, maxConnections: Int? = null, allowedUpdates: List<String> = emptyList(), dropPendingUpdates: Boolean = false): TelegramResponse<Boolean>

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

stopMessageLiveLocation

common

suspend fun TelegramBotApiClient.stopMessageLiveLocation(requestBody: StopMessageLiveLocationRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.stopMessageLiveLocation(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Message>

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

stopPoll

common

suspend fun TelegramBotApiClient.stopPoll(requestBody: StopPollRequest): TelegramResponse<Poll>

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

suspend fun TelegramBotApiClient.stopPoll(chatId: Int, messageId: Int, replyMarkup: InlineKeyboardMarkup? = null): TelegramResponse<Poll>

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

unbanChatMember

common

suspend fun TelegramBotApiClient.unbanChatMember(requestBody: UnbanChatMemberRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.unbanChatMember(chatId: Int, userId: Int, onlyIfBanned: Boolean = false): TelegramResponse<Boolean>

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

unpinAllChatMessages

common

suspend fun TelegramBotApiClient.unpinAllChatMessages(requestBody: UnpinAllChatMessagesRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.unpinAllChatMessages(chatId: Int): TelegramResponse<Boolean>

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

unpinChatMessage

common

suspend fun TelegramBotApiClient.unpinChatMessage(requestBody: UnpinChatMessageRequest): TelegramResponse<Boolean>

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

suspend fun TelegramBotApiClient.unpinChatMessage(chatId: Int, messageId: Int? = null): TelegramResponse<Boolean>

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

uploadStickerFile

common

suspend fun TelegramBotApiClient.uploadStickerFile(requestBody: UploadStickerFileRequest): TelegramResponse<File>

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

suspend fun TelegramBotApiClient.uploadStickerFile(userId: Int, pngSticker: String): TelegramResponse<File>

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