TgBot::Api Class Reference

Executes methods from the Telegram Bot API. More...

#include <Api.h>

Public Member Functions
	Api (std::string token, const HttpClient &httpClient, std::string url)
bool	addStickerToSet (std::int64_t userId, const std::string &name, std::shared_ptr< InputSticker > sticker) const
	Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.
bool	answerCallbackQuery (const std::string &callbackQueryId, const std::string &text="", bool showAlert=false, const std::string &url="", std::int32_t cacheTime=0) const
	Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
bool	answerChatJoinRequestQuery (const std::string &chatJoinRequestQueryId, const std::string &result) const
	Use this method to process a received chat join request query. Returns True on success.
std::shared_ptr< SentGuestMessage >	answerGuestQuery (const std::string &guestQueryId, std::shared_ptr< InlineQueryResult > result) const
	Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.
bool	answerInlineQuery (const std::string &inlineQueryId, const std::vector< std::shared_ptr< InlineQueryResult > > &results, std::int32_t cacheTime=300, bool isPersonal=false, const std::string &nextOffset="", std::shared_ptr< InlineQueryResultsButton > button=nullptr) const
	Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.
bool	answerPreCheckoutQuery (const std::string &preCheckoutQueryId, bool ok, const std::string &errorMessage="") const
	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. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
bool	answerShippingQuery (const std::string &shippingQueryId, bool ok, const std::vector< std::shared_ptr< ShippingOption > > &shippingOptions={ }, const std::string &errorMessage="") const
	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. Use this method to reply to shipping queries. On success, True is returned.
std::shared_ptr< SentWebAppMessage >	answerWebAppQuery (const std::string &webAppQueryId, std::shared_ptr< InlineQueryResult > result) const
	Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
bool	approveChatJoinRequest (std::variant< std::int64_t, std::string > chatId, std::int64_t userId) const
	Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
bool	approveSuggestedPost (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId, std::int32_t sendDate=0) const
	Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.
bool	banChatMember (std::variant< std::int64_t, std::string > chatId, std::int64_t userId, std::int32_t untilDate=0, bool revokeMessages=true) const
	Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
bool	banChatSenderChat (std::variant< std::int64_t, std::string > chatId, std::int64_t senderChatId) const
	Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
bool	close () const
	Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
bool	closeForumTopic (std::variant< std::int64_t, std::string > chatId, std::int32_t messageThreadId) const
	Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
bool	closeGeneralForumTopic (std::variant< std::int64_t, std::string > chatId) const
	Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
bool	convertGiftToStars (const std::string &businessConnectionId, const std::string &ownedGiftId) const
	Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.
std::shared_ptr< MessageId >	copyMessage (std::variant< std::int64_t, std::string > chatId, std::variant< std::int64_t, std::string > fromChatId, std::int32_t messageId, const std::string &caption="", const std::string &parseMode="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, bool disableNotification=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, bool protectContent=false, std::int32_t messageThreadId=0, bool allowPaidBroadcast=false, std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", bool showCaptionAboveMedia=false, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr, std::int32_t videoStartTimestamp=0) const
	Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_ids is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
std::vector< std::shared_ptr< MessageId > >	copyMessages (std::variant< std::int64_t, std::string > chatId, std::variant< std::int64_t, std::string > fromChatId, const std::vector< std::int32_t > &messageIds, std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, bool removeCaption=false, std::int64_t directMessagesTopicId=0) const
	Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_ids is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an Array of MessageId of the sent messages is returned.
std::shared_ptr< ChatInviteLink >	createChatInviteLink (std::variant< std::int64_t, std::string > chatId, std::int32_t expireDate=0, std::int32_t memberLimit=0, const std::string &name="", bool createsJoinRequest=false) const
	Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
std::shared_ptr< ChatInviteLink >	createChatSubscriptionInviteLink (std::variant< std::int64_t, std::string > chatId, std::int32_t subscriptionPeriod, std::int32_t subscriptionPrice, const std::string &name="") const
	Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.
std::shared_ptr< ForumTopic >	createForumTopic (std::variant< std::int64_t, std::string > chatId, const std::string &name, std::int32_t iconColor=0, const std::string &iconCustomEmojiId="") const
	Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.
std::string	createInvoiceLink (const std::string &title, const std::string &description, const std::string &payload, const std::string &providerToken, const std::string &currency, const std::vector< std::shared_ptr< LabeledPrice > > &prices, std::int32_t maxTipAmount=0, const std::vector< std::int32_t > &suggestedTipAmounts={ }, const std::string &providerData="", const std::string &photoUrl="", std::int32_t photoSize=0, std::int32_t photoWidth=0, std::int32_t photoHeight=0, bool needName=false, bool needPhoneNumber=false, bool needEmail=false, bool needShippingAddress=false, bool sendPhoneNumberToProvider=false, bool sendEmailToProvider=false, bool isFlexible=false, const std::string &businessConnectionId="", std::int32_t subscriptionPeriod=0) const
	Use this method to create a link for an invoice. Returns the created invoice link as String on success.
bool	createNewStickerSet (std::int64_t userId, const std::string &name, const std::string &title, const std::vector< std::shared_ptr< InputSticker > > &stickers, Sticker::Type stickerType=Sticker::Type::Regular, bool needsRepainting=false) const
	Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.
bool	declineChatJoinRequest (std::variant< std::int64_t, std::string > chatId, std::int64_t userId) const
	Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
bool	declineSuggestedPost (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId, const std::string &comment="") const
	Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.
bool	deleteAllMessageReactions (std::variant< std::int64_t, std::string > chatId, std::int64_t actorChatId=0, std::int64_t userId=0) const
	Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success. The following methods and objects allow your bot to handle stickers and sticker sets.
bool	deleteBusinessMessages (const std::string &businessConnectionId, const std::vector< std::int32_t > &messageIds) const
	Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.
bool	deleteChatPhoto (std::variant< std::int64_t, std::string > chatId) const
	Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
bool	deleteChatStickerSet (std::variant< std::int64_t, std::string > chatId) const
	Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
bool	deleteEphemeralMessage (std::variant< std::int64_t, std::string > chatId, std::int32_t ephemeralMessageId, std::int64_t receiverUserId) const
	Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns True on success.
bool	deleteForumTopic (std::variant< std::int64_t, std::string > chatId, std::int32_t messageThreadId) const
	Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
bool	deleteMessage (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId) const
	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.- Service messages about a supergroup, channel, or forum topic creation can't be deleted.- 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 administrator right in a supergroup or a channel, it can delete any message there.- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.Returns True on success.
bool	deleteMessageReaction (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId, std::int64_t actorChatId=0, std::int64_t userId=0) const
	Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.
bool	deleteMessages (std::variant< std::int64_t, std::string > chatId, const std::vector< std::int32_t > &messageIds) const
	Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.
bool	deleteMyCommands (std::shared_ptr< BotCommandScope > scope=nullptr, const std::string &languageCode="") const
	Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
bool	deleteStickerFromSet (const std::string &sticker) const
	Use this method to delete a sticker from a set created by the bot. Returns True on success.
bool	deleteStickerSet (const std::string &name) const
	Use this method to delete a sticker set that was created by the bot. Returns True on success. The following methods and objects allow your bot to handle and send rich messages.
bool	deleteStory (const std::string &businessConnectionId, std::int32_t storyId) const
	Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.
bool	deleteWebhook (bool dropPendingUpdates=false) const
	Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
std::shared_ptr< ChatInviteLink >	editChatInviteLink (std::variant< std::int64_t, std::string > chatId, const std::string &inviteLink, std::int32_t expireDate=0, std::int32_t memberLimit=0, const std::string &name="", bool createsJoinRequest=false) const
	Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
std::shared_ptr< ChatInviteLink >	editChatSubscriptionInviteLink (std::variant< std::int64_t, std::string > chatId, const std::string &inviteLink, const std::string &name="") const
	Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.
bool	editEphemeralMessageCaption (std::variant< std::int64_t, std::string > chatId, std::int32_t ephemeralMessageId, std::int64_t receiverUserId, const std::string &caption="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, const std::string &parseMode="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr) const
	Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.
bool	editEphemeralMessageMedia (std::variant< std::int64_t, std::string > chatId, std::int32_t ephemeralMessageId, std::shared_ptr< InputMedia > media, std::int64_t receiverUserId, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr) const
	Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.
bool	editEphemeralMessageReplyMarkup (std::variant< std::int64_t, std::string > chatId, std::int32_t ephemeralMessageId, std::int64_t receiverUserId, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr) const
	Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.
bool	editEphemeralMessageText (std::variant< std::int64_t, std::string > chatId, std::int32_t ephemeralMessageId, std::int64_t receiverUserId, const std::string &text, const std::vector< std::shared_ptr< MessageEntity > > &entities={ }, std::shared_ptr< LinkPreviewOptions > linkPreviewOptions=nullptr, const std::string &parseMode="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr) const
	Use this method to edit an ephemeral text message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.
bool	editForumTopic (std::variant< std::int64_t, std::string > chatId, std::int32_t messageThreadId, const std::string &name="", const std::string &iconCustomEmojiId="") const
	Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
bool	editGeneralForumTopic (std::variant< std::int64_t, std::string > chatId, const std::string &name) const
	Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
std::shared_ptr< Message >	editMessageCaption (std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &caption="", const std::string &inlineMessageId="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, const std::string &parseMode="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, const std::string &businessConnectionId="", bool showCaptionAboveMedia=false) const
	Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
std::shared_ptr< Message >	editMessageChecklist (std::variant< std::int64_t, std::string > chatId, const std::string &businessConnectionId, std::shared_ptr< InputChecklist > checklist, std::int32_t messageId, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr) const
	Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
std::shared_ptr< Message >	editMessageLiveLocation (double latitude, double longitude, std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, double horizontalAccuracy=0, std::int32_t heading=0, std::int32_t proximityAlertRadius=0, const std::string &businessConnectionId="", std::int32_t livePeriod=0) const
	Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
std::shared_ptr< Message >	editMessageMedia (std::shared_ptr< InputMedia > media, std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, const std::string &businessConnectionId="") const
	Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
std::shared_ptr< Message >	editMessageReplyMarkup (std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, const std::string &businessConnectionId="") const
	Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
std::shared_ptr< Message >	editMessageText (const std::string &text="", std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="", const std::string &parseMode="", std::shared_ptr< LinkPreviewOptions > linkPreviewOptions=nullptr, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, const std::vector< std::shared_ptr< MessageEntity > > &entities={ }, const std::string &businessConnectionId="", std::shared_ptr< InputRichMessage > richMessage=nullptr) const
	Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
std::shared_ptr< Story >	editStory (const std::string &businessConnectionId, std::shared_ptr< InputStoryContent > content, std::int32_t storyId, const std::vector< std::shared_ptr< StoryArea > > &areas={ }, const std::string &caption="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, const std::string &parseMode="") const
	Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
bool	editUserStarSubscription (bool isCanceled, const std::string &telegramPaymentChargeId, std::int64_t userId) const
	Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.
std::string	exportChatInviteLink (std::variant< std::int64_t, std::string > chatId) const
	Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
std::shared_ptr< Message >	forwardMessage (std::variant< std::int64_t, std::string > chatId, std::variant< std::int64_t, std::string > fromChatId, std::int32_t messageId, bool disableNotification=false, bool protectContent=false, std::int32_t messageThreadId=0, std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr, std::int32_t videoStartTimestamp=0) const
	Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.
std::vector< std::shared_ptr< MessageId > >	forwardMessages (std::variant< std::int64_t, std::string > chatId, std::variant< std::int64_t, std::string > fromChatId, const std::vector< std::int32_t > &messageIds, std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, std::int64_t directMessagesTopicId=0) const
	Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an Array of MessageId of the sent messages is returned.
std::shared_ptr< Gifts >	getAvailableGifts () const
	Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.
std::shared_ptr< OwnedGifts >	getBusinessAccountGifts (const std::string &businessConnectionId, bool excludeFromBlockchain=false, bool excludeLimitedNonUpgradable=false, bool excludeLimitedUpgradable=false, bool excludeSaved=false, bool excludeUnique=false, bool excludeUnlimited=false, bool excludeUnsaved=false, std::int32_t limit=0, const std::string &offset="", bool sortByPrice=false) const
	Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.
std::shared_ptr< StarAmount >	getBusinessAccountStarBalance (const std::string &businessConnectionId) const
	Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.
std::shared_ptr< BusinessConnection >	getBusinessConnection (const std::string &businessConnectionId) const
	Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.
std::shared_ptr< ChatFullInfo >	getChat (std::variant< std::int64_t, std::string > chatId) const
	Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.
std::vector< std::shared_ptr< ChatMember > >	getChatAdministrators (std::variant< std::int64_t, std::string > chatId, bool returnBots=false) const
	Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.
std::shared_ptr< OwnedGifts >	getChatGifts (std::variant< std::int64_t, std::string > chatId, bool excludeFromBlockchain=false, bool excludeLimitedNonUpgradable=false, bool excludeLimitedUpgradable=false, bool excludeSaved=false, bool excludeUnique=false, bool excludeUnlimited=false, bool excludeUnsaved=false, std::int32_t limit=0, const std::string &offset="", bool sortByPrice=false) const
	Returns the gifts owned by a chat. Returns OwnedGifts on success.
std::shared_ptr< ChatMember >	getChatMember (std::variant< std::int64_t, std::string > chatId, std::int64_t userId) const
	Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.
std::int32_t	getChatMemberCount (std::variant< std::int64_t, std::string > chatId) const
	Use this method to get the number of members in a chat. Returns Integer on success.
std::shared_ptr< MenuButton >	getChatMenuButton (std::variant< std::int64_t, std::string > chatId={ }) const
	Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
std::vector< std::shared_ptr< Sticker > >	getCustomEmojiStickers (const std::vector< std::string > &customEmojiIds) const
	Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
std::shared_ptr< File >	getFile (const std::string &fileId) const
	Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
std::vector< std::shared_ptr< Sticker > >	getForumTopicIconStickers () const
	Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
std::vector< std::shared_ptr< GameHighScore > >	getGameHighScores (std::int64_t userId, std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="") const
	Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
std::shared_ptr< BotAccessSettings >	getManagedBotAccessSettings (std::int64_t userId) const
	Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.
std::string	getManagedBotToken (std::int64_t userId) const
	Use this method to get the token of a managed bot. Returns the token as String on success.
std::shared_ptr< User >	getMe () const
	A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
std::vector< std::shared_ptr< BotCommand > >	getMyCommands (std::shared_ptr< BotCommandScope > scope=nullptr, const std::string &languageCode="") const
	Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
std::shared_ptr< ChatAdministratorRights >	getMyDefaultAdministratorRights (bool forChannels=false) const
	Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
std::shared_ptr< BotDescription >	getMyDescription (const std::string &languageCode="") const
	Use this method to get the current bot description for the given user language. Returns BotDescription on success.
std::shared_ptr< BotName >	getMyName (const std::string &languageCode="") const
	Use this method to get the current bot name for the given user language. Returns BotName on success.
std::shared_ptr< BotShortDescription >	getMyShortDescription (const std::string &languageCode="") const
	Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
std::shared_ptr< StarAmount >	getMyStarBalance () const
	A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.
std::shared_ptr< StarTransactions >	getStarTransactions (std::int32_t limit=0, std::int32_t offset=0) const
	Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.
std::shared_ptr< StickerSet >	getStickerSet (const std::string &name) const
	Use this method to get a sticker set. On success, a StickerSet object is returned.
std::vector< std::shared_ptr< Update > >	getUpdates (std::int32_t offset=0, std::int32_t limit=100, std::int32_t timeout=0, const std::vector< std::string > &allowedUpdates={ }) const
	Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
std::shared_ptr< UserChatBoosts >	getUserChatBoosts (std::variant< std::int64_t, std::string > chatId, std::int64_t userId) const
	Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.
std::shared_ptr< OwnedGifts >	getUserGifts (std::int64_t userId, bool excludeFromBlockchain=false, bool excludeLimitedNonUpgradable=false, bool excludeLimitedUpgradable=false, bool excludeUnique=false, bool excludeUnlimited=false, std::int32_t limit=0, const std::string &offset="", bool sortByPrice=false) const
	Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.
std::vector< std::shared_ptr< Message > >	getUserPersonalChatMessages (std::int32_t limit, std::int64_t userId) const
	Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an Array of Message objects is returned.
std::shared_ptr< UserProfileAudios >	getUserProfileAudios (std::int64_t userId, std::int32_t limit=0, std::int32_t offset=0) const
	Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.
std::shared_ptr< UserProfilePhotos >	getUserProfilePhotos (std::int64_t userId, std::int32_t offset=0, std::int32_t limit=100) const
	Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
std::shared_ptr< WebhookInfo >	getWebhookInfo () const
	Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
bool	giftPremiumSubscription (std::int32_t monthCount, std::int32_t starCount, std::int64_t userId, const std::string &text="", const std::vector< std::shared_ptr< MessageEntity > > &textEntities={ }, const std::string &textParseMode="") const
	Gifts a Telegram Premium subscription to the given user. Returns True on success.
bool	hideGeneralForumTopic (std::variant< std::int64_t, std::string > chatId) const
	Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
bool	leaveChat (std::variant< std::int64_t, std::string > chatId) const
	Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
bool	logOut () const
	Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
bool	pinChatMessage (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId, const std::string &businessConnectionId="", bool disableNotification=false) const
	Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.
std::shared_ptr< Story >	postStory (std::int32_t activePeriod, const std::string &businessConnectionId, std::shared_ptr< InputStoryContent > content, const std::vector< std::shared_ptr< StoryArea > > &areas={ }, const std::string &caption="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, const std::string &parseMode="", bool postToChatPage=false, bool protectContent=false) const
	Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
bool	promoteChatMember (std::variant< std::int64_t, std::string > chatId, std::int64_t userId, bool canChangeInfo=false, bool canPostMessages=false, bool canEditMessages=false, bool canDeleteMessages=false, bool canInviteUsers=false, bool canPinMessages=false, bool canPromoteMembers=false, bool isAnonymous=false, bool canManageChat=false, bool canManageVideoChats=false, bool canRestrictMembers=false, bool canManageTopics=false, bool canPostStories=false, bool canEditStories=false, bool canDeleteStories=false, bool canManageDirectMessages=false, bool canManageTags=false) const
	Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
bool	readBusinessMessage (std::variant< std::int64_t, std::string > chatId, const std::string &businessConnectionId, std::int32_t messageId) const
	Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.
bool	refundStarPayment (const std::string &telegramPaymentChargeId, std::int64_t userId) const
	Refunds a successful payment in Telegram Stars. Returns True on success.
bool	removeBusinessAccountProfilePhoto (const std::string &businessConnectionId, bool isPublic=false) const
	Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
bool	removeChatVerification (std::variant< std::int64_t, std::string > chatId) const
	Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.
bool	removeMyProfilePhoto () const
	Removes the profile photo of the bot. Requires no parameters. Returns True on success.
bool	removeUserVerification (std::int64_t userId) const
	Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.
bool	reopenForumTopic (std::variant< std::int64_t, std::string > chatId, std::int32_t messageThreadId) const
	Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
bool	reopenGeneralForumTopic (std::variant< std::int64_t, std::string > chatId) const
	Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
std::string	replaceManagedBotToken (std::int64_t userId) const
	Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.
bool	replaceStickerInSet (std::int64_t userId, const std::string &name, const std::string &oldSticker, std::shared_ptr< InputSticker > sticker) const
	Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.
std::shared_ptr< Story >	repostStory (std::int32_t activePeriod, const std::string &businessConnectionId, std::variant< std::int64_t, std::string > fromChatId, std::int32_t fromStoryId, bool postToChatPage=false, bool protectContent=false) const
	Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.
bool	restrictChatMember (std::variant< std::int64_t, std::string > chatId, std::int64_t userId, std::shared_ptr< ChatPermissions > permissions, std::int32_t untilDate=0, bool useIndependentChatPermissions=false) const
	Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
std::shared_ptr< ChatInviteLink >	revokeChatInviteLink (std::variant< std::int64_t, std::string > chatId, const std::string &inviteLink) const
	Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
std::shared_ptr< PreparedInlineMessage >	savePreparedInlineMessage (std::shared_ptr< InlineQueryResult > result, std::int64_t userId, bool allowBotChats=false, bool allowChannelChats=false, bool allowGroupChats=false, bool allowUserChats=false) const
	Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.
std::shared_ptr< PreparedKeyboardButton >	savePreparedKeyboardButton (std::shared_ptr< KeyboardButton > button, std::int64_t userId) const
	Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.
std::shared_ptr< Message >	sendAnimation (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > animation, std::int32_t duration=0, std::int32_t width=0, std::int32_t height=0, std::variant< std::shared_ptr< InputFile >, std::string > thumbnail={ }, const std::string &caption="", std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int32_t messageThreadId=0, bool protectContent=false, bool hasSpoiler=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, bool showCaptionAboveMedia=false, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
std::shared_ptr< Message >	sendAudio (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > audio, const std::string &caption="", std::int32_t duration=0, const std::string &performer="", const std::string &title="", std::variant< std::shared_ptr< InputFile >, std::string > thumbnail={ }, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.
bool	sendChatAction (std::variant< std::int64_t, std::string > chatId, const std::string &action, std::int32_t messageThreadId=0, const std::string &businessConnectionId="") const
	Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
bool	sendChatJoinRequestWebApp (const std::string &chatJoinRequestQueryId, const std::string &webAppUrl) const
	Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call answerChatJoinRequestQuery to resolve the join request query based on the user interaction with the Mini App. Returns True on success.
std::shared_ptr< Message >	sendChecklist (std::variant< std::int64_t, std::string > chatId, const std::string &businessConnectionId, std::shared_ptr< InputChecklist > checklist, bool disableNotification=false, const std::string &messageEffectId="", bool protectContent=false, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, std::shared_ptr< ReplyParameters > replyParameters=nullptr) const
	Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
std::shared_ptr< Message >	sendContact (std::variant< std::int64_t, std::string > chatId, const std::string &phoneNumber, const std::string &firstName, const std::string &lastName="", const std::string &vcard="", bool disableNotification=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send phone contacts. On success, the sent Message is returned.
std::shared_ptr< Message >	sendDice (std::variant< std::int64_t, std::string > chatId, bool disableNotification=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &emoji="", std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
std::shared_ptr< Message >	sendDocument (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > document, std::variant< std::shared_ptr< InputFile >, std::string > thumbnail={ }, const std::string &caption="", std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, bool disableContentTypeDetection=false, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
std::shared_ptr< Message >	sendGame (std::variant< std::int64_t, std::string > chatId, const std::string &gameShortName, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, bool disableNotification=false, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &messageEffectId="") const
	Use this method to send a game. On success, the sent Message is returned.
bool	sendGift (const std::string &giftId, std::variant< std::int64_t, std::string > chatId={ }, bool payForUpgrade=false, const std::string &text="", const std::vector< std::shared_ptr< MessageEntity > > &textEntities={ }, const std::string &textParseMode="", std::int64_t userId=0) const
	Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
std::shared_ptr< Message >	sendInvoice (std::variant< std::int64_t, std::string > chatId, const std::string &title, const std::string &description, const std::string &payload, const std::string &providerToken, const std::string &currency, const std::vector< std::shared_ptr< LabeledPrice > > &prices, const std::string &providerData="", const std::string &photoUrl="", std::int32_t photoSize=0, std::int32_t photoWidth=0, std::int32_t photoHeight=0, bool needName=false, bool needPhoneNumber=false, bool needEmail=false, bool needShippingAddress=false, bool sendPhoneNumberToProvider=false, bool sendEmailToProvider=false, bool isFlexible=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, bool disableNotification=false, std::int32_t messageThreadId=0, std::int32_t maxTipAmount=0, const std::vector< std::int32_t > &suggestedTipAmounts={ }, const std::string &startParameter="", bool protectContent=false, bool allowPaidBroadcast=false, std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send invoices. On success, the sent Message is returned.
std::shared_ptr< Message >	sendLivePhoto (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > livePhoto, std::variant< std::shared_ptr< InputFile >, std::string > photo, bool allowPaidBroadcast=false, const std::string &businessConnectionId="", const std::string &callbackQueryId="", const std::string &caption="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int64_t directMessagesTopicId=0, bool disableNotification=false, bool hasSpoiler=false, const std::string &messageEffectId="", std::int32_t messageThreadId=0, const std::string &parseMode="", bool protectContent=false, std::int64_t receiverUserId=0, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, std::shared_ptr< ReplyParameters > replyParameters=nullptr, bool showCaptionAboveMedia=false, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send live photos. On success, the sent Message is returned.
std::shared_ptr< Message >	sendLocation (std::variant< std::int64_t, std::string > chatId, double latitude, double longitude, std::int32_t livePeriod=0, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, bool disableNotification=false, double horizontalAccuracy=0, std::int32_t heading=0, std::int32_t proximityAlertRadius=0, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send point on the map. On success, the sent Message is returned.
std::vector< std::shared_ptr< Message > >	sendMediaGroup (std::variant< std::int64_t, std::string > chatId, const std::vector< std::variant< std::shared_ptr< InputMediaAudio >, std::shared_ptr< InputMediaDocument >, std::shared_ptr< InputMediaLivePhoto >, std::shared_ptr< InputMediaPhoto >, std::shared_ptr< InputMediaVideo > > > &media, bool disableNotification=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="") const
	Use this method to send a group of photos, live photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an Array of Message objects that were sent is returned.
std::shared_ptr< Message >	sendMessage (std::variant< std::int64_t, std::string > chatId, const std::string &text, std::shared_ptr< LinkPreviewOptions > linkPreviewOptions=nullptr, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &entities={ }, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send text messages. On success, the sent Message is returned.
bool	sendMessageDraft (std::variant< std::int64_t, std::string > chatId, std::int32_t draftId, const std::vector< std::shared_ptr< MessageEntity > > &entities={ }, std::int32_t messageThreadId=0, const std::string &parseMode="", const std::string &text="") const
	Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendMessage with the complete message to persist it in the user's chat. Returns True on success.
std::shared_ptr< Message >	sendPaidMedia (std::variant< std::int64_t, std::string > chatId, const std::vector< std::shared_ptr< InputPaidMedia > > &media, std::int32_t starCount, bool allowPaidBroadcast=false, const std::string &businessConnectionId="", const std::string &caption="", const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int64_t directMessagesTopicId=0, bool disableNotification=false, std::int32_t messageThreadId=0, const std::string &parseMode="", const std::string &payload="", bool protectContent=false, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, std::shared_ptr< ReplyParameters > replyParameters=nullptr, bool showCaptionAboveMedia=false, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send paid media. On success, the sent Message is returned.
std::shared_ptr< Message >	sendPhoto (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > photo, const std::string &caption="", std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int32_t messageThreadId=0, bool protectContent=false, bool hasSpoiler=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, bool showCaptionAboveMedia=false, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send photos. On success, the sent Message is returned.
std::shared_ptr< Message >	sendPoll (std::variant< std::int64_t, std::string > chatId, const std::string &question, const std::vector< std::shared_ptr< InputPollOption > > &options, bool disableNotification=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, bool isAnonymous=true, const std::string &type="", bool allowsMultipleAnswers=false, const std::string &explanation="", const std::string &explanationParseMode="", const std::vector< std::shared_ptr< MessageEntity > > &explanationEntities={ }, std::int32_t openPeriod=0, std::int32_t closeDate=0, bool isClosed=false, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowAddingOptions=false, bool allowPaidBroadcast=false, bool allowsRevoting=false, const std::vector< std::int32_t > &correctOptionIds={ }, const std::vector< std::string > &countryCodes={ }, const std::string &description="", const std::vector< std::shared_ptr< MessageEntity > > &descriptionEntities={ }, const std::string &descriptionParseMode="", std::shared_ptr< InputPollMedia > explanationMedia=nullptr, bool hideResultsUntilCloses=false, std::shared_ptr< InputPollMedia > media=nullptr, bool membersOnly=false, const std::string &messageEffectId="", const std::vector< std::shared_ptr< MessageEntity > > &questionEntities={ }, const std::string &questionParseMode="", bool shuffleOptions=false) const
	Use this method to send a native poll. On success, the sent Message is returned.
std::shared_ptr< Message >	sendRichMessage (std::variant< std::int64_t, std::string > chatId, std::shared_ptr< InputRichMessage > richMessage, bool allowPaidBroadcast=false, const std::string &businessConnectionId="", std::int64_t directMessagesTopicId=0, bool disableNotification=false, const std::string &messageEffectId="", std::int32_t messageThreadId=0, bool protectContent=false, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send rich messages. If the message contains a block with a media element, then the bot must have the right to send the media to the chat. On success, the sent Message is returned.
bool	sendRichMessageDraft (std::variant< std::int64_t, std::string > chatId, std::int32_t draftId, std::shared_ptr< InputRichMessage > richMessage, std::int32_t messageThreadId=0) const
	Use this method to stream a partial rich message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendRichMessage with the complete message to persist it in the user's chat. Returns True on success.
std::shared_ptr< Message >	sendSticker (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > sticker, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, bool disableNotification=false, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &emoji="", const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
std::shared_ptr< Message >	sendVenue (std::variant< std::int64_t, std::string > chatId, double latitude, double longitude, const std::string &title, const std::string &address, const std::string &foursquareId="", const std::string &foursquareType="", bool disableNotification=false, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &googlePlaceId="", const std::string &googlePlaceType="", std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send information about a venue. On success, the sent Message is returned.
std::shared_ptr< Message >	sendVideo (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > video, bool supportsStreaming=false, std::int32_t duration=0, std::int32_t width=0, std::int32_t height=0, std::variant< std::shared_ptr< InputFile >, std::string > thumbnail={ }, const std::string &caption="", std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int32_t messageThreadId=0, bool protectContent=false, bool hasSpoiler=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::variant< std::shared_ptr< InputFile >, std::string > cover={ }, std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, bool showCaptionAboveMedia=false, std::int32_t startTimestamp=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
std::shared_ptr< Message >	sendVideoNote (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > videoNote, std::shared_ptr< ReplyParameters > replyParameters=nullptr, bool disableNotification=false, std::int32_t duration=0, std::int32_t length=0, std::variant< std::shared_ptr< InputFile >, std::string > thumbnail={ }, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
std::shared_ptr< Message >	sendVoice (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > voice, const std::string &caption="", std::int32_t duration=0, std::shared_ptr< ReplyParameters > replyParameters=nullptr, std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup={ }, const std::string &parseMode="", bool disableNotification=false, const std::vector< std::shared_ptr< MessageEntity > > &captionEntities={ }, std::int32_t messageThreadId=0, bool protectContent=false, const std::string &businessConnectionId="", bool allowPaidBroadcast=false, const std::string &callbackQueryId="", std::int64_t directMessagesTopicId=0, const std::string &messageEffectId="", std::int64_t receiverUserId=0, std::shared_ptr< SuggestedPostParameters > suggestedPostParameters=nullptr) const
	Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
bool	setBusinessAccountBio (const std::string &businessConnectionId, const std::string &bio="") const
	Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.
bool	setBusinessAccountGiftSettings (std::shared_ptr< AcceptedGiftTypes > acceptedGiftTypes, const std::string &businessConnectionId, bool showGiftButton) const
	Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.
bool	setBusinessAccountName (const std::string &businessConnectionId, const std::string &firstName, const std::string &lastName="") const
	Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.
bool	setBusinessAccountProfilePhoto (const std::string &businessConnectionId, std::shared_ptr< InputProfilePhoto > photo, bool isPublic=false) const
	Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
bool	setBusinessAccountUsername (const std::string &businessConnectionId, const std::string &username="") const
	Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.
bool	setChatAdministratorCustomTitle (std::variant< std::int64_t, std::string > chatId, std::int64_t userId, const std::string &customTitle) const
	Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
bool	setChatDescription (std::variant< std::int64_t, std::string > chatId, const std::string &description="") const
	Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
bool	setChatMemberTag (std::variant< std::int64_t, std::string > chatId, std::int64_t userId, const std::string &tag="") const
	Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.
bool	setChatMenuButton (std::variant< std::int64_t, std::string > chatId={ }, std::shared_ptr< MenuButton > menuButton=nullptr) const
	Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
bool	setChatPermissions (std::variant< std::int64_t, std::string > chatId, std::shared_ptr< ChatPermissions > permissions, bool useIndependentChatPermissions=false) const
	Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
bool	setChatPhoto (std::variant< std::int64_t, std::string > chatId, std::variant< std::shared_ptr< InputFile >, std::string > photo) const
	Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
bool	setChatStickerSet (std::variant< std::int64_t, std::string > chatId, const std::string &stickerSetName) const
	Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
bool	setChatTitle (std::variant< std::int64_t, std::string > chatId, const std::string &title) const
	Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
bool	setCustomEmojiStickerSetThumbnail (const std::string &name, const std::string &customEmojiId="") const
	Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
std::shared_ptr< Message >	setGameScore (std::int64_t userId, std::int32_t score, bool force=false, bool disableEditMessage=false, std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="") const
	Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
bool	setManagedBotAccessSettings (bool isAccessRestricted, std::int64_t userId, const std::vector< std::int32_t > &addedUserIds={ }) const
	Use this method to change the access settings of a managed bot. Returns True on success.
bool	setMessageReaction (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId, const std::vector< std::shared_ptr< ReactionType > > &reaction={ }, bool isBig=false) const
	Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
bool	setMyCommands (const std::vector< std::shared_ptr< BotCommand > > &commands, std::shared_ptr< BotCommandScope > scope=nullptr, const std::string &languageCode="") const
	Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
bool	setMyDefaultAdministratorRights (std::shared_ptr< ChatAdministratorRights > rights=nullptr, bool forChannels=false) const
	Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
bool	setMyDescription (const std::string &description="", const std::string &languageCode="") const
	Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
bool	setMyName (const std::string &name="", const std::string &languageCode="") const
	Use this method to change the bot's name. Returns True on success.
bool	setMyProfilePhoto (std::shared_ptr< InputProfilePhoto > photo) const
	Changes the profile photo of the bot. Returns True on success.
bool	setMyShortDescription (const std::string &shortDescription="", const std::string &languageCode="") const
	Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
bool	setPassportDataErrors (std::int64_t userId, const std::vector< std::shared_ptr< PassportElementError > > &errors) const
	Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
bool	setStickerEmojiList (const std::string &sticker, const std::vector< std::string > &emojiList) const
	Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
bool	setStickerKeywords (const std::string &sticker, const std::vector< std::string > &keywords={ }) const
	Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
bool	setStickerMaskPosition (const std::string &sticker, std::shared_ptr< MaskPosition > maskPosition=nullptr) const
	Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
bool	setStickerPositionInSet (const std::string &sticker, std::int32_t position) const
	Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
bool	setStickerSetThumbnail (const std::string &name, std::int64_t userId, const std::string &format, std::variant< std::shared_ptr< InputFile >, std::string > thumbnail={ }) const
	Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
bool	setStickerSetTitle (const std::string &name, const std::string &title) const
	Use this method to set the title of a created sticker set. Returns True on success.
bool	setUserEmojiStatus (std::int64_t userId, const std::string &emojiStatusCustomEmojiId="", std::int32_t emojiStatusExpirationDate=0) const
	Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.
bool	setWebhook (const std::string &url, std::shared_ptr< InputFile > certificate=nullptr, std::int32_t maxConnections=40, const std::vector< std::string > &allowedUpdates={ }, const std::string &ipAddress="", bool dropPendingUpdates=false, const std::string &secretToken="") const
	Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram- Bot-Api-Secret-Token” with the secret token as content.
std::shared_ptr< Message >	stopMessageLiveLocation (std::variant< std::int64_t, std::string > chatId={ }, std::int32_t messageId=0, const std::string &inlineMessageId="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr, const std::string &businessConnectionId="") const
	Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
std::shared_ptr< Poll >	stopPoll (std::variant< std::int64_t, std::string > chatId, std::int32_t messageId, const std::string &businessConnectionId="", std::shared_ptr< InlineKeyboardMarkup > replyMarkup=nullptr) const
	Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
bool	transferBusinessAccountStars (const std::string &businessConnectionId, std::int32_t starCount) const
	Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.
bool	transferGift (const std::string &businessConnectionId, std::int64_t newOwnerChatId, const std::string &ownedGiftId, std::int32_t starCount=0) const
	Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.
bool	unbanChatMember (std::variant< std::int64_t, std::string > chatId, std::int64_t userId, bool onlyIfBanned=false) const
	Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
bool	unbanChatSenderChat (std::variant< std::int64_t, std::string > chatId, std::int64_t senderChatId) const
	Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
bool	unhideGeneralForumTopic (std::variant< std::int64_t, std::string > chatId) const
	Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
bool	unpinAllChatMessages (std::variant< std::int64_t, std::string > chatId) const
	Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.
bool	unpinAllForumTopicMessages (std::variant< std::int64_t, std::string > chatId, std::int32_t messageThreadId) const
	Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
bool	unpinAllGeneralForumTopicMessages (std::variant< std::int64_t, std::string > chatId) const
	Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
bool	unpinChatMessage (std::variant< std::int64_t, std::string > chatId, const std::string &businessConnectionId="", std::int32_t messageId=0) const
	Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.
bool	upgradeGift (const std::string &businessConnectionId, const std::string &ownedGiftId, bool keepOriginalDetails=false, std::int32_t starCount=0) const
	Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.
std::shared_ptr< File >	uploadStickerFile (std::int64_t userId, std::variant< std::shared_ptr< InputFile >, std::string > sticker, const std::string &stickerFormat) const
	Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.
bool	verifyChat (std::variant< std::int64_t, std::string > chatId, const std::string &customDescription="") const
	Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.
bool	verifyUser (std::int64_t userId, const std::string &customDescription="") const
	Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.
std::string	downloadFile (const std::string &filePath, const std::vector< HttpFormField > &fields={ }) const
	Downloads a Telegram file and returns its contents.

Public Attributes
const HttpClient &	_httpClient

Protected Member Functions
nlohmann::json	sendRequest (const std::string &method, const std::vector< HttpFormField > &fields) const

Protected Attributes
const std::string	_token
const std::string	_url

Friends
class	Bot

Detailed Description

Executes methods from the Telegram Bot API.

Method declarations and their documentation are generated from the official Telegram Bot API documentation.

Definition at line 30 of file Api.h.

Constructor & Destructor Documentation

Api()

TgBot::Api::Api	(	std::string	token,
		const HttpClient &	httpClient,
		std::string	url )

Member Function Documentation

addStickerToSet()

bool TgBot::Api::addStickerToSet	(	std::int64_t	userId,
		const std::string &	name,
		std::shared_ptr< InputSticker >	sticker ) const

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

Parameters

userId	User identifier of sticker set owner
name	Sticker set name
sticker	A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.

Returns

Telegram Bot API result.

answerCallbackQuery()

bool TgBot::Api::answerCallbackQuery	(	const std::string &	callbackQueryId,
		const std::string &	text = "",
		bool	showAlert = false,
		const std::string &	url = "",
		std::int32_t	cacheTime = 0 ) const

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Parameters

callbackQueryId	Unique identifier for the query to be answered
text	Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.
showAlert	If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to False.
url	URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
cacheTime	The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

Returns

Telegram Bot API result.

answerChatJoinRequestQuery()

bool TgBot::Api::answerChatJoinRequestQuery	(	const std::string &	chatJoinRequestQueryId,
		const std::string &	result ) const

Use this method to process a received chat join request query. Returns True on success.

Parameters

chatJoinRequestQueryId	Unique identifier of the join request query
result	Result of the query. Must be either “approve” to allow the user to join the chat, “decline” to disallow the user to join the chat, or “queue” to leave the decision to other administrators.

Returns

Telegram Bot API result.

answerGuestQuery()

std::shared_ptr< SentGuestMessage > TgBot::Api::answerGuestQuery	(	const std::string &	guestQueryId,
		std::shared_ptr< InlineQueryResult >	result ) const

Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.

Parameters

guestQueryId	Unique identifier for the query to be answered
result	A JSON-serialized object describing the message to be sent

Returns

Telegram Bot API result.

answerInlineQuery()

bool TgBot::Api::answerInlineQuery	(	const std::string &	inlineQueryId,
		const std::vector< std::shared_ptr< InlineQueryResult > > &	results,
		std::int32_t	cacheTime = 300,
		bool	isPersonal = false,
		const std::string &	nextOffset = "",
		std::shared_ptr< InlineQueryResultsButton >	button = nullptr ) const

Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.

Parameters

inlineQueryId	Unique identifier for the answered query
results	A JSON-serialized Array of results for the inline query
cacheTime	The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
isPersonal	Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
nextOffset	Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.
button	A JSON-serialized object describing a button to be shown above inline query results

Returns

Telegram Bot API result.

answerPreCheckoutQuery()

bool TgBot::Api::answerPreCheckoutQuery	(	const std::string &	preCheckoutQueryId,
		bool	ok,
		const std::string &	errorMessage = "" ) const

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. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Parameters

preCheckoutQueryId	Unique identifier for the query to be answered
ok	Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
errorMessage	Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

Returns

Telegram Bot API result.

answerShippingQuery()

bool TgBot::Api::answerShippingQuery	(	const std::string &	shippingQueryId,
		bool	ok,
		const std::vector< std::shared_ptr< ShippingOption > > &	shippingOptions = { },
		const std::string &	errorMessage = "" ) const

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. Use this method to reply to shipping queries. On success, True is returned.

Parameters

shippingQueryId	Unique identifier for the query to be answered
ok	Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
shippingOptions	Required if ok is True. A JSON-serialized Array of available shipping options.
errorMessage	Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.

Returns

Telegram Bot API result.

answerWebAppQuery()

std::shared_ptr< SentWebAppMessage > TgBot::Api::answerWebAppQuery	(	const std::string &	webAppQueryId,
		std::shared_ptr< InlineQueryResult >	result ) const

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

Parameters

webAppQueryId	Unique identifier for the query to be answered
result	A JSON-serialized object describing the message to be sent

Returns

Telegram Bot API result.

approveChatJoinRequest()

bool TgBot::Api::approveChatJoinRequest	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId ) const

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
userId	Unique identifier of the target user

Returns

Telegram Bot API result.

approveSuggestedPost()

bool TgBot::Api::approveSuggestedPost	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId,
		std::int32_t	sendDate = 0 ) const

Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

Parameters

chatId	Unique identifier for the target direct messages chat
messageId	Identifier of a suggested post message to approve
sendDate	Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future.

Returns

Telegram Bot API result.

banChatMember()

bool TgBot::Api::banChatMember	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId,
		std::int32_t	untilDate = 0,
		bool	revokeMessages = true ) const

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target group or username of the target supergroup or channel in the format @username
userId	Unique identifier of the target user
untilDate	Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
revokeMessages	Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

Returns

Telegram Bot API result.

banChatSenderChat()

bool TgBot::Api::banChatSenderChat	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	senderChatId ) const

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
senderChatId	Unique identifier of the target sender chat

Returns

Telegram Bot API result.

close()

bool TgBot::Api::close

(

)

const

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Returns

Telegram Bot API result.

closeForumTopic()

bool TgBot::Api::closeForumTopic	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageThreadId ) const

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

Telegram Bot API result.

closeGeneralForumTopic()

bool TgBot::Api::closeGeneralForumTopic

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup in the format @username

Returns

Telegram Bot API result.

convertGiftToStars()

bool TgBot::Api::convertGiftToStars	(	const std::string &	businessConnectionId,
		const std::string &	ownedGiftId ) const

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
ownedGiftId	Unique identifier of the regular gift that should be converted to Telegram Stars

Returns

Telegram Bot API result.

copyMessage()

std::shared_ptr< MessageId > TgBot::Api::copyMessage	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::int64_t, std::string >	fromChatId,
		std::int32_t	messageId,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		bool	disableNotification = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		bool	protectContent = false,
		std::int32_t	messageThreadId = 0,
		bool	allowPaidBroadcast = false,
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		bool	showCaptionAboveMedia = false,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr,
		std::int32_t	videoStartTimestamp = 0 ) const

Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_ids is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
fromChatId	Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)
messageId	Message identifier in the chat specified in from_chat_id
caption	New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.
parseMode	Mode for parsing entities in the new caption. See formatting options for more details.
captionEntities	A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode
disableNotification	Sends the message silently. Users will receive a notification with no sound.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
protectContent	Protects the contents of the sent message from forwarding and saving
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; only available when copying to private chats
showCaptionAboveMedia	Pass True if the caption must be shown above the message media. Ignored if a new caption isn't specified.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
videoStartTimestamp	New start timestamp for the copied video in the message

Returns

Telegram Bot API result.

copyMessages()

std::vector< std::shared_ptr< MessageId > > TgBot::Api::copyMessages	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::int64_t, std::string >	fromChatId,
		const std::vector< std::int32_t > &	messageIds,
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		bool	removeCaption = false,
		std::int64_t	directMessagesTopicId = 0 ) const

Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_ids is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an Array of MessageId of the sent messages is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
fromChatId	Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)
messageIds	A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
disableNotification	Sends the messages silently. Users will receive a notification with no sound.
protectContent	Protects the contents of the sent messages from forwarding and saving
removeCaption	Pass True to copy the messages without their captions
directMessagesTopicId	Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat

Returns

Telegram Bot API result.

createChatInviteLink()

std::shared_ptr< ChatInviteLink > TgBot::Api::createChatInviteLink	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	expireDate = 0,
		std::int32_t	memberLimit = 0,
		const std::string &	name = "",
		bool	createsJoinRequest = false ) const

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
expireDate	Point in time (Unix timestamp) when the link will expire
memberLimit	The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
name	Invite link name; 0-32 characters
createsJoinRequest	True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.

Returns

Telegram Bot API result.

createChatSubscriptionInviteLink()

std::shared_ptr< ChatInviteLink > TgBot::Api::createChatSubscriptionInviteLink	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	subscriptionPeriod,
		std::int32_t	subscriptionPrice,
		const std::string &	name = "" ) const

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.

Parameters

chatId	Unique identifier for the target channel chat or username of the target channel in the format @username
subscriptionPeriod	The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).
subscriptionPrice	The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000
name	Invite link name; 0-32 characters

Returns

Telegram Bot API result.

createForumTopic()

std::shared_ptr< ForumTopic > TgBot::Api::createForumTopic	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	name,
		std::int32_t	iconColor = 0,
		const std::string &	iconCustomEmojiId = "" ) const

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
name	Topic name, 1-128 characters
iconColor	Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F).
iconCustomEmojiId	Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.

Returns

Telegram Bot API result.

createInvoiceLink()

std::string TgBot::Api::createInvoiceLink	(	const std::string &	title,
		const std::string &	description,
		const std::string &	payload,
		const std::string &	providerToken,
		const std::string &	currency,
		const std::vector< std::shared_ptr< LabeledPrice > > &	prices,
		std::int32_t	maxTipAmount = 0,
		const std::vector< std::int32_t > &	suggestedTipAmounts = { },
		const std::string &	providerData = "",
		const std::string &	photoUrl = "",
		std::int32_t	photoSize = 0,
		std::int32_t	photoWidth = 0,
		std::int32_t	photoHeight = 0,
		bool	needName = false,
		bool	needPhoneNumber = false,
		bool	needEmail = false,
		bool	needShippingAddress = false,
		bool	sendPhoneNumberToProvider = false,
		bool	sendEmailToProvider = false,
		bool	isFlexible = false,
		const std::string &	businessConnectionId = "",
		std::int32_t	subscriptionPeriod = 0 ) const

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Parameters

title	Product name, 1-32 characters
description	Product description, 1-255 characters
payload	Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
providerToken	Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
currency	Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
prices	Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
maxTipAmount	The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
suggestedTipAmounts	A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
providerData	JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photoUrl	URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
photoSize	Photo size in bytes
photoWidth	Photo width
photoHeight	Photo height
needName	Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
needPhoneNumber	Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
needEmail	Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
needShippingAddress	Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
sendPhoneNumberToProvider	Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
sendEmailToProvider	Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
isFlexible	Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
businessConnectionId	Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
subscriptionPeriod	The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.

Returns

Telegram Bot API result.

createNewStickerSet()

bool TgBot::Api::createNewStickerSet	(	std::int64_t	userId,
		const std::string &	name,
		const std::string &	title,
		const std::vector< std::shared_ptr< InputSticker > > &	stickers,
		Sticker::Type	stickerType = Sticker::Type::Regular,
		bool	needsRepainting = false ) const

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

Parameters

userId	User identifier of created sticker set owner
name	Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.
title	Sticker set title, 1-64 characters
stickers	A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
stickerType	Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
needsRepainting	Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only

Returns

Telegram Bot API result.

declineChatJoinRequest()

bool TgBot::Api::declineChatJoinRequest	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId ) const

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
userId	Unique identifier of the target user

Returns

Telegram Bot API result.

declineSuggestedPost()

bool TgBot::Api::declineSuggestedPost	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId,
		const std::string &	comment = "" ) const

Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

Parameters

chatId	Unique identifier for the target direct messages chat
messageId	Identifier of a suggested post message to decline
comment	Comment for the creator of the suggested post; 0-128 characters

Returns

Telegram Bot API result.

deleteAllMessageReactions()

bool TgBot::Api::deleteAllMessageReactions	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	actorChatId = 0,
		std::int64_t	userId = 0 ) const

Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success. The following methods and objects allow your bot to handle stickers and sticker sets.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
actorChatId	Identifier of the chat whose reactions will be removed, if the reactions were added by a chat
userId	Identifier of the user whose reactions will be removed, if the reactions were added by a user

Returns

Telegram Bot API result.

deleteBusinessMessages()

bool TgBot::Api::deleteBusinessMessages	(	const std::string &	businessConnectionId,
		const std::vector< std::int32_t > &	messageIds ) const

Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection on behalf of which to delete the messages
messageIds	A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted.

Returns

Telegram Bot API result.

deleteChatPhoto()

bool TgBot::Api::deleteChatPhoto

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target channel in the format @username

Returns

Telegram Bot API result.

deleteChatStickerSet()

bool TgBot::Api::deleteChatStickerSet

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup in the format @username

Returns

Telegram Bot API result.

deleteEphemeralMessage()

bool TgBot::Api::deleteEphemeralMessage	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	ephemeralMessageId,
		std::int64_t	receiverUserId ) const

Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
ephemeralMessageId	Identifier of the ephemeral message to delete
receiverUserId	Identifier of the user who received the message

Returns

Telegram Bot API result.

deleteForumTopic()

bool TgBot::Api::deleteForumTopic	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageThreadId ) const

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

Telegram Bot API result.

deleteMessage()

bool TgBot::Api::deleteMessage	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId ) const

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.- Service messages about a supergroup, channel, or forum topic creation can't be deleted.- 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 administrator right in a supergroup or a channel, it can delete any message there.- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
messageId	Identifier of the message to delete

Returns

Telegram Bot API result.

deleteMessageReaction()

bool TgBot::Api::deleteMessageReaction	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId,
		std::int64_t	actorChatId = 0,
		std::int64_t	userId = 0 ) const

Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
messageId	Identifier of the target message
actorChatId	Identifier of the chat whose reaction will be removed, if the reaction was added by a chat
userId	Identifier of the user whose reaction will be removed, if the reaction was added by a user

Returns

Telegram Bot API result.

deleteMessages()

bool TgBot::Api::deleteMessages	(	std::variant< std::int64_t, std::string >	chatId,
		const std::vector< std::int32_t > &	messageIds ) const

Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
messageIds	A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted.

Returns

Telegram Bot API result.

deleteMyCommands()

bool TgBot::Api::deleteMyCommands	(	std::shared_ptr< BotCommandScope >	scope = nullptr,
		const std::string &	languageCode = "" ) const

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Parameters

scope	A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
languageCode	A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.

Returns

Telegram Bot API result.

deleteStickerFromSet()

bool TgBot::Api::deleteStickerFromSet

(

const std::string &

sticker

)

const

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Parameters

sticker

File identifier of the sticker

Returns

Telegram Bot API result.

deleteStickerSet()

bool TgBot::Api::deleteStickerSet

(

const std::string &

name

)

const

Use this method to delete a sticker set that was created by the bot. Returns True on success. The following methods and objects allow your bot to handle and send rich messages.

Parameters

name	Sticker set name

Returns

Telegram Bot API result.

deleteStory()

bool TgBot::Api::deleteStory	(	const std::string &	businessConnectionId,
		std::int32_t	storyId ) const

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
storyId	Unique identifier of the story to delete

Returns

Telegram Bot API result.

deleteWebhook()

bool TgBot::Api::deleteWebhook

(

bool

dropPendingUpdates = false

)

const

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

Parameters

dropPendingUpdates

Pass True to drop all pending updates

Returns

Telegram Bot API result.

downloadFile()

std::string TgBot::Api::downloadFile	(	const std::string &	filePath,
		const std::vector< HttpFormField > &	fields = { } ) const

Downloads a Telegram file and returns its contents.

editChatInviteLink()

std::shared_ptr< ChatInviteLink > TgBot::Api::editChatInviteLink	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	inviteLink,
		std::int32_t	expireDate = 0,
		std::int32_t	memberLimit = 0,
		const std::string &	name = "",
		bool	createsJoinRequest = false ) const

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
inviteLink	The invite link to edit
expireDate	Point in time (Unix timestamp) when the link will expire
memberLimit	The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
name	Invite link name; 0-32 characters
createsJoinRequest	True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.

Returns

Telegram Bot API result.

editChatSubscriptionInviteLink()

std::shared_ptr< ChatInviteLink > TgBot::Api::editChatSubscriptionInviteLink	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	inviteLink,
		const std::string &	name = "" ) const

Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
inviteLink	The invite link to edit
name	Invite link name; 0-32 characters

Returns

Telegram Bot API result.

editEphemeralMessageCaption()

bool TgBot::Api::editEphemeralMessageCaption	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	ephemeralMessageId,
		std::int64_t	receiverUserId,
		const std::string &	caption = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		const std::string &	parseMode = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr ) const

Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
ephemeralMessageId	Identifier of the ephemeral message to edit
receiverUserId	Identifier of the user who received the message
caption	New caption of the message, 0-1024 characters after entities parsing
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
parseMode	Mode for parsing entities in the message caption. See formatting options for more details.
replyMarkup	A JSON-serialized object for an inline keyboard

Returns

Telegram Bot API result.

editEphemeralMessageMedia()

bool TgBot::Api::editEphemeralMessageMedia	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	ephemeralMessageId,
		std::shared_ptr< InputMedia >	media,
		std::int64_t	receiverUserId,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr ) const

Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
ephemeralMessageId	Identifier of the ephemeral message to edit
media	A JSON-serialized object for the new media content of the message. A new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL.
receiverUserId	Identifier of the user who received the message
replyMarkup	A JSON-serialized object for an inline keyboard

Returns

Telegram Bot API result.

editEphemeralMessageReplyMarkup()

bool TgBot::Api::editEphemeralMessageReplyMarkup	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	ephemeralMessageId,
		std::int64_t	receiverUserId,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr ) const

Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
ephemeralMessageId	Identifier of the ephemeral message to edit
receiverUserId	Identifier of the user who received the message
replyMarkup	A JSON-serialized object for an inline keyboard

Returns

Telegram Bot API result.

editEphemeralMessageText()

bool TgBot::Api::editEphemeralMessageText	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	ephemeralMessageId,
		std::int64_t	receiverUserId,
		const std::string &	text,
		const std::vector< std::shared_ptr< MessageEntity > > &	entities = { },
		std::shared_ptr< LinkPreviewOptions >	linkPreviewOptions = nullptr,
		const std::string &	parseMode = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr ) const

Use this method to edit an ephemeral text message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
ephemeralMessageId	Identifier of the ephemeral message to edit
receiverUserId	Identifier of the user who received the message
text	New text of the message, 1-4096 characters after entity parsing
entities	A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
linkPreviewOptions	Link preview generation options for the message
parseMode	Mode for parsing entities in the message text. See formatting options for more details.
replyMarkup	A JSON-serialized object for an inline keyboard

Returns

Telegram Bot API result.

editForumTopic()

bool TgBot::Api::editForumTopic	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageThreadId,
		const std::string &	name = "",
		const std::string &	iconCustomEmojiId = "" ) const

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
messageThreadId	Unique identifier for the target message thread of the forum topic
name	New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept.
iconCustomEmojiId	New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept.

Returns

Telegram Bot API result.

editGeneralForumTopic()

bool TgBot::Api::editGeneralForumTopic	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	name ) const

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
name	New topic name, 1-128 characters

Returns

Telegram Bot API result.

editMessageCaption()

std::shared_ptr< Message > TgBot::Api::editMessageCaption	(	std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	caption = "",
		const std::string &	inlineMessageId = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		const std::string &	parseMode = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		const std::string &	businessConnectionId = "",
		bool	showCaptionAboveMedia = false ) const

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Parameters

chatId	Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
messageId	Required if inline_message_id is not specified. Identifier of the message to edit.
caption	New caption of the message, 0-1024 characters after entities parsing
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.
replyMarkup	A JSON-serialized object for an inline keyboard
parseMode	Mode for parsing entities in the message caption. See formatting options for more details.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent
showCaptionAboveMedia	Pass True if the caption must be shown above the message media. Supported only for animation, photo and video messages.

Returns

Telegram Bot API result.

editMessageChecklist()

std::shared_ptr< Message > TgBot::Api::editMessageChecklist	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	businessConnectionId,
		std::shared_ptr< InputChecklist >	checklist,
		std::int32_t	messageId,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr ) const

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot in the format @username
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
checklist	A JSON-serialized object for the new checklist
messageId	Unique identifier for the target message
replyMarkup	A JSON-serialized object for the new inline keyboard for the message

Returns

Telegram Bot API result.

editMessageLiveLocation()

std::shared_ptr< Message > TgBot::Api::editMessageLiveLocation	(	double	latitude,
		double	longitude,
		std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		double	horizontalAccuracy = 0,
		std::int32_t	heading = 0,
		std::int32_t	proximityAlertRadius = 0,
		const std::string &	businessConnectionId = "",
		std::int32_t	livePeriod = 0 ) const

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters

latitude	Latitude of new location
longitude	Longitude of new location
chatId	Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
messageId	Required if inline_message_id is not specified. Identifier of the message to edit.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.
replyMarkup	A JSON-serialized object for a new inline keyboard
horizontalAccuracy	The radius of uncertainty for the location, measured in meters; 0-1500
heading	Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximityAlertRadius	The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent
livePeriod	New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged.

Returns

Telegram Bot API result.

editMessageMedia()

std::shared_ptr< Message > TgBot::Api::editMessageMedia	(	std::shared_ptr< InputMedia >	media,
		std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		const std::string &	businessConnectionId = "" ) const

Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Parameters

media	A JSON-serialized object for the new media content of the message
chatId	Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
messageId	Required if inline_message_id is not specified. Identifier of the message to edit.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.
replyMarkup	A JSON-serialized object for a new inline keyboard
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent

Returns

Telegram Bot API result.

editMessageReplyMarkup()

std::shared_ptr< Message > TgBot::Api::editMessageReplyMarkup	(	std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		const std::string &	businessConnectionId = "" ) const

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Parameters

chatId	Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
messageId	Required if inline_message_id is not specified. Identifier of the message to edit.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.
replyMarkup	A JSON-serialized object for an inline keyboard
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent

Returns

Telegram Bot API result.

editMessageText()

std::shared_ptr< Message > TgBot::Api::editMessageText	(	const std::string &	text = "",
		std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const std::string &	parseMode = "",
		std::shared_ptr< LinkPreviewOptions >	linkPreviewOptions = nullptr,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		const std::vector< std::shared_ptr< MessageEntity > > &	entities = { },
		const std::string &	businessConnectionId = "",
		std::shared_ptr< InputRichMessage >	richMessage = nullptr ) const

Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Parameters

text	New text of the message, 1-4096 characters after entity parsing; required if rich_message isn't specified
chatId	Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
messageId	Required if inline_message_id is not specified. Identifier of the message to edit.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.
parseMode	Mode for parsing entities in the message text. See formatting options for more details.
linkPreviewOptions	Link preview generation options for the message
replyMarkup	A JSON-serialized object for an inline keyboard
entities	A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent
richMessage	New rich content of the message; required if text isn't specified. Direct upload of new files isn't supported when an inline message is edited.

Returns

Telegram Bot API result.

editStory()

std::shared_ptr< Story > TgBot::Api::editStory	(	const std::string &	businessConnectionId,
		std::shared_ptr< InputStoryContent >	content,
		std::int32_t	storyId,
		const std::vector< std::shared_ptr< StoryArea > > &	areas = { },
		const std::string &	caption = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		const std::string &	parseMode = "" ) const

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Parameters

businessConnectionId	Unique identifier of the business connection
content	Content of the story
storyId	Unique identifier of the story to edit
areas	A JSON-serialized list of clickable areas to be shown on the story
caption	Caption of the story, 0-2048 characters after entities parsing
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
parseMode	Mode for parsing entities in the story caption. See formatting options for more details.

Returns

Telegram Bot API result.

editUserStarSubscription()

bool TgBot::Api::editUserStarSubscription	(	bool	isCanceled,
		const std::string &	telegramPaymentChargeId,
		std::int64_t	userId ) const

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Parameters

isCanceled	Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.
telegramPaymentChargeId	Telegram payment identifier for the subscription
userId	Identifier of the user whose subscription will be edited

Returns

Telegram Bot API result.

exportChatInviteLink()

std::string TgBot::Api::exportChatInviteLink

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Parameters

chatId

Unique identifier for the target chat or username of the target channel in the format @username

Returns

Telegram Bot API result.

forwardMessage()

std::shared_ptr< Message > TgBot::Api::forwardMessage	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::int64_t, std::string >	fromChatId,
		std::int32_t	messageId,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	messageThreadId = 0,
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr,
		std::int32_t	videoStartTimestamp = 0 ) const

Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
fromChatId	Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)
messageId	Message identifier in the chat specified in from_chat_id
disableNotification	Sends the message silently. Users will receive a notification with no sound.
protectContent	Protects the contents of the forwarded message from forwarding and saving
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
directMessagesTopicId	Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; only available when forwarding to private chats
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only
videoStartTimestamp	New start timestamp for the forwarded video in the message

Returns

Telegram Bot API result.

forwardMessages()

std::vector< std::shared_ptr< MessageId > > TgBot::Api::forwardMessages	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::int64_t, std::string >	fromChatId,
		const std::vector< std::int32_t > &	messageIds,
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int64_t	directMessagesTopicId = 0 ) const

Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an Array of MessageId of the sent messages is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
fromChatId	Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)
messageIds	A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
disableNotification	Sends the messages silently. Users will receive a notification with no sound.
protectContent	Protects the contents of the forwarded messages from forwarding and saving
directMessagesTopicId	Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat

Returns

Telegram Bot API result.

getAvailableGifts()

std::shared_ptr< Gifts > TgBot::Api::getAvailableGifts

(

)

const

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

Returns

Telegram Bot API result.

getBusinessAccountGifts()

std::shared_ptr< OwnedGifts > TgBot::Api::getBusinessAccountGifts	(	const std::string &	businessConnectionId,
		bool	excludeFromBlockchain = false,
		bool	excludeLimitedNonUpgradable = false,
		bool	excludeLimitedUpgradable = false,
		bool	excludeSaved = false,
		bool	excludeUnique = false,
		bool	excludeUnlimited = false,
		bool	excludeUnsaved = false,
		std::int32_t	limit = 0,
		const std::string &	offset = "",
		bool	sortByPrice = false ) const

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

Parameters

businessConnectionId	Unique identifier of the business connection
excludeFromBlockchain	Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
excludeLimitedNonUpgradable	Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
excludeLimitedUpgradable	Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
excludeSaved	Pass True to exclude gifts that are saved to the account's profile page
excludeUnique	Pass True to exclude unique gifts
excludeUnlimited	Pass True to exclude gifts that can be purchased an unlimited number of times
excludeUnsaved	Pass True to exclude gifts that aren't saved to the account's profile page
limit	The maximum number of gifts to be returned; 1-100. Defaults to 100.
offset	Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
sortByPrice	Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

Returns

Telegram Bot API result.

getBusinessAccountStarBalance()

std::shared_ptr< StarAmount > TgBot::Api::getBusinessAccountStarBalance

(

const std::string &

businessConnectionId

)

const

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

Parameters

businessConnectionId

Unique identifier of the business connection

Returns

Telegram Bot API result.

getBusinessConnection()

std::shared_ptr< BusinessConnection > TgBot::Api::getBusinessConnection

(

const std::string &

businessConnectionId

)

const

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Parameters

businessConnectionId

Unique identifier of the business connection

Returns

Telegram Bot API result.

getChat()

std::shared_ptr< ChatFullInfo > TgBot::Api::getChat

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup or channel in the format @username

Returns

Telegram Bot API result.

getChatAdministrators()

std::vector< std::shared_ptr< ChatMember > > TgBot::Api::getChatAdministrators	(	std::variant< std::int64_t, std::string >	chatId,
		bool	returnBots = false ) const

Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup or channel in the format @username
returnBots	Pass True to additionally receive all bots that are administrators of the chat. By default, bots other than the current bot are omitted.

Returns

Telegram Bot API result.

getChatGifts()

std::shared_ptr< OwnedGifts > TgBot::Api::getChatGifts	(	std::variant< std::int64_t, std::string >	chatId,
		bool	excludeFromBlockchain = false,
		bool	excludeLimitedNonUpgradable = false,
		bool	excludeLimitedUpgradable = false,
		bool	excludeSaved = false,
		bool	excludeUnique = false,
		bool	excludeUnlimited = false,
		bool	excludeUnsaved = false,
		std::int32_t	limit = 0,
		const std::string &	offset = "",
		bool	sortByPrice = false ) const

Returns the gifts owned by a chat. Returns OwnedGifts on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
excludeFromBlockchain	Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
excludeLimitedNonUpgradable	Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
excludeLimitedUpgradable	Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
excludeSaved	Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.
excludeUnique	Pass True to exclude unique gifts
excludeUnlimited	Pass True to exclude gifts that can be purchased an unlimited number of times
excludeUnsaved	Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.
limit	The maximum number of gifts to be returned; 1-100. Defaults to 100.
offset	Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
sortByPrice	Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

Returns

Telegram Bot API result.

getChatMember()

std::shared_ptr< ChatMember > TgBot::Api::getChatMember	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId ) const

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup or channel in the format @username
userId	Unique identifier of the target user

Returns

Telegram Bot API result.

getChatMemberCount()

std::int32_t TgBot::Api::getChatMemberCount

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to get the number of members in a chat. Returns Integer on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup or channel in the format @username

Returns

Telegram Bot API result.

getChatMenuButton()

std::shared_ptr< MenuButton > TgBot::Api::getChatMenuButton

(

std::variant< std::int64_t, std::string >

chatId = { }

)

const

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

Parameters

chatId

Unique identifier for the target private chat. If not specified, the bot's default menu button will be returned.

Returns

Telegram Bot API result.

getCustomEmojiStickers()

std::vector< std::shared_ptr< Sticker > > TgBot::Api::getCustomEmojiStickers

(

const std::vector< std::string > &

customEmojiIds

)

const

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Parameters

customEmojiIds

A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

Returns

Telegram Bot API result.

getFile()

std::shared_ptr< File > TgBot::Api::getFile

(

const std::string &

fileId

)

const

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.

Parameters

fileId

File identifier to get information about

Returns

Telegram Bot API result.

getForumTopicIconStickers()

std::vector< std::shared_ptr< Sticker > > TgBot::Api::getForumTopicIconStickers

(

)

const

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Returns

Telegram Bot API result.

getGameHighScores()

std::vector< std::shared_ptr< GameHighScore > > TgBot::Api::getGameHighScores	(	std::int64_t	userId,
		std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "" ) const

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

Parameters

userId	Target user id
chatId	Required if inline_message_id is not specified. Unique identifier for the target chat.
messageId	Required if inline_message_id is not specified. Identifier of the sent message.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.

Returns

Telegram Bot API result.

getManagedBotAccessSettings()

std::shared_ptr< BotAccessSettings > TgBot::Api::getManagedBotAccessSettings

(

std::int64_t

userId

)

const

Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.

Parameters

userId

User identifier of the managed bot whose access settings will be returned

Returns

Telegram Bot API result.

getManagedBotToken()

std::string TgBot::Api::getManagedBotToken

(

std::int64_t

userId

)

const

Use this method to get the token of a managed bot. Returns the token as String on success.

Parameters

userId

User identifier of the managed bot whose token will be returned

Returns

Telegram Bot API result.

getMe()

std::shared_ptr< User > TgBot::Api::getMe

(

)

const

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Returns

Telegram Bot API result.

getMyCommands()

std::vector< std::shared_ptr< BotCommand > > TgBot::Api::getMyCommands	(	std::shared_ptr< BotCommandScope >	scope = nullptr,
		const std::string &	languageCode = "" ) const

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Parameters

scope	A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
languageCode	A two-letter ISO 639-1 language code or an empty string

Returns

Telegram Bot API result.

getMyDefaultAdministratorRights()

std::shared_ptr< ChatAdministratorRights > TgBot::Api::getMyDefaultAdministratorRights

(

bool

forChannels = false

)

const

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Parameters

forChannels

Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

Returns

Telegram Bot API result.

getMyDescription()

std::shared_ptr< BotDescription > TgBot::Api::getMyDescription

(

const std::string &

languageCode = ""

)

const

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Parameters

languageCode

A two-letter ISO 639-1 language code or an empty string

Returns

Telegram Bot API result.

getMyName()

std::shared_ptr< BotName > TgBot::Api::getMyName

(

const std::string &

languageCode = ""

)

const

Use this method to get the current bot name for the given user language. Returns BotName on success.

Parameters

languageCode

A two-letter ISO 639-1 language code or an empty string

Returns

Telegram Bot API result.

getMyShortDescription()

std::shared_ptr< BotShortDescription > TgBot::Api::getMyShortDescription

(

const std::string &

languageCode = ""

)

const

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Parameters

languageCode

A two-letter ISO 639-1 language code or an empty string

Returns

Telegram Bot API result.

getMyStarBalance()

std::shared_ptr< StarAmount > TgBot::Api::getMyStarBalance

(

)

const

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

Returns

Telegram Bot API result.

getStarTransactions()

std::shared_ptr< StarTransactions > TgBot::Api::getStarTransactions	(	std::int32_t	limit = 0,
		std::int32_t	offset = 0 ) const

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

Parameters

limit	The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.
offset	Number of transactions to skip in the response

Returns

Telegram Bot API result.

getStickerSet()

std::shared_ptr< StickerSet > TgBot::Api::getStickerSet

(

const std::string &

name

)

const

Use this method to get a sticker set. On success, a StickerSet object is returned.

Parameters

name	Name of the sticker set

Returns

Telegram Bot API result.

getUpdates()

std::vector< std::shared_ptr< Update > > TgBot::Api::getUpdates	(	std::int32_t	offset = 0,
		std::int32_t	limit = 100,
		std::int32_t	timeout = 0,
		const std::vector< std::string > &	allowedUpdates = { } ) const

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Parameters

offset	Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
limit	Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
timeout	Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
allowedUpdates	A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.

Returns

Telegram Bot API result.

getUserChatBoosts()

std::shared_ptr< UserChatBoosts > TgBot::Api::getUserChatBoosts	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId ) const

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Parameters

chatId	Unique identifier for the chat or username of the channel in the format @username
userId	Unique identifier of the target user

Returns

Telegram Bot API result.

getUserGifts()

std::shared_ptr< OwnedGifts > TgBot::Api::getUserGifts	(	std::int64_t	userId,
		bool	excludeFromBlockchain = false,
		bool	excludeLimitedNonUpgradable = false,
		bool	excludeLimitedUpgradable = false,
		bool	excludeUnique = false,
		bool	excludeUnlimited = false,
		std::int32_t	limit = 0,
		const std::string &	offset = "",
		bool	sortByPrice = false ) const

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

Parameters

userId	Unique identifier of the user
excludeFromBlockchain	Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
excludeLimitedNonUpgradable	Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
excludeLimitedUpgradable	Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
excludeUnique	Pass True to exclude unique gifts
excludeUnlimited	Pass True to exclude gifts that can be purchased an unlimited number of times
limit	The maximum number of gifts to be returned; 1-100. Defaults to 100.
offset	Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
sortByPrice	Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

Returns

Telegram Bot API result.

getUserPersonalChatMessages()

std::vector< std::shared_ptr< Message > > TgBot::Api::getUserPersonalChatMessages	(	std::int32_t	limit,
		std::int64_t	userId ) const

Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an Array of Message objects is returned.

Parameters

limit	The maximum number of messages to return; 1-20
userId	Unique identifier for the target user

Returns

Telegram Bot API result.

getUserProfileAudios()

std::shared_ptr< UserProfileAudios > TgBot::Api::getUserProfileAudios	(	std::int64_t	userId,
		std::int32_t	limit = 0,
		std::int32_t	offset = 0 ) const

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

Parameters

userId	Unique identifier of the target user
limit	Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.
offset	Sequential number of the first audio to be returned. By default, all audios are returned.

Returns

Telegram Bot API result.

getUserProfilePhotos()

std::shared_ptr< UserProfilePhotos > TgBot::Api::getUserProfilePhotos	(	std::int64_t	userId,
		std::int32_t	offset = 0,
		std::int32_t	limit = 100 ) const

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

Parameters

userId	Unique identifier of the target user
offset	Sequential number of the first photo to be returned. By default, all photos are returned.
limit	Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.

Returns

Telegram Bot API result.

getWebhookInfo()

std::shared_ptr< WebhookInfo > TgBot::Api::getWebhookInfo

(

)

const

Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

Returns

Telegram Bot API result.

giftPremiumSubscription()

bool TgBot::Api::giftPremiumSubscription	(	std::int32_t	monthCount,
		std::int32_t	starCount,
		std::int64_t	userId,
		const std::string &	text = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	textEntities = { },
		const std::string &	textParseMode = "" ) const

Gifts a Telegram Premium subscription to the given user. Returns True on success.

Parameters

monthCount	Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12
starCount	Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months
userId	Unique identifier of the target user who will receive a Telegram Premium subscription
text	Text that will be shown along with the service message about the subscription; 0-128 characters
textEntities	A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
textParseMode	Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.

Returns

Telegram Bot API result.

hideGeneralForumTopic()

bool TgBot::Api::hideGeneralForumTopic

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup in the format @username

Returns

Telegram Bot API result.

leaveChat()

bool TgBot::Api::leaveChat

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead.

Returns

Telegram Bot API result.

logOut()

bool TgBot::Api::logOut

(

)

const

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Returns

Telegram Bot API result.

pinChatMessage()

bool TgBot::Api::pinChatMessage	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId,
		const std::string &	businessConnectionId = "",
		bool	disableNotification = false ) const

Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
messageId	Identifier of a message to pin
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be pinned
disableNotification	Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

Returns

Telegram Bot API result.

postStory()

std::shared_ptr< Story > TgBot::Api::postStory	(	std::int32_t	activePeriod,
		const std::string &	businessConnectionId,
		std::shared_ptr< InputStoryContent >	content,
		const std::vector< std::shared_ptr< StoryArea > > &	areas = { },
		const std::string &	caption = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		const std::string &	parseMode = "",
		bool	postToChatPage = false,
		bool	protectContent = false ) const

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Parameters

activePeriod	Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
businessConnectionId	Unique identifier of the business connection
content	Content of the story
areas	A JSON-serialized list of clickable areas to be shown on the story
caption	Caption of the story, 0-2048 characters after entities parsing
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
parseMode	Mode for parsing entities in the story caption. See formatting options for more details.
postToChatPage	Pass True to keep the story accessible after it expires
protectContent	Pass True if the content of the story must be protected from forwarding and screenshotting

Returns

Telegram Bot API result.

promoteChatMember()

bool TgBot::Api::promoteChatMember	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId,
		bool	canChangeInfo = false,
		bool	canPostMessages = false,
		bool	canEditMessages = false,
		bool	canDeleteMessages = false,
		bool	canInviteUsers = false,
		bool	canPinMessages = false,
		bool	canPromoteMembers = false,
		bool	isAnonymous = false,
		bool	canManageChat = false,
		bool	canManageVideoChats = false,
		bool	canRestrictMembers = false,
		bool	canManageTopics = false,
		bool	canPostStories = false,
		bool	canEditStories = false,
		bool	canDeleteStories = false,
		bool	canManageDirectMessages = false,
		bool	canManageTags = false ) const

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
userId	Unique identifier of the target user
canChangeInfo	Pass True if the administrator can change chat title, photo and other settings
canPostMessages	Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
canEditMessages	Pass True if the administrator can edit messages of other users and can pin messages; for channels only
canDeleteMessages	Pass True if the administrator can delete messages of other users
canInviteUsers	Pass True if the administrator can invite new users to the chat
canPinMessages	Pass True if the administrator can pin messages; for supergroups only
canPromoteMembers	Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)
isAnonymous	Pass True if the administrator's presence in the chat is hidden
canManageChat	Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
canManageVideoChats	Pass True if the administrator can manage video chats
canRestrictMembers	Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators.
canManageTopics	Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
canPostStories	Pass True if the administrator can post stories to the chat
canEditStories	Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
canDeleteStories	Pass True if the administrator can delete stories posted by other users
canManageDirectMessages	Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only
canManageTags	Pass True if the administrator can edit the tags of regular members; for groups and supergroups only

Returns

Telegram Bot API result.

readBusinessMessage()

bool TgBot::Api::readBusinessMessage	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	businessConnectionId,
		std::int32_t	messageId ) const

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

Parameters

chatId	Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.
businessConnectionId	Unique identifier of the business connection on behalf of which to read the message
messageId	Unique identifier of the message to mark as read

Returns

Telegram Bot API result.

refundStarPayment()

bool TgBot::Api::refundStarPayment	(	const std::string &	telegramPaymentChargeId,
		std::int64_t	userId ) const

Refunds a successful payment in Telegram Stars. Returns True on success.

Parameters

telegramPaymentChargeId	Telegram payment identifier
userId	Identifier of the user whose payment will be refunded

Returns

Telegram Bot API result.

removeBusinessAccountProfilePhoto()

bool TgBot::Api::removeBusinessAccountProfilePhoto	(	const std::string &	businessConnectionId,
		bool	isPublic = false ) const

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
isPublic	Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.

Returns

Telegram Bot API result.

removeChatVerification()

bool TgBot::Api::removeChatVerification

(

std::variant< std::int64_t, std::string >

chatId

)

const

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target bot or channel in the format @username

Returns

Telegram Bot API result.

removeMyProfilePhoto()

bool TgBot::Api::removeMyProfilePhoto

(

)

const

Removes the profile photo of the bot. Requires no parameters. Returns True on success.

Returns

Telegram Bot API result.

removeUserVerification()

bool TgBot::Api::removeUserVerification

(

std::int64_t

userId

)

const

Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

Parameters

userId

Unique identifier of the target user

Returns

Telegram Bot API result.

reopenForumTopic()

bool TgBot::Api::reopenForumTopic	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageThreadId ) const

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

Telegram Bot API result.

reopenGeneralForumTopic()

bool TgBot::Api::reopenGeneralForumTopic

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup in the format @username

Returns

Telegram Bot API result.

replaceManagedBotToken()

std::string TgBot::Api::replaceManagedBotToken

(

std::int64_t

userId

)

const

Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.

Parameters

userId

User identifier of the managed bot whose token will be replaced

Returns

Telegram Bot API result.

replaceStickerInSet()

bool TgBot::Api::replaceStickerInSet	(	std::int64_t	userId,
		const std::string &	name,
		const std::string &	oldSticker,
		std::shared_ptr< InputSticker >	sticker ) const

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

Parameters

userId	User identifier of the sticker set owner
name	Sticker set name
oldSticker	File identifier of the replaced sticker
sticker	A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.

Returns

Telegram Bot API result.

repostStory()

std::shared_ptr< Story > TgBot::Api::repostStory	(	std::int32_t	activePeriod,
		const std::string &	businessConnectionId,
		std::variant< std::int64_t, std::string >	fromChatId,
		std::int32_t	fromStoryId,
		bool	postToChatPage = false,
		bool	protectContent = false ) const

Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.

Parameters

activePeriod	Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
businessConnectionId	Unique identifier of the business connection
fromChatId	Unique identifier of the chat which posted the story that should be reposted
fromStoryId	Unique identifier of the story that should be reposted
postToChatPage	Pass True to keep the story accessible after it expires
protectContent	Pass True if the content of the story must be protected from forwarding and screenshotting

Returns

Telegram Bot API result.

restrictChatMember()

bool TgBot::Api::restrictChatMember	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId,
		std::shared_ptr< ChatPermissions >	permissions,
		std::int32_t	untilDate = 0,
		bool	useIndependentChatPermissions = false ) const

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
userId	Unique identifier of the target user
permissions	A JSON-serialized object for new user permissions
untilDate	Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.
useIndependentChatPermissions	Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

Returns

Telegram Bot API result.

revokeChatInviteLink()

std::shared_ptr< ChatInviteLink > TgBot::Api::revokeChatInviteLink	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	inviteLink ) const

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Parameters

chatId	Unique identifier of the target chat or username of the target channel in the format @username
inviteLink	The invite link to revoke

Returns

Telegram Bot API result.

savePreparedInlineMessage()

std::shared_ptr< PreparedInlineMessage > TgBot::Api::savePreparedInlineMessage	(	std::shared_ptr< InlineQueryResult >	result,
		std::int64_t	userId,
		bool	allowBotChats = false,
		bool	allowChannelChats = false,
		bool	allowGroupChats = false,
		bool	allowUserChats = false ) const

Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

Parameters

result	A JSON-serialized object describing the message to be sent
userId	Unique identifier of the target user that can use the prepared message
allowBotChats	Pass True if the message can be sent to private chats with bots
allowChannelChats	Pass True if the message can be sent to channel chats
allowGroupChats	Pass True if the message can be sent to group and supergroup chats
allowUserChats	Pass True if the message can be sent to private chats with users

Returns

Telegram Bot API result.

savePreparedKeyboardButton()

std::shared_ptr< PreparedKeyboardButton > TgBot::Api::savePreparedKeyboardButton	(	std::shared_ptr< KeyboardButton >	button,
		std::int64_t	userId ) const

Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.

Parameters

button	A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot.
userId	Unique identifier of the target user that can use the button

Returns

Telegram Bot API result.

sendAnimation()

std::shared_ptr< Message > TgBot::Api::sendAnimation	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	animation,
		std::int32_t	duration = 0,
		std::int32_t	width = 0,
		std::int32_t	height = 0,
		std::variant< std::shared_ptr< InputFile >, std::string >	thumbnail = { },
		const std::string &	caption = "",
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		bool	hasSpoiler = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		bool	showCaptionAboveMedia = false,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
animation	Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »
duration	Duration of sent animation in seconds
width	Animation width
height	Animation height
thumbnail	Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
caption	Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the animation caption. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
hasSpoiler	Pass True if the animation needs to be covered with a spoiler animation
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
showCaptionAboveMedia	Pass True if the caption must be shown above the message media
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendAudio()

std::shared_ptr< Message > TgBot::Api::sendAudio	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	audio,
		const std::string &	caption = "",
		std::int32_t	duration = 0,
		const std::string &	performer = "",
		const std::string &	title = "",
		std::variant< std::shared_ptr< InputFile >, std::string >	thumbnail = { },
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
audio	Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
caption	Audio caption, 0-1024 characters after entities parsing
duration	Duration of the audio in seconds
performer	Performer
title	Track name
thumbnail	Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the audio caption. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendChatAction()

bool TgBot::Api::sendChatAction	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	action,
		std::int32_t	messageThreadId = 0,
		const std::string &	businessConnectionId = "" ) const

Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Parameters

chatId	Unique identifier for the target chat or username of the target bot or supergroup in the format @username. Channel chats and channel direct messages chats aren't supported.
action	Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
messageThreadId	Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only
businessConnectionId	Unique identifier of the business connection on behalf of which the action will be sent

Returns

Telegram Bot API result.

sendChatJoinRequestWebApp()

bool TgBot::Api::sendChatJoinRequestWebApp	(	const std::string &	chatJoinRequestQueryId,
		const std::string &	webAppUrl ) const

Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call answerChatJoinRequestQuery to resolve the join request query based on the user interaction with the Mini App. Returns True on success.

Parameters

chatJoinRequestQueryId	Unique identifier of the join request query
webAppUrl	An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps

Returns

Telegram Bot API result.

sendChecklist()

std::shared_ptr< Message > TgBot::Api::sendChecklist	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	businessConnectionId,
		std::shared_ptr< InputChecklist >	checklist,
		bool	disableNotification = false,
		const std::string &	messageEffectId = "",
		bool	protectContent = false,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr ) const

Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot in the format @username
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
checklist	A JSON-serialized object for the checklist to send
disableNotification	Sends the message silently. Users will receive a notification with no sound.
messageEffectId	Unique identifier of the message effect to be added to the message
protectContent	Protects the contents of the sent message from forwarding and saving
replyMarkup	A JSON-serialized object for an inline keyboard
replyParameters	A JSON-serialized object for description of the message to reply to

Returns

Telegram Bot API result.

sendContact()

std::shared_ptr< Message > TgBot::Api::sendContact	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	phoneNumber,
		const std::string &	firstName,
		const std::string &	lastName = "",
		const std::string &	vcard = "",
		bool	disableNotification = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send phone contacts. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
phoneNumber	Contact's phone number
firstName	Contact's first name
lastName	Contact's last name
vcard	Additional data about the contact in the form of a vCard, 0-2048 bytes
disableNotification	Sends the message silently. Users will receive a notification with no sound.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendDice()

std::shared_ptr< Message > TgBot::Api::sendDice	(	std::variant< std::int64_t, std::string >	chatId,
		bool	disableNotification = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	emoji = "",
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
disableNotification	Sends the message silently. Users will receive a notification with no sound.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
emoji	Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, “”, or “”. Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “”.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendDocument()

std::shared_ptr< Message > TgBot::Api::sendDocument	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	document,
		std::variant< std::shared_ptr< InputFile >, std::string >	thumbnail = { },
		const std::string &	caption = "",
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		bool	disableContentTypeDetection = false,
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
document	File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
thumbnail	Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
caption	Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the document caption. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
disableContentTypeDetection	Disables automatic server-side content type detection for files uploaded using multipart/form-data
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendGame()

std::shared_ptr< Message > TgBot::Api::sendGame	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	gameShortName,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		bool	disableNotification = false,
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	messageEffectId = "" ) const

Use this method to send a game. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats.
gameShortName	Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
replyParameters	Description of the message to reply to
replyMarkup	A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only

Returns

Telegram Bot API result.

sendGift()

bool TgBot::Api::sendGift	(	const std::string &	giftId,
		std::variant< std::int64_t, std::string >	chatId = { },
		bool	payForUpgrade = false,
		const std::string &	text = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	textEntities = { },
		const std::string &	textParseMode = "",
		std::int64_t	userId = 0 ) const

Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.

Parameters

giftId	Identifier of the gift; limited gifts can't be sent to channel chats
chatId	Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @username) that will receive the gift.
payForUpgrade	Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver
text	Text that will be shown along with the gift; 0-128 characters
textEntities	A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
textParseMode	Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
userId	Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.

Returns

Telegram Bot API result.

sendInvoice()

std::shared_ptr< Message > TgBot::Api::sendInvoice	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	title,
		const std::string &	description,
		const std::string &	payload,
		const std::string &	providerToken,
		const std::string &	currency,
		const std::vector< std::shared_ptr< LabeledPrice > > &	prices,
		const std::string &	providerData = "",
		const std::string &	photoUrl = "",
		std::int32_t	photoSize = 0,
		std::int32_t	photoWidth = 0,
		std::int32_t	photoHeight = 0,
		bool	needName = false,
		bool	needPhoneNumber = false,
		bool	needEmail = false,
		bool	needShippingAddress = false,
		bool	sendPhoneNumberToProvider = false,
		bool	sendEmailToProvider = false,
		bool	isFlexible = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		bool	disableNotification = false,
		std::int32_t	messageThreadId = 0,
		std::int32_t	maxTipAmount = 0,
		const std::vector< std::int32_t > &	suggestedTipAmounts = { },
		const std::string &	startParameter = "",
		bool	protectContent = false,
		bool	allowPaidBroadcast = false,
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send invoices. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
title	Product name, 1-32 characters
description	Product description, 1-255 characters
payload	Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
providerToken	Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
currency	Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
prices	Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
providerData	JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photoUrl	URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
photoSize	Photo size in bytes
photoWidth	Photo width
photoHeight	Photo height
needName	Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
needPhoneNumber	Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
needEmail	Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
needShippingAddress	Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
sendPhoneNumberToProvider	Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
sendEmailToProvider	Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
isFlexible	Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
replyParameters	Description of the message to reply to
replyMarkup	A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
maxTipAmount	The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
suggestedTipAmounts	A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
startParameter	Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non- empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.
protectContent	Protects the contents of the sent message from forwarding and saving
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendLivePhoto()

std::shared_ptr< Message > TgBot::Api::sendLivePhoto	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	livePhoto,
		std::variant< std::shared_ptr< InputFile >, std::string >	photo,
		bool	allowPaidBroadcast = false,
		const std::string &	businessConnectionId = "",
		const std::string &	callbackQueryId = "",
		const std::string &	caption = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int64_t	directMessagesTopicId = 0,
		bool	disableNotification = false,
		bool	hasSpoiler = false,
		const std::string &	messageEffectId = "",
		std::int32_t	messageThreadId = 0,
		const std::string &	parseMode = "",
		bool	protectContent = false,
		std::int64_t	receiverUserId = 0,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		bool	showCaptionAboveMedia = false,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send live photos. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target channel (in the format @channelusername)
livePhoto	Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
photo	The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
caption	Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
disableNotification	Sends the message silently. Users will receive a notification with no sound.
hasSpoiler	Pass True if the video needs to be covered with a spoiler animation
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
parseMode	Mode for parsing entities in the video caption. See formatting options for more details.
protectContent	Protects the contents of the sent message from forwarding and saving
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
replyParameters	Description of the message to reply to
showCaptionAboveMedia	Pass True if the caption must be shown above the message media
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendLocation()

std::shared_ptr< Message > TgBot::Api::sendLocation	(	std::variant< std::int64_t, std::string >	chatId,
		double	latitude,
		double	longitude,
		std::int32_t	livePeriod = 0,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		bool	disableNotification = false,
		double	horizontalAccuracy = 0,
		std::int32_t	heading = 0,
		std::int32_t	proximityAlertRadius = 0,
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send point on the map. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
latitude	Latitude of the location
longitude	Longitude of the location
livePeriod	Period in seconds during which the location will be updated (see Live Locations), must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. Must be 0 for ephemeral messages.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
horizontalAccuracy	The radius of uncertainty for the location, measured in meters; 0-1500
heading	For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximityAlertRadius	For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendMediaGroup()

std::vector< std::shared_ptr< Message > > TgBot::Api::sendMediaGroup	(	std::variant< std::int64_t, std::string >	chatId,
		const std::vector< std::variant< std::shared_ptr< InputMediaAudio >, std::shared_ptr< InputMediaDocument >, std::shared_ptr< InputMediaLivePhoto >, std::shared_ptr< InputMediaPhoto >, std::shared_ptr< InputMediaVideo > > > &	media,
		bool	disableNotification = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "" ) const

Use this method to send a group of photos, live photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an Array of Message objects that were sent is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
media	A JSON-serialized Array describing messages to be sent, must include 2-10 items
disableNotification	Sends messages silently. Users will receive a notification with no sound.
replyParameters	Description of the message to reply to
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent messages from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
directMessagesTopicId	Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only

Returns

Telegram Bot API result.

sendMessage()

std::shared_ptr< Message > TgBot::Api::sendMessage	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	text,
		std::shared_ptr< LinkPreviewOptions >	linkPreviewOptions = nullptr,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	entities = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send text messages. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
text	Text of the message to be sent, 1-4096 characters after entities parsing
linkPreviewOptions	Link preview generation options for the message
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the message text. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
entities	A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendMessageDraft()

bool TgBot::Api::sendMessageDraft	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	draftId,
		const std::vector< std::shared_ptr< MessageEntity > > &	entities = { },
		std::int32_t	messageThreadId = 0,
		const std::string &	parseMode = "",
		const std::string &	text = "" ) const

Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendMessage with the complete message to persist it in the user's chat. Returns True on success.

Parameters

chatId	Unique identifier for the target private chat
draftId	Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated.
entities	A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread
parseMode	Mode for parsing entities in the message text. See formatting options for more details.
text	Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.

Returns

Telegram Bot API result.

sendPaidMedia()

std::shared_ptr< Message > TgBot::Api::sendPaidMedia	(	std::variant< std::int64_t, std::string >	chatId,
		const std::vector< std::shared_ptr< InputPaidMedia > > &	media,
		std::int32_t	starCount,
		bool	allowPaidBroadcast = false,
		const std::string &	businessConnectionId = "",
		const std::string &	caption = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int64_t	directMessagesTopicId = 0,
		bool	disableNotification = false,
		std::int32_t	messageThreadId = 0,
		const std::string &	parseMode = "",
		const std::string &	payload = "",
		bool	protectContent = false,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		bool	showCaptionAboveMedia = false,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send paid media. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.
media	A JSON-serialized Array describing the media to be sent; up to 10 items
starCount	The number of Telegram Stars that must be paid to buy access to the media; 1-25000
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
caption	Media caption, 0-1024 characters after entities parsing
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
disableNotification	Sends the message silently. Users will receive a notification with no sound.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
parseMode	Mode for parsing entities in the media caption. See formatting options for more details.
payload	Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
protectContent	Protects the contents of the sent message from forwarding and saving
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
replyParameters	Description of the message to reply to
showCaptionAboveMedia	Pass True if the caption must be shown above the message media
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendPhoto()

std::shared_ptr< Message > TgBot::Api::sendPhoto	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	photo,
		const std::string &	caption = "",
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		bool	hasSpoiler = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		bool	showCaptionAboveMedia = false,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send photos. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
photo	Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »
caption	Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the photo caption. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
hasSpoiler	Pass True if the photo needs to be covered with a spoiler animation
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
showCaptionAboveMedia	Pass True if the caption must be shown above the message media
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendPoll()

std::shared_ptr< Message > TgBot::Api::sendPoll	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	question,
		const std::vector< std::shared_ptr< InputPollOption > > &	options,
		bool	disableNotification = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		bool	isAnonymous = true,
		const std::string &	type = "",
		bool	allowsMultipleAnswers = false,
		const std::string &	explanation = "",
		const std::string &	explanationParseMode = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	explanationEntities = { },
		std::int32_t	openPeriod = 0,
		std::int32_t	closeDate = 0,
		bool	isClosed = false,
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowAddingOptions = false,
		bool	allowPaidBroadcast = false,
		bool	allowsRevoting = false,
		const std::vector< std::int32_t > &	correctOptionIds = { },
		const std::vector< std::string > &	countryCodes = { },
		const std::string &	description = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	descriptionEntities = { },
		const std::string &	descriptionParseMode = "",
		std::shared_ptr< InputPollMedia >	explanationMedia = nullptr,
		bool	hideResultsUntilCloses = false,
		std::shared_ptr< InputPollMedia >	media = nullptr,
		bool	membersOnly = false,
		const std::string &	messageEffectId = "",
		const std::vector< std::shared_ptr< MessageEntity > > &	questionEntities = { },
		const std::string &	questionParseMode = "",
		bool	shuffleOptions = false ) const

Use this method to send a native poll. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Polls can't be sent to channel direct messages chats.
question	Poll question, 1-300 characters
options	A JSON-serialized list of 1-12 answer options
disableNotification	Sends the message silently. Users will receive a notification with no sound.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
isAnonymous	True, if the poll needs to be anonymous, defaults to True
type	Poll type, “quiz” or “regular”, defaults to “regular”
allowsMultipleAnswers	Pass True if the poll allows multiple answers, defaults to False
explanation	Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
explanationParseMode	Mode for parsing entities in the explanation. See formatting options for more details.
explanationEntities	A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode.
openPeriod	Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date.
closeDate	Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.
isClosed	Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowAddingOptions	Pass True if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
allowsRevoting	Pass True if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls
correctOptionIds	A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode
countryCodes	A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll; for channel chats only. Use “FT” as a country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any country can participate in the poll.
description	Description of the poll to be sent, 0-1024 characters after entities parsing
descriptionEntities	A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode
descriptionParseMode	Mode for parsing entities in the poll description. See formatting options for more details.
explanationMedia	Media added to the quiz explanation
hideResultsUntilCloses	Pass True if poll results must be shown only after the poll closes
media	Media added to the poll description
membersOnly	Pass True if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
questionEntities	A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode.
questionParseMode	Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed.
shuffleOptions	Pass True if the poll options must be shown in random order

Returns

Telegram Bot API result.

sendRequest()

nlohmann::json TgBot::Api::sendRequest ( const std::string & method, const std::vector< HttpFormField > & fields ) const

protected

sendRichMessage()

std::shared_ptr< Message > TgBot::Api::sendRichMessage	(	std::variant< std::int64_t, std::string >	chatId,
		std::shared_ptr< InputRichMessage >	richMessage,
		bool	allowPaidBroadcast = false,
		const std::string &	businessConnectionId = "",
		std::int64_t	directMessagesTopicId = 0,
		bool	disableNotification = false,
		const std::string &	messageEffectId = "",
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send rich messages. If the message contains a block with a media element, then the bot must have the right to send the media to the chat. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
richMessage	The message to be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent. Bot can send rich messages on behalf of a business account only if the corresponding user can send rich messages.
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
disableNotification	Sends the message silently. Users will receive a notification with no sound.
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
replyParameters	Description of the message to reply to
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendRichMessageDraft()

bool TgBot::Api::sendRichMessageDraft	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	draftId,
		std::shared_ptr< InputRichMessage >	richMessage,
		std::int32_t	messageThreadId = 0 ) const

Use this method to stream a partial rich message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendRichMessage with the complete message to persist it in the user's chat. Returns True on success.

Parameters

chatId	Unique identifier for the target private chat
draftId	Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated.
richMessage	The partial message to be streamed. Direct upload of new files isn't supported.
messageThreadId	Unique identifier for the target message thread

Returns

Telegram Bot API result.

sendSticker()

std::shared_ptr< Message > TgBot::Api::sendSticker	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	sticker,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		bool	disableNotification = false,
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	emoji = "",
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
sticker	Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
emoji	Emoji associated with the sticker; only for just uploaded stickers
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendVenue()

std::shared_ptr< Message > TgBot::Api::sendVenue	(	std::variant< std::int64_t, std::string >	chatId,
		double	latitude,
		double	longitude,
		const std::string &	title,
		const std::string &	address,
		const std::string &	foursquareId = "",
		const std::string &	foursquareType = "",
		bool	disableNotification = false,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	googlePlaceId = "",
		const std::string &	googlePlaceType = "",
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send information about a venue. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
latitude	Latitude of the venue
longitude	Longitude of the venue
title	Name of the venue
address	Address of the venue
foursquareId	Foursquare identifier of the venue
foursquareType	Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
disableNotification	Sends the message silently. Users will receive a notification with no sound.
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
googlePlaceId	Google Places identifier of the venue
googlePlaceType	Google Places type of the venue. (See supported types.)
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendVideo()

std::shared_ptr< Message > TgBot::Api::sendVideo	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	video,
		bool	supportsStreaming = false,
		std::int32_t	duration = 0,
		std::int32_t	width = 0,
		std::int32_t	height = 0,
		std::variant< std::shared_ptr< InputFile >, std::string >	thumbnail = { },
		const std::string &	caption = "",
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		bool	hasSpoiler = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::variant< std::shared_ptr< InputFile >, std::string >	cover = { },
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		bool	showCaptionAboveMedia = false,
		std::int32_t	startTimestamp = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
video	Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »
supportsStreaming	Pass True if the uploaded video is suitable for streaming
duration	Duration of sent video in seconds
width	Video width
height	Video height
thumbnail	Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
caption	Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the video caption. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
hasSpoiler	Pass True if the video needs to be covered with a spoiler animation
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
cover	Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form- data under <file_attach_name> name. More information on Sending Files »
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
showCaptionAboveMedia	Pass True if the caption must be shown above the message media
startTimestamp	Start timestamp for the video in the message
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendVideoNote()

std::shared_ptr< Message > TgBot::Api::sendVideoNote	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	videoNote,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		bool	disableNotification = false,
		std::int32_t	duration = 0,
		std::int32_t	length = 0,
		std::variant< std::shared_ptr< InputFile >, std::string >	thumbnail = { },
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
videoNote	Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported.
replyParameters	Description of the message to reply to
disableNotification	Sends the message silently. Users will receive a notification with no sound.
duration	Duration of sent video in seconds
length	Video width and height, i.e. diameter of the video message
thumbnail	Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

sendVoice()

std::shared_ptr< Message > TgBot::Api::sendVoice	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	voice,
		const std::string &	caption = "",
		std::int32_t	duration = 0,
		std::shared_ptr< ReplyParameters >	replyParameters = nullptr,
		std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > >	replyMarkup = { },
		const std::string &	parseMode = "",
		bool	disableNotification = false,
		const std::vector< std::shared_ptr< MessageEntity > > &	captionEntities = { },
		std::int32_t	messageThreadId = 0,
		bool	protectContent = false,
		const std::string &	businessConnectionId = "",
		bool	allowPaidBroadcast = false,
		const std::string &	callbackQueryId = "",
		std::int64_t	directMessagesTopicId = 0,
		const std::string &	messageEffectId = "",
		std::int64_t	receiverUserId = 0,
		std::shared_ptr< SuggestedPostParameters >	suggestedPostParameters = nullptr ) const

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
voice	Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
caption	Voice message caption, 0-1024 characters after entities parsing
duration	Duration of the voice message in seconds
replyParameters	Description of the message to reply to
replyMarkup	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
parseMode	Mode for parsing entities in the voice message caption. See formatting options for more details.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
captionEntities	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
messageThreadId	Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
protectContent	Protects the contents of the sent message from forwarding and saving
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be sent
allowPaidBroadcast	Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
callbackQueryId	For outgoing ephemeral messages, identifier of the callback query which triggered the message if any
directMessagesTopicId	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
messageEffectId	Unique identifier of the message effect to be added to the message; for private chats only
receiverUserId	For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details.
suggestedPostParameters	A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Returns

Telegram Bot API result.

setBusinessAccountBio()

bool TgBot::Api::setBusinessAccountBio	(	const std::string &	businessConnectionId,
		const std::string &	bio = "" ) const

Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
bio	The new value of the bio for the business account; 0-140 characters

Returns

Telegram Bot API result.

setBusinessAccountGiftSettings()

bool TgBot::Api::setBusinessAccountGiftSettings	(	std::shared_ptr< AcceptedGiftTypes >	acceptedGiftTypes,
		const std::string &	businessConnectionId,
		bool	showGiftButton ) const

Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

Parameters

acceptedGiftTypes	Types of gifts accepted by the business account
businessConnectionId	Unique identifier of the business connection
showGiftButton	Pass True if a button for sending a gift to the user or by the business account must always be shown in the input field

Returns

Telegram Bot API result.

setBusinessAccountName()

bool TgBot::Api::setBusinessAccountName	(	const std::string &	businessConnectionId,
		const std::string &	firstName,
		const std::string &	lastName = "" ) const

Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
firstName	The new value of the first name for the business account; 1-64 characters
lastName	The new value of the last name for the business account; 0-64 characters

Returns

Telegram Bot API result.

setBusinessAccountProfilePhoto()

bool TgBot::Api::setBusinessAccountProfilePhoto	(	const std::string &	businessConnectionId,
		std::shared_ptr< InputProfilePhoto >	photo,
		bool	isPublic = false ) const

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
photo	The new profile photo to set
isPublic	Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.

Returns

Telegram Bot API result.

setBusinessAccountUsername()

bool TgBot::Api::setBusinessAccountUsername	(	const std::string &	businessConnectionId,
		const std::string &	username = "" ) const

Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
username	The new value of the username for the business account; 0-32 characters

Returns

Telegram Bot API result.

setChatAdministratorCustomTitle()

bool TgBot::Api::setChatAdministratorCustomTitle	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId,
		const std::string &	customTitle ) const

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

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
userId	Unique identifier of the target user
customTitle	New custom title for the administrator; 0-16 characters, emoji are not allowed

Returns

Telegram Bot API result.

setChatDescription()

bool TgBot::Api::setChatDescription	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	description = "" ) const

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
description	New chat description, 0-255 characters

Returns

Telegram Bot API result.

setChatMemberTag()

bool TgBot::Api::setChatMemberTag	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId,
		const std::string &	tag = "" ) const

Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
userId	Unique identifier of the target user
tag	New tag for the member; 0-16 characters, emoji are not allowed

Returns

Telegram Bot API result.

setChatMenuButton()

bool TgBot::Api::setChatMenuButton	(	std::variant< std::int64_t, std::string >	chatId = { },
		std::shared_ptr< MenuButton >	menuButton = nullptr ) const

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

Parameters

chatId	Unique identifier for the target private chat. If not specified, the bot's default menu button will be changed.
menuButton	A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault.

Returns

Telegram Bot API result.

setChatPermissions()

bool TgBot::Api::setChatPermissions	(	std::variant< std::int64_t, std::string >	chatId,
		std::shared_ptr< ChatPermissions >	permissions,
		bool	useIndependentChatPermissions = false ) const

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
permissions	A JSON-serialized object for new default chat permissions
useIndependentChatPermissions	Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

Returns

Telegram Bot API result.

setChatPhoto()

bool TgBot::Api::setChatPhoto	(	std::variant< std::int64_t, std::string >	chatId,
		std::variant< std::shared_ptr< InputFile >, std::string >	photo ) const

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
photo	New chat photo, uploaded using multipart/form-data

Returns

Telegram Bot API result.

setChatStickerSet()

bool TgBot::Api::setChatStickerSet	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	stickerSetName ) const

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
stickerSetName	Name of the sticker set to be set as the group sticker set

Returns

Telegram Bot API result.

setChatTitle()

bool TgBot::Api::setChatTitle	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	title ) const

Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
title	New chat title, 1-128 characters

Returns

Telegram Bot API result.

setCustomEmojiStickerSetThumbnail()

bool TgBot::Api::setCustomEmojiStickerSetThumbnail	(	const std::string &	name,
		const std::string &	customEmojiId = "" ) const

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Parameters

name	Sticker set name
customEmojiId	Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail

Returns

Telegram Bot API result.

setGameScore()

std::shared_ptr< Message > TgBot::Api::setGameScore	(	std::int64_t	userId,
		std::int32_t	score,
		bool	force = false,
		bool	disableEditMessage = false,
		std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "" ) const

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Parameters

userId	User identifier
score	New score, must be non-negative
force	Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.
disableEditMessage	Pass True if the game message should not be automatically edited to include the current scoreboard
chatId	Required if inline_message_id is not specified. Unique identifier for the target chat.
messageId	Required if inline_message_id is not specified. Identifier of the sent message.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.

Returns

Telegram Bot API result.

setManagedBotAccessSettings()

bool TgBot::Api::setManagedBotAccessSettings	(	bool	isAccessRestricted,
		std::int64_t	userId,
		const std::vector< std::int32_t > &	addedUserIds = { } ) const

Use this method to change the access settings of a managed bot. Returns True on success.

Parameters

isAccessRestricted	Pass True if only selected users can access the bot. The bot's owner can always access it.
userId	User identifier of the managed bot whose access settings will be changed
addedUserIds	A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is False.

Returns

Telegram Bot API result.

setMessageReaction()

bool TgBot::Api::setMessageReaction	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId,
		const std::vector< std::shared_ptr< ReactionType > > &	reaction = { },
		bool	isBig = false ) const

Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
messageId	Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.
reaction	A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.
isBig	Pass True to set the reaction with a big animation

Returns

Telegram Bot API result.

setMyCommands()

bool TgBot::Api::setMyCommands	(	const std::vector< std::shared_ptr< BotCommand > > &	commands,
		std::shared_ptr< BotCommandScope >	scope = nullptr,
		const std::string &	languageCode = "" ) const

Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.

Parameters

commands	A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
scope	A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
languageCode	A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.

Returns

Telegram Bot API result.

setMyDefaultAdministratorRights()

bool TgBot::Api::setMyDefaultAdministratorRights	(	std::shared_ptr< ChatAdministratorRights >	rights = nullptr,
		bool	forChannels = false ) const

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.

Parameters

rights	A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.
forChannels	Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.

Returns

Telegram Bot API result.

setMyDescription()

bool TgBot::Api::setMyDescription	(	const std::string &	description = "",
		const std::string &	languageCode = "" ) const

Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

Parameters

description	New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
languageCode	A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

Returns

Telegram Bot API result.

setMyName()

bool TgBot::Api::setMyName	(	const std::string &	name = "",
		const std::string &	languageCode = "" ) const

Use this method to change the bot's name. Returns True on success.

Parameters

name	New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.
languageCode	A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.

Returns

Telegram Bot API result.

setMyProfilePhoto()

bool TgBot::Api::setMyProfilePhoto

(

std::shared_ptr< InputProfilePhoto >

photo

)

const

Changes the profile photo of the bot. Returns True on success.

Parameters

photo

The new profile photo to set

Returns

Telegram Bot API result.

setMyShortDescription()

bool TgBot::Api::setMyShortDescription	(	const std::string &	shortDescription = "",
		const std::string &	languageCode = "" ) const

Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.

Parameters

shortDescription	New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
languageCode	A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.

Returns

Telegram Bot API result.

setPassportDataErrors()

bool TgBot::Api::setPassportDataErrors	(	std::int64_t	userId,
		const std::vector< std::shared_ptr< PassportElementError > > &	errors ) const

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Parameters

userId	User identifier
errors	A JSON-serialized Array describing the errors

Returns

Telegram Bot API result.

setStickerEmojiList()

bool TgBot::Api::setStickerEmojiList	(	const std::string &	sticker,
		const std::vector< std::string > &	emojiList ) const

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Parameters

sticker	File identifier of the sticker
emojiList	A JSON-serialized list of 1-20 emoji associated with the sticker

Returns

Telegram Bot API result.

setStickerKeywords()

bool TgBot::Api::setStickerKeywords	(	const std::string &	sticker,
		const std::vector< std::string > &	keywords = { } ) const

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Parameters

sticker	File identifier of the sticker
keywords	A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters

Returns

Telegram Bot API result.

setStickerMaskPosition()

bool TgBot::Api::setStickerMaskPosition	(	const std::string &	sticker,
		std::shared_ptr< MaskPosition >	maskPosition = nullptr ) const

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

Parameters

sticker	File identifier of the sticker
maskPosition	A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.

Returns

Telegram Bot API result.

setStickerPositionInSet()

bool TgBot::Api::setStickerPositionInSet	(	const std::string &	sticker,
		std::int32_t	position ) const

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

Parameters

sticker	File identifier of the sticker
position	New sticker position in the set, zero-based

Returns

Telegram Bot API result.

setStickerSetThumbnail()

bool TgBot::Api::setStickerSetThumbnail	(	const std::string &	name,
		std::int64_t	userId,
		const std::string &	format,
		std::variant< std::shared_ptr< InputFile >, std::string >	thumbnail = { } ) const

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

Parameters

name	Sticker set name
userId	User identifier of the sticker set owner
format	Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video
thumbnail	A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video- requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.

Returns

Telegram Bot API result.

setStickerSetTitle()

bool TgBot::Api::setStickerSetTitle	(	const std::string &	name,
		const std::string &	title ) const

Use this method to set the title of a created sticker set. Returns True on success.

Parameters

name	Sticker set name
title	Sticker set title, 1-64 characters

Returns

Telegram Bot API result.

setUserEmojiStatus()

bool TgBot::Api::setUserEmojiStatus	(	std::int64_t	userId,
		const std::string &	emojiStatusCustomEmojiId = "",
		std::int32_t	emojiStatusExpirationDate = 0 ) const

Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.

Parameters

userId	Unique identifier of the target user
emojiStatusCustomEmojiId	Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.
emojiStatusExpirationDate	Expiration date of the emoji status, if any

Returns

Telegram Bot API result.

setWebhook()

bool TgBot::Api::setWebhook	(	const std::string &	url,
		std::shared_ptr< InputFile >	certificate = nullptr,
		std::int32_t	maxConnections = 40,
		const std::vector< std::string > &	allowedUpdates = { },
		const std::string &	ipAddress = "",
		bool	dropPendingUpdates = false,
		const std::string &	secretToken = "" ) const

Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram- Bot-Api-Secret-Token” with the secret token as content.

Parameters

url	HTTPS URL to send updates to. Use an empty string to remove webhook integration.
certificate	Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
maxConnections	The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
allowedUpdates	A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
ipAddress	The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
dropPendingUpdates	Pass True to drop all pending updates
secretToken	A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

Returns

Telegram Bot API result.

stopMessageLiveLocation()

std::shared_ptr< Message > TgBot::Api::stopMessageLiveLocation	(	std::variant< std::int64_t, std::string >	chatId = { },
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr,
		const std::string &	businessConnectionId = "" ) const

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters

chatId	Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
messageId	Required if inline_message_id is not specified. Identifier of the message with live location to stop.
inlineMessageId	Required if chat_id and message_id are not specified. Identifier of the inline message.
replyMarkup	A JSON-serialized object for a new inline keyboard
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent

Returns

Telegram Bot API result.

stopPoll()

std::shared_ptr< Poll > TgBot::Api::stopPoll	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageId,
		const std::string &	businessConnectionId = "",
		std::shared_ptr< InlineKeyboardMarkup >	replyMarkup = nullptr ) const

Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
messageId	Identifier of the original message with the poll
businessConnectionId	Unique identifier of the business connection on behalf of which the message to be edited was sent
replyMarkup	A JSON-serialized object for a new message inline keyboard

Returns

Telegram Bot API result.

transferBusinessAccountStars()

bool TgBot::Api::transferBusinessAccountStars	(	const std::string &	businessConnectionId,
		std::int32_t	starCount ) const

Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
starCount	Number of Telegram Stars to transfer; 1-10000

Returns

Telegram Bot API result.

transferGift()

bool TgBot::Api::transferGift	(	const std::string &	businessConnectionId,
		std::int64_t	newOwnerChatId,
		const std::string &	ownedGiftId,
		std::int32_t	starCount = 0 ) const

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
newOwnerChatId	Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
ownedGiftId	Unique identifier of the regular gift that should be transferred
starCount	The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.

Returns

Telegram Bot API result.

unbanChatMember()

bool TgBot::Api::unbanChatMember	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	userId,
		bool	onlyIfBanned = false ) const

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

Parameters

chatId	Unique identifier for the target group or username of the target supergroup or channel in the format @username
userId	Unique identifier of the target user
onlyIfBanned	Do nothing if the user is not banned

Returns

Telegram Bot API result.

unbanChatSenderChat()

bool TgBot::Api::unbanChatSenderChat	(	std::variant< std::int64_t, std::string >	chatId,
		std::int64_t	senderChatId ) const

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
senderChatId	Unique identifier of the target sender chat

Returns

Telegram Bot API result.

unhideGeneralForumTopic()

bool TgBot::Api::unhideGeneralForumTopic

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup in the format @username

Returns

Telegram Bot API result.

unpinAllChatMessages()

bool TgBot::Api::unpinAllChatMessages

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target channel in the format @username

Returns

Telegram Bot API result.

unpinAllForumTopicMessages()

bool TgBot::Api::unpinAllForumTopicMessages	(	std::variant< std::int64_t, std::string >	chatId,
		std::int32_t	messageThreadId ) const

Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target supergroup in the format @username
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

Telegram Bot API result.

unpinAllGeneralForumTopicMessages()

bool TgBot::Api::unpinAllGeneralForumTopicMessages

(

std::variant< std::int64_t, std::string >

chatId

)

const

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Parameters

chatId

Unique identifier for the target chat or username of the target supergroup in the format @username

Returns

Telegram Bot API result.

unpinChatMessage()

bool TgBot::Api::unpinChatMessage	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	businessConnectionId = "",
		std::int32_t	messageId = 0 ) const

Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target channel in the format @username
businessConnectionId	Unique identifier of the business connection on behalf of which the message will be unpinned
messageId	Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.

Returns

Telegram Bot API result.

upgradeGift()

bool TgBot::Api::upgradeGift	(	const std::string &	businessConnectionId,
		const std::string &	ownedGiftId,
		bool	keepOriginalDetails = false,
		std::int32_t	starCount = 0 ) const

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

Parameters

businessConnectionId	Unique identifier of the business connection
ownedGiftId	Unique identifier of the regular gift that should be upgraded to a unique one
keepOriginalDetails	Pass True to keep the original gift text, sender and receiver in the upgraded gift
starCount	The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.

Returns

Telegram Bot API result.

uploadStickerFile()

std::shared_ptr< File > TgBot::Api::uploadStickerFile	(	std::int64_t	userId,
		std::variant< std::shared_ptr< InputFile >, std::string >	sticker,
		const std::string &	stickerFormat ) const

Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.

Parameters

userId	User identifier of sticker file owner
sticker	A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »
stickerFormat	Format of the sticker, must be one of “static”, “animated”, “video”

Returns

Telegram Bot API result.

verifyChat()

bool TgBot::Api::verifyChat	(	std::variant< std::int64_t, std::string >	chatId,
		const std::string &	customDescription = "" ) const

Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

Parameters

chatId	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Channel direct messages chats can't be verified.
customDescription	Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.

Returns

Telegram Bot API result.

verifyUser()

bool TgBot::Api::verifyUser	(	std::int64_t	userId,
		const std::string &	customDescription = "" ) const

Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

Parameters

userId	Unique identifier of the target user
customDescription	Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.

Returns

Telegram Bot API result.

Friends And Related Symbol Documentation

Bot

friend class Bot

friend

Definition at line 31 of file Api.h.

Member Data Documentation

_httpClient

const HttpClient& TgBot::Api::_httpClient

Definition at line 43 of file Api.h.

_token

const std::string TgBot::Api::_token

protected

Definition at line 48 of file Api.h.

_url

const std::string TgBot::Api::_url

protected

Definition at line 49 of file Api.h.

---

The documentation for this class was generated from the following file:

• include/tgbot/Api.h