tgbotxx::Api Class Reference

Api Methods https://core.telegram.org/bots/api#available-methods. More...

#include <Api.hpp>

Public Member Functions
	Api (const std::string &token)
	Constructs Api object. More...
Ptr< User >	getMe () const
	A simple method for testing your bot's authentication token. More...
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. More...
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. More...
Ptr< Message >	sendMessage (const std::variant< std::int64_t, std::string > &chatId, const std::string &text, std::int32_t messageThreadId=0, const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &entities=std::vector< Ptr< MessageEntity >>(), bool disableWebPagePreview=false, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send text messages. On success, the sent Message is returned. More...
Ptr< Message >	forwardMessage (const std::variant< std::int64_t, std::string > &chatId, const std::variant< std::int64_t, std::string > &fromChatId, std::int32_t messageId, std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false) const
	Use this method to forward messages of any kind. Service messages can't be forwarded. More...
Ptr< MessageId >	copyMessage (const std::variant< std::int64_t, std::string > &chatId, const std::variant< std::int64_t, std::string > &fromChatId, std::int32_t messageId, std::int32_t messageThreadId=0, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id 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. More...
Ptr< Message >	sendPhoto (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &photo, std::int32_t messageThreadId=0, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send photos. More...
Ptr< Message >	sendAudio (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &audio, std::int32_t messageThreadId=0, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), std::int32_t duration=0, const std::string &performer="", const std::string &title="", const std::optional< std::variant< cpr::File, std::string >> &thumbnail=std::nullopt, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=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. More...
Ptr< Message >	sendDocument (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &document, std::int32_t messageThreadId=0, const std::optional< std::variant< cpr::File, std::string >> &thumbnail=std::nullopt, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send general files. More...
Ptr< Message >	sendVideo (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &video, std::int32_t messageThreadId=0, std::int32_t duration=0, std::int32_t width=0, std::int32_t height=0, const std::optional< std::variant< cpr::File, std::string >> &thumbnail=std::nullopt, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), bool hasSpoiler=false, bool supportsStreaming=false, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document using Api::sendDocument()). Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. More...
Ptr< Message >	sendAnimation (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &animation, std::int32_t messageThreadId=0, std::int32_t duration=0, std::int32_t width=0, std::int32_t height=0, const std::optional< std::variant< cpr::File, std::string >> &thumbnail=std::nullopt, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), bool hasSpoiler=false, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. More...
Ptr< Message >	sendVoice (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &voice, std::int32_t messageThreadId=0, const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), std::int32_t duration=0, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=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 (other formats may be sent as Audio or Document). Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. More...
Ptr< Message >	sendVideoNote (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &videoNote, std::int32_t messageThreadId=0, std::int32_t duration=0, std::int32_t length=0, const std::optional< std::variant< cpr::File, std::string >> &thumbnail=std::nullopt, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=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. https://telegram.org/blog/video-messages-and-telescope. More...
std::vector< Ptr< Message > >	sendMediaGroup (const std::variant< std::int64_t, std::string > &chatId, const std::vector< Ptr< InputMedia >> &media, std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false) const
	Use this method to send a group of 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. More...
Ptr< Message >	sendLocation (const std::variant< std::int64_t, std::string > &chatId, float latitude, float longitude, std::int32_t messageThreadId=0, float horizontalAccuracy=0.0f, std::int32_t livePeriod=0, std::int32_t heading=0, std::int32_t proximityAlertRadius=0, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send point on the map. More...
Ptr< Message >	sendVenue (const std::variant< std::int64_t, std::string > &chatId, float latitude, float longitude, const std::string &title, const std::string &address, std::int32_t messageThreadId=0, const std::string &foursquareId="", const std::string &foursquareType="", const std::string &googlePlaceId="", const std::string &googlePlaceType="", bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send information about a venue. More...
Ptr< Message >	sendContact (const std::variant< std::int64_t, std::string > &chatId, const std::string &phoneNumber, const std::string &firstName, const std::string &lastName="", const std::string &vcard="", std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send phone contacts. More...
Ptr< Message >	sendPoll (const std::variant< std::int64_t, std::string > &chatId, const std::string &question, const std::vector< std::string > &options, bool isAnonymous=true, const std::string &type="regular", bool allowsMultipleAnswers=false, std::int32_t correctOptionId=-1, const std::string &explanation="", const std::string &explanationParseMode="", const std::vector< Ptr< MessageEntity >> &explanationEntities=std::vector< Ptr< MessageEntity >>(), std::int32_t openPeriod=0, std::int32_t closeDate=0, bool isClosed=false, std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send a native poll. More...
Ptr< Message >	sendDice (const std::variant< std::int64_t, std::string > &chatId, const std::string &emoji="🎲", std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send an animated emoji that will display a random value. More...
bool	sendChatAction (const std::variant< std::int64_t, std::string > &chatId, const std::string &action, std::int32_t messageThreadId=0) 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). More...
bool	setMessageReaction (const std::variant< std::int64_t, std::string > &chatId, std::int32_t messageId, const std::vector< Ptr< ReactionType >> &reaction=std::vector< Ptr< ReactionType >>(), bool isBig=false) const
	Use this method to change the chosen reactions on a message. Service messages 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. More...
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. More...
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. The file can then be downloaded using Api::downloadFile or via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. More...
std::string	downloadFile (const std::string &filePath, const std::function< bool(cpr::cpr_off_t downloadTotal, cpr::cpr_off_t downloadNow)> &progressCallback=nullptr) const
	Use this method to download a file from Telegram and save it in memory. For the moment, bots can download files of up to 20MB in size. See Api::getFile. 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. More...
bool	banChatMember (const std::variant< std::int64_t, std::string > &chatId, std::int64_t userId, std::time_t untilDate=0, bool revokeMessages=false) 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. https://core.telegram.org/bots/api#unbanchatmember. More...
bool	unbanChatMember (const 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 onlyIfBanned. More...
bool	restrictChatMember (const std::variant< std::int64_t, std::string > &chatId, std::int64_t userId, const Ptr< ChatPermissions > &permissions, bool useIndependentChatPermissions=false, std::time_t untilDate=0) 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 of ChatPermissions object to lift restrictions from a user. More...
bool	promoteChatMember (const std::variant< std::int64_t, std::string > &chatId, std::int64_t userId, bool isAnonymous=false, bool canManageChat=false, bool canDeleteMessages=false, bool canManageVideoChats=false, bool canRestrictMembers=false, bool canPromoteMembers=false, bool canChangeInfo=false, bool canInviteUsers=false, bool canPostMessages=false, bool canEditMessages=false, bool canPinMessages=false, bool canPostStories=false, bool canEditStories=false, bool canDeleteStories=false, bool canManageTopics=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. More...
bool	setChatAdministratorCustomTitle (const 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. More...
bool	setChatPermissions (const std::variant< std::int64_t, std::string > &chatId, const 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 canRestrictMembers administrator rights. More...
std::string	exportChatInviteLink (const 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. More...
bool	setChatTitle (const 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. More...
bool	setChatDescription (const 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. More...
bool	leaveChat (const std::variant< std::int64_t, std::string > &chatId) const
	Use this method for your bot to leave a group, supergroup or channel. More...
Ptr< Chat >	getChat (const std::variant< std::int64_t, std::string > &chatId) const
	Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). More...
std::vector< Ptr< ChatMember > >	getChatAdministrators (const std::variant< std::int64_t, std::string > &chatId) const
	Use this method to get a list of administrators in a chat, which aren't bots. More...
std::int32_t	getChatMemberCount (const std::variant< std::int64_t, std::string > &chatId) const
	Use this method to get the number of members in a chat. More...
Ptr< ChatMember >	getChatMember (const 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. More...
bool	editGeneralForumTopic (const 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 canManageTopics administrator right in the supergroup. More...
bool	closeGeneralForumTopic (const 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 canManageTopics administrator right in the supergroup. More...
bool	reopenGeneralForumTopic (const 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 canManageTopics administrator right in the supergroup. More...
bool	hideGeneralForumTopic (const 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 canManageTopics administrator right in the supergroup. More...
bool	unhideGeneralForumTopic (const 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 canManageTopics administrator right in the supergroup. More...
bool	unpinAllGeneralForumTopicMessages (const 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 canPinMessages administrator right in the supergroup. More...
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. The bot must be an administrator in the chat for this to work and must have the canPinMessages administrator right in the supergroup. https://core.telegram.org/bots/features#inline-keyboards. More...
bool	setMyCommands (const std::vector< Ptr< BotCommand >> &commands, const 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. https://core.telegram.org/bots/features#commands. More...
bool	deleteMyCommands (const 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. https://core.telegram.org/bots/api#determining-list-of-commands. More...
std::vector< Ptr< BotCommand > >	getMyCommands (const 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. More...
bool	setMyName (const std::string &name="", const std::string &languageCode="") const
	Use this method to change the bot's name. More...
Ptr< BotName >	getMyName (const std::string &languageCode="") const
	Use this method to get the current bot name for the given user language. More...
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. More...
Ptr< BotDescription >	getMyDescription (const std::string &languageCode="") const
	Use this method to get the current bot description for the given user language. More...
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. More...
Ptr< BotShortDescription >	getMyShortDescription (const std::string &languageCode="") const
	Use this method to get the current bot short description for the given user language. More...
bool	setChatMenuButton (const std::variant< std::int64_t, std::string > &chatId=std::string{}, const Ptr< MenuButton > &menuButton=nullptr) const
	Use this method to change the bot's menu button in a private chat, or the default menu button. More...
Ptr< MenuButton >	getChatMenuButton (const std::variant< std::int64_t, std::string > &chatId=std::string{}) const
	Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. More...
bool	setMyDefaultAdministratorRights (const 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. More...
Ptr< ChatAdministratorRights >	getMyDefaultAdministratorRights (bool forChannels=false) const
	Use this method to get the current default administrator rights of the bot. More...
Ptr< Message >	sendInvoice (const 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< Ptr< LabeledPrice >> &prices, std::int32_t messageThreadId=0, std::int32_t maxTipAmount=0, const std::vector< std::int32_t > &suggestedTipAmounts=std::vector< std::int32_t >(), const std::string &startParameter="", 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, bool disableNotification=false, bool protectContent=false, std::int32_t replyToMessageId=0, bool allowSendingWithoutReply=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send invoices. More...
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< Ptr< LabeledPrice >> &prices, std::int32_t maxTipAmount=0, const std::vector< std::int32_t > &suggestedTipAmounts=std::vector< std::int32_t >(), 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
	Use this method to create a link for an invoice. Returns the created invoice link as std::string on success. More...
bool	answerShippingQuery (const std::string &shippingQueryId, bool ok, const std::vector< Ptr< ShippingOption >> &shippingOptions=std::vector< Ptr< ShippingOption >>(), const std::string &errorMessage="") const
	If you sent an invoice requesting a shipping address and the parameter isFlexible was specified, the Bot API will send an Update with a shippingQuery field to the bot. Use this method to reply to shipping queries. On success, True is returned. More...
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 preCheckoutQuery. Use this method to respond to such pre-checkout queries. On success, True is returned. More...
std::vector< Ptr< Update > >	getUpdates (std::int32_t offset, std::int32_t limit=100) const
	Use this method to receive incoming updates using long polling. More...
bool	setWebhook (const std::string &url, const std::optional< cpr::File > &certificate=std::nullopt, const std::string &ipAddress="", std::int32_t maxConnections=40, const std::vector< std::string > &allowedUpdates=std::vector< std::string >(), 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, we will give up after a reasonable amount of attempts. 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. More...
bool	deleteWebhook (bool dropPendingUpdates=false) const
	Use this method to remove webhook integration if you decide to switch back to getUpdates. More...
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. More...
Ptr< Message >	editMessageText (const std::string &text, const std::variant< std::int64_t, std::string > &chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &entities=std::vector< Ptr< MessageEntity >>(), bool disableWebPagePreview=false, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to edit text and game messages. More...
Ptr< Message >	editMessageCaption (const std::variant< std::int64_t, std::string > &chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="", const std::string &caption="", const std::string &parseMode="", const std::vector< Ptr< MessageEntity >> &captionEntities=std::vector< Ptr< MessageEntity >>(), const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to edit captions of messages. More...
Ptr< Message >	editMessageMedia (const Ptr< InputMedia > &media, const std::variant< std::int64_t, std::string > &chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="", const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to edit animation, audio, document, photo, or video messages. 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 or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its fileId or specify a URL. More...
Ptr< Message >	editMessageLiveLocation (float latitude, float longitude, const std::variant< std::int64_t, std::string > &chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="", float horizontalAccuracy=0.0f, std::int32_t heading=0, std::int32_t proximityAlertRadius=0, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to edit live location messages. A location can be edited until its livePeriod expires or editing is explicitly disabled by a call to Api::stopMessageLiveLocation. More...
Ptr< Message >	stopMessageLiveLocation (const std::variant< std::int64_t, std::string > &chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="", const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to stop updating a live location message before livePeriod expires. More...
Ptr< Message >	editMessageReplyMarkup (const std::variant< std::int64_t, std::string > &chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="", const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to edit only the reply markup of messages. More...
Ptr< Poll >	stopPoll (const std::variant< std::int64_t, std::string > &chatId, std::int32_t messageId, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to stop a poll which was sent by the bot. More...
bool	deleteMessage (const 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: More...
Ptr< Message >	sendSticker (const std::variant< std::int64_t, std::string > &chatId, const std::variant< cpr::File, std::string > &sticker, std::int32_t messageThreadId=0, const std::string &emoji="", bool disableNotification=false, bool protectContent=false, const Ptr< ReplyParameters > &replyParameters=nullptr, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned. More...
Ptr< StickerSet >	getStickerSet (const std::string &name) const
	Use this method to get a sticker set. On success, a StickerSet object is returned. More...
std::vector< Ptr< Sticker > >	getCustomEmojiStickers (const std::vector< std::string > &customEmojiIds) const
	Use this method to get information about custom emoji stickers by their identifiers. More...
Ptr< File >	uploadStickerFile (std::int64_t userId, const cpr::File &sticker, const std::string &stickerFormat) const
	Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). More...
bool	createNewStickerSet (std::int64_t userId, const std::string &name, const std::string &title, const std::vector< Ptr< InputSticker >> &stickers, const std::string &stickerFormat, const std::string &stickerType="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. More...
bool	addStickerToSet (std::int64_t userId, const std::string &name, const Ptr< InputSticker > &sticker) const
	Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. More...
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. More...
bool	deleteStickerFromSet (const std::string &sticker) const
	Use this method to delete a sticker from a set created by the bot. More...
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. More...
bool	setStickerKeywords (const std::string &sticker, const std::vector< std::string > &keywords=std::vector< std::string >()) 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. More...
bool	setStickerMaskPosition (const std::string &sticker, const 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. More...
bool	setStickerSetTitle (const std::string &name, const std::string &title) const
	Use this method to set the title of a created sticker set. More...
bool	setStickerSetThumbnail (const std::string &name, const std::string &title, const std::optional< std::variant< cpr::File, std::string >> &thumbnail=std::nullopt) 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. More...
bool	setCustomEmojiStickerSetThumbnail (const std::string &name, const std::optional< std::string > &customEmojiId=std::nullopt) const
	Use this method to set the thumbnail of a custom emoji sticker set. More...
bool	deleteStickerSet (const std::string &name) const
	Use this method to delete a sticker set that was created by the bot. More...
bool	setPassportDataErrors (std::int64_t userId, const std::vector< 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). 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. More...
Ptr< Message >	sendGame (const std::variant< std::int64_t, std::string > &chatId, const std::string &gameShortName, std::int32_t messageThreadId=0, bool disableNotification=false, bool protectContent=false, const Ptr< ReplyParameters > &replyParameters=nullptr, const Ptr< IReplyMarkup > &replyMarkup=nullptr) const
	Use this method to send a game. More...
Ptr< Message >	setGameScore (std::int64_t userId, std::int32_t score, bool force=false, bool disableEditMessage=false, std::int64_t chatId=0, 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. More...
std::vector< Ptr< GameHighScore > >	getGameHighScores (std::int64_t userId, std::int64_t chatId=0, std::int32_t messageId=0, const std::string &inlineMessageId="") const
	Use this method to get data for high score tables. More...
bool	answerInlineQuery (const std::string &inlineQueryId, const std::vector< Ptr< InlineQueryResult >> &results, std::int32_t cacheTime=300, bool isPersonal=false, const std::string &nextOffset="", const Ptr< InlineQueryResultsButton > &button=nullptr) const
	Use this method to send answers to an inline query. No more than 50 results per query are allowed. More...
Ptr< SentWebAppMessage >	answerWebAppQuery (const std::string &webAppQueryId, const 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. More...
void	setUrl (const std::string &url) noexcept
	Set Api URL. More...
const std::string &	getUrl () const noexcept
	Get Api URL. More...
void	setLongPollTimeout (const cpr::Timeout &longPollTimeout)
	Set long polling timeout. More...
cpr::Timeout	getLongPollTimeout () const noexcept
	Get long polling timeout. More...
void	setConnectTimeout (const cpr::ConnectTimeout &timeout) noexcept
	Set Api requests connection timeout. More...
cpr::ConnectTimeout	getConnectTimeout () const noexcept
	Get Api requests connection timeout. More...
void	setTimeout (const cpr::Timeout &timeout)
	Set Api requests timeout. More...
cpr::Timeout	getTimeout () const noexcept
	Get Api requests timeout. More...
void	setUploadFilesTimeout (const cpr::Timeout &timeout) noexcept
	Set Api file uploads timeout. More...
cpr::Timeout	getUploadFilesTimeout () const noexcept
	Get Api file uploads timeout. More...
void	setDownloadFilesTimeout (const cpr::Timeout &timeout) noexcept
	Set Api file downloads timeout. More...
cpr::Timeout	getDownloadFilesTimeout () const noexcept
	Get Api file downloads timeout. More...
void	setAllowedUpdates (const std::vector< std::string > &allowedUpdates) noexcept
const std::vector< std::string > &	getAllowedUpdates () const noexcept
	Get list of the update types you want your bot to receive. More...

Friends
class	Bot

Related Functions
(Note that these are not member functions.)
bool	banChatSenderChat (const 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. More...
bool	unbanChatSenderChat (const 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. More...
Ptr< ChatInviteLink >	createChatInviteLink (const std::variant< std::int64_t, std::string > &chatId, const std::string &name="", std::time_t expireDate=0, std::int32_t memberLimit=0, 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. More...
Ptr< ChatInviteLink >	editChatInviteLink (const std::variant< std::int64_t, std::string > &chatId, const std::string &inviteLink, const std::string &name="", std::time_t expireDate=0, std::int32_t memberLimit=0, 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. More...
Ptr< ChatInviteLink >	revokeChatInviteLink (const 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. More...
bool	approveChatJoinRequest (const 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 canInviteUsers administrator right. More...
bool	declineChatJoinRequest (const 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 canInviteUsers administrator right. More...
bool	setChatPhoto (const std::variant< std::int64_t, std::string > &chatId, const cpr::File &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. More...
bool	deleteChatPhoto (const 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. More...
bool	pinChatMessage (const std::variant< std::int64_t, std::string > &chatId, std::int32_t messageId, bool disableNotification=false) const
	Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel. More...
bool	unpinChatMessage (const std::variant< std::int64_t, std::string > &chatId, std::int32_t messageId=0) const
	Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel. More...
bool	unpinAllChatMessages (const std::variant< std::int64_t, std::string > &chatId) const
	Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel. More...
bool	setChatStickerSet (const 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 canSetStickerSet optionally returned in getChat requests to check if the bot can use this method. More...
bool	deleteChatStickerSet (const 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 canSetStickerSet optionally returned in getChat requests to check if the bot can use this method. More...
std::vector< 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. More...
Ptr< ForumTopic >	createForumTopic (const std::variant< std::int64_t, std::string > &chatId, const std::string &name, std::int32_t iconColor=0x000000, const std::string &iconCustomEmojiId="") const
	Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic. More...
bool	editForumTopic (const std::variant< std::int64_t, std::string > &chatId, std::int32_t messageThreadId, const std::string &name, const std::optional< std::string > &iconCustomEmojiId=std::nullopt) const
	Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic. More...
bool	closeForumTopic (const 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 canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic. More...
bool	reopenForumTopic (const 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 canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic. More...
bool	deleteForumTopic (const 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. The bot must be an administrator in the chat for this to work and must have the canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic. More...
bool	unpinAllForumTopicMessages (const 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. The bot must be an administrator in the chat for this to work and must have the canPinMessages administrator right in the supergroup. More...

Detailed Description

Api Methods https://core.telegram.org/bots/api#available-methods.

Note

All methods in the Bot API are case-insensitive.

We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.

Definition at line 56 of file Api.hpp.

Constructor & Destructor Documentation

Api()

tgbotxx::Api::Api ( const std::string &  token )

explicit

Constructs Api object.

Parameters

token

Bot Token from FatherBot.

Member Function Documentation

addStickerToSet()

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

Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers.

Parameters

userId	User identifier of created 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#addstickertoset

answerCallbackQuery()

bool tgbotxx::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. The bot must be an administrator in the chat for this to work and must have the canPinMessages administrator right in the supergroup. https://core.telegram.org/bots/features#inline-keyboards.

Parameters

callbackQueryId	Unique identifier for the query to be answered
text	Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
showAlert	Optional. 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	Optional. 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	Optional. 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

True on success.

Exceptions

Exception

on failure @ote Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. https://core.telegram.org/bots/api#answercallbackquery

answerInlineQuery()

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

Use this method to send answers to an inline query. No more than 50 results per query are allowed.

Inline mode methods. Methods and objects used in the inline mode are described in the Inline mode section. https://core.telegram.org/bots/api#inline-mode

Parameters

inlineQueryId	Unique identifier for the answered query
results	A JSON-serialized array of results for the inline query
cacheTime	Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
isPersonal	Optional. 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	Optional. 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	Optional. A JSON-serialized object describing a button to be shown above inline query results

Returns

True on success.

Exceptions

Exception

on failure

Note

No more than 50 results per query are allowed. https://core.telegram.org/bots/api#answerinlinequery

answerPreCheckoutQuery()

bool tgbotxx::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 preCheckoutQuery. 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	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#answerprecheckoutquery

answerShippingQuery()

bool tgbotxx::Api::answerShippingQuery	(	const std::string &	shippingQueryId,
		bool	ok,
		const std::vector< Ptr< ShippingOption >> &	shippingOptions = std::vector< Ptr< ShippingOption >>(),
		const std::string &	errorMessage = ""
	)		const

If you sent an invoice requesting a shipping address and the parameter isFlexible was specified, the Bot API will send an Update with a shippingQuery 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	Optional. Array of ShippingOption, Required if ok is True. A JSON-serialized array of available shipping options.
errorMessage	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#answershippingquery

answerWebAppQuery()

Ptr<SentWebAppMessage> tgbotxx::Api::answerWebAppQuery	(	const std::string &	webAppQueryId,
		const 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.

Parameters

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

Returns

a SentWebAppMessage object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#answerwebappquery

banChatMember()

bool tgbotxx::Api::banChatMember	(	const std::variant< std::int64_t, std::string > &	chatId,
		std::int64_t	userId,
		std::time_t	untilDate = 0,
		bool	revokeMessages = false
	)		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. https://core.telegram.org/bots/api#unbanchatmember.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user
untilDate	Optional. 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. . AApplied for supergroups and channels only.
revokeMessages	Optional. 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

True on success.

Exceptions

Exception

on failure

Note

You can't ban members in private chats https://core.telegram.org/bots/api#banchatmember

close()

bool tgbotxx::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.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#close

closeGeneralForumTopic()

bool tgbotxx::Api::closeGeneralForumTopic

(

const 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 canManageTopics administrator right in the supergroup.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#closegeneralforumtopic

copyMessage()

Ptr<MessageId> tgbotxx::Api::copyMessage	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< std::int64_t, std::string > &	fromChatId,
		std::int32_t	messageId,
		std::int32_t	messageThreadId = 0,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
fromChatId	Integer or String identifier for the chat where the original message was sent (or channel username in the format @channelusername)
messageId	Message identifier in the chat specified in fromChatId
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
caption	Optional. New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept
parseMode	Optional. Mode for parsing entities in the message text. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
disableWebPagePreview	Optional. Disables link previews for links in this message
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the MessageId of the sent message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#copymessage

createInvoiceLink()

std::string tgbotxx::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< Ptr< LabeledPrice >> &	prices,
		std::int32_t	maxTipAmount = 0,
		const std::vector< std::int32_t > &	suggestedTipAmounts = std::vector< std::int32_t >(),
		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

Use this method to create a link for an invoice. Returns the created invoice link as std::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 for your internal processes.
providerToken	Payment provider token, obtained via @BotFather
currency	Three-letter ISO 4217 currency code, see more on currencies
prices	Array of LabeledPrice, Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
maxTipAmount	Optional. 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
suggestedTipAmounts	Optional. 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 maxTipAmount.
startParameter	Optional. 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
providerData	Optional. 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	Optional. 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	Optional. Photo size in bytes
photoWidth	Optional. Photo width
photoHeight	Optional. Photo height
needName	Optional. Pass True if you require the user's full name to complete the order
needPhoneNumber	Optional. Pass True if you require the user's phone number to complete the order
needEmail	Optional. Pass True if you require the user's email address to complete the order
needShippingAddress	Optional. Pass True if you require the user's shipping address to complete the order
sendPhoneNumberToProvider	Optional. Pass True if the user's phone number should be sent to provider
sendEmailToProvider	Optional. Pass True if the user's email address should be sent to provider
isFlexible	Optional. Pass True if the final price depends on the shipping method

Returns

the created invoice link as std::string on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#createinvoicelink

createNewStickerSet()

bool tgbotxx::Api::createNewStickerSet	(	std::int64_t	userId,
		const std::string &	name,
		const std::string &	title,
		const std::vector< Ptr< InputSticker >> &	stickers,
		const std::string &	stickerFormat,
		const std::string &	stickerType = "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.

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
stickerFormat	Format of stickers in the set, must be one of “static”, “animated”, “video”
stickerType	Optional. Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
needsRepainting	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#createnewstickerset

deleteMessage()

bool tgbotxx::Api::deleteMessage	(	const 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 canPostMessages 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 canDeleteMessages permission in a supergroup or a channel, it can delete any message there.

Parameters

chatId	Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Identifier of the message to delete

Returns

Returns True on success. https://core.telegram.org/bots/api#deletemessage

deleteMyCommands()

bool tgbotxx::Api::deleteMyCommands	(	const 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. https://core.telegram.org/bots/api#determining-list-of-commands.

Parameters

scope	Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
languageCode	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#deletemycommands

deleteStickerFromSet()

bool tgbotxx::Api::deleteStickerFromSet

(

const std::string &

sticker

)

const

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

Parameters

sticker

File identifier of the sticker

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#deletestickerfromset

deleteStickerSet()

bool tgbotxx::Api::deleteStickerSet

(

const std::string &

name

)

const

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

Parameters

name	Sticker set name

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#deletestickerset

deleteWebhook()

bool tgbotxx::Api::deleteWebhook

(

bool

dropPendingUpdates = false

)

const

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

Parameters

dropPendingUpdates

Optional. Pass True to drop all pending updates.

Returns

True on success.

Exceptions

Exception

on failure

Note

when Bot is not running, updates will remain 24 hours in Telegram server before they get deleted or retrieved by BOT

In order for Api::getUpdates() to work, there should be no outgoing webhook set up. See https://core.telegram.org/bots/api#getupdates https://core.telegram.org/bots/api#deletewebhook

downloadFile()

std::string tgbotxx::Api::downloadFile	(	const std::string &	filePath,
		const std::function< bool(cpr::cpr_off_t downloadTotal, cpr::cpr_off_t downloadNow)> &	progressCallback = nullptr
	)		const

Use this method to download a file from Telegram and save it in memory. For the moment, bots can download files of up to 20MB in size. See Api::getFile. 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.

Parameters

filePath	Telegram file path from Api::getFile(fileId) -> File::filePath
progressCallback	Optional. Download progress callback. Callback shall return true to continue downloading, or false to cancel the download.

Returns

std::string contains downloaded file contents.

Exceptions

Exception	on failure https://core.telegram.org/bots/api#getfile
Exception	on failure

editGeneralForumTopic()

bool tgbotxx::Api::editGeneralForumTopic	(	const 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 canManageTopics administrator right in the supergroup.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
name	New topic name, 1-128 characters

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#editgeneralforumtopic

editMessageCaption()

Ptr<Message> tgbotxx::Api::editMessageCaption	(	const std::variant< std::int64_t, std::string > &	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to edit captions of messages.

Parameters

chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the message to edit
inlineMessageId	Optional. Required if chatId and messageId are not specified. Identifier of the inline message
caption	Optional. New caption of the message, 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the message caption. See https://core.telegram.org/bots/api#formatting-options for more details.
captionEntities	Optional. List of special entities that appear in the caption, which can be specified instead of parseMode
replyMarkup	Optional. A JSON-serialized object for an inline keyboard.

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. https://core.telegram.org/bots/api#editmessagecaption

editMessageLiveLocation()

Ptr<Message> tgbotxx::Api::editMessageLiveLocation	(	float	latitude,
		float	longitude,
		const std::variant< std::int64_t, std::string > &	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		float	horizontalAccuracy = 0.0f,
		std::int32_t	heading = 0,
		std::int32_t	proximityAlertRadius = 0,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to edit live location messages. A location can be edited until its livePeriod expires or editing is explicitly disabled by a call to Api::stopMessageLiveLocation.

Parameters

latitude	Latitude of new location
longitude	Longitude of new location
chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the message to edit
inlineMessageId	Optional. Required if chatId and messageId are not specified. Identifier of the inline message
horizontalAccuracy	Optional. The radius of uncertainty for the location, measured in meters; 0-1500
heading	Optional. Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximityAlertRadius	Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
replyMarkup	Optional. A JSON-serialized object for a new inline keyboard.

Returns

On success, the edited Message is returned. Otherwise nullptr is returned. https://core.telegram.org/bots/api#editmessagelivelocation

editMessageMedia()

Ptr<Message> tgbotxx::Api::editMessageMedia	(	const Ptr< InputMedia > &	media,
		const std::variant< std::int64_t, std::string > &	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to edit animation, audio, document, photo, or video messages. 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 or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its fileId or specify a URL.

Parameters

media	A JSON-serialized object for a new media content of the message
chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the message to edit
inlineMessageId	Optional. Required if chatId and messageId are not specified. Identifier of the inline message
replyMarkup	Optional. A JSON-serialized object for a new inline keyboard.

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. https://core.telegram.org/bots/api#editmessagemedia

editMessageReplyMarkup()

Ptr<Message> tgbotxx::Api::editMessageReplyMarkup	(	const std::variant< std::int64_t, std::string > &	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the message to edit
inlineMessageId	Optional. Required if chatId and messageId are not specified. Identifier of the inline message
replyMarkup	Optional. A JSON-serialized object for an inline keyboard.

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. https://core.telegram.org/bots/api#editmessagereplymarkup

editMessageText()

Ptr<Message> tgbotxx::Api::editMessageText	(	const std::string &	text,
		const std::variant< std::int64_t, std::string > &	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	entities = std::vector< Ptr< MessageEntity >>(),
		bool	disableWebPagePreview = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to edit text and game messages.

Updating messages The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with inline keyboards using callback queries, but can also help reduce clutter in conversations with regular chat bots. Please note, that it is currently only possible to edit messages without reply_markup or with inline keyboards. https://core.telegram.org/bots/api#updating-messages

Parameters

text	New text of the message, 1-4096 characters after entities parsing
chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the message to edit
inlineMessageId	Optional. Required if chatId and messageId are not specified. Identifier of the inline message
parseMode	Optional. Mode for parsing entities in the message text. See https://core.telegram.org/bots/api#formatting-options for more details.
entities	Optional. List of special entities that appear in message text, which can be specified instead of parseMode
disableWebPagePreview	Optional. Disables link previews for links in this message
replyMarkup	Optional. A JSON-serialized object for an inline keyboard.

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. https://core.telegram.org/bots/api#editmessagetext

exportChatInviteLink()

std::string tgbotxx::Api::exportChatInviteLink

(

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

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
permissions	A ChatPermissions object for new user permissions
useIndependentChatPermissions	Optional. Pass True if chat permissions are set independently. Otherwise, the canSendOtherMessages and canAddWebPagePreviews permissions will imply the canSendMessages, canSendAudios, canSendDocuments, canSendPhotos, canSendVideos, canSendVideoNotes, and canSendVoiceNotes permissions; the canSendPolls permission will imply the canSendMessages permission.

Returns

The new invite link as std::string on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#exportchatinvitelink

Note

Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.

forwardMessage()

Ptr<Message> tgbotxx::Api::forwardMessage	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< std::int64_t, std::string > &	fromChatId,
		std::int32_t	messageId,
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false
	)		const

Use this method to forward messages of any kind. Service messages can't be forwarded.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
fromChatId	Integer or String Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
messageId	Message identifier in the chat specified in fromChatId
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#forwardmessage

getAllowedUpdates()

const std::vector<std::string>& tgbotxx::Api::getAllowedUpdates ( ) const

noexcept

Get list of the update types you want your bot to receive.

getChat()

Ptr<Chat> tgbotxx::Api::getChat

(

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

chatId

)

const

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

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

a Chat object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getchat

getChatAdministrators()

std::vector<Ptr<ChatMember> > tgbotxx::Api::getChatAdministrators

(

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

chatId

)

const

Use this method to get a list of administrators in a chat, which aren't bots.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

an Array of ChatMember objects.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getchatadministrators

getChatMember()

Ptr<ChatMember> tgbotxx::Api::getChatMember	(	const 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user

Returns

a ChatMember object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getchatmember

getChatMemberCount()

std::int32_t tgbotxx::Api::getChatMemberCount

(

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

chatId

)

const

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

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

std::int32_t on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getchatmembercount

getChatMenuButton()

Ptr<MenuButton> tgbotxx::Api::getChatMenuButton

(

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

chatId = std::string{}

)

const

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

Parameters

chatId

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

Returns

MenuButton object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getchatmenubutton

getConnectTimeout()

cpr::ConnectTimeout tgbotxx::Api::getConnectTimeout ( ) const

noexcept

Get Api requests connection timeout.

getCustomEmojiStickers()

std::vector<Ptr<Sticker> > tgbotxx::Api::getCustomEmojiStickers

(

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

customEmojiIds

)

const

Use this method to get information about custom emoji stickers by their identifiers.

Parameters

customEmojiIds

List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

Returns

an Array of Sticker objects on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getcustomemojistickers

getDownloadFilesTimeout()

cpr::Timeout tgbotxx::Api::getDownloadFilesTimeout ( ) const

noexcept

Get Api file downloads timeout.

getFile()

Ptr<File> tgbotxx::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. The file can then be downloaded using Api::downloadFile or via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response.

Parameters

fileId

File identifier to get information about

Returns

a File object is returned on success.

Exceptions

Exception

on failure

Note

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.

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. https://core.telegram.org/bots/api#getfile

getGameHighScores()

std::vector<Ptr<GameHighScore> > tgbotxx::Api::getGameHighScores	(	std::int64_t	userId,
		std::int64_t	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = ""
	)		const

Use this method to get data for high score tables.

Parameters

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

Returns

an Array of GameHighScore objects.

Note

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getgamehighscores

getLongPollTimeout()

cpr::Timeout tgbotxx::Api::getLongPollTimeout ( ) const

noexcept

Get long polling timeout.

getMe()

Ptr<User> tgbotxx::Api::getMe

(

)

const

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

Bot Api Methods https://core.telegram.org/bots/api#available-methods

Returns

basic information about the bot in form of a User object.

Exceptions

Exception

on failure

getMyCommands()

std::vector<Ptr<BotCommand> > tgbotxx::Api::getMyCommands	(	const 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.

Parameters

scope	Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
languageCode	Optional. 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

an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getmycommands

getMyDefaultAdministratorRights()

Ptr<ChatAdministratorRights> tgbotxx::Api::getMyDefaultAdministratorRights

(

bool

forChannels = false

)

const

Use this method to get the current default administrator rights of the bot.

Parameters

forChannels

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

ChatAdministratorRights object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getmydefaultadministratorrights

getMyDescription()

Ptr<BotDescription> tgbotxx::Api::getMyDescription

(

const std::string &

languageCode = ""

)

const

Use this method to get the current bot description for the given user language.

Parameters

languageCode

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

Returns

BotDescription object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getmydescription

getMyName()

Ptr<BotName> tgbotxx::Api::getMyName

(

const std::string &

languageCode = ""

)

const

Use this method to get the current bot name for the given user language.

Parameters

languageCode

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

Returns

BotName object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getmyname

getMyShortDescription()

Ptr<BotShortDescription> tgbotxx::Api::getMyShortDescription

(

const std::string &

languageCode = ""

)

const

Use this method to get the current bot short description for the given user language.

Parameters

languageCode

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

Returns

BotShortDescription object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getmyshortdescription

getStickerSet()

Ptr<StickerSet> tgbotxx::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

StickerSet object is returned on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getstickerset

getTimeout()

cpr::Timeout tgbotxx::Api::getTimeout ( ) const

noexcept

Get Api requests timeout.

getUpdates()

std::vector<Ptr<Update> > tgbotxx::Api::getUpdates	(	std::int32_t	offset,
		std::int32_t	limit = 100
	)		const

Use this method to receive incoming updates using long polling.

Updates methods https://core.telegram.org/bots/api#getting-updates

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.

Returns

an Array of Update objects.

Exceptions

Exception

on failure

Note

Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.

This method will not work if an outgoing webhook is set up.

In order to avoid getting duplicate updates, recalculate offset after each server response. https://core.telegram.org/bots/api#getupdates

getUploadFilesTimeout()

cpr::Timeout tgbotxx::Api::getUploadFilesTimeout ( ) const

noexcept

Get Api file uploads timeout.

getUrl()

const std::string& tgbotxx::Api::getUrl ( ) const

noexcept

Get Api URL.

getUserProfilePhotos()

Ptr<UserProfilePhotos> tgbotxx::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.

Parameters

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

Returns

UserProfilePhotos object.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getuserprofilephotos

getWebhookInfo()

Ptr<WebhookInfo> tgbotxx::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

a WebhookInfo object on success. If the bot is using getUpdates, will return an object with the WebhookInfo::url field empty.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#getwebhookinfo

hideGeneralForumTopic()

bool tgbotxx::Api::hideGeneralForumTopic

(

const 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 canManageTopics administrator right in the supergroup.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#hidegeneralforumtopic

leaveChat()

bool tgbotxx::Api::leaveChat

(

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

chatId

)

const

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

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#leavechat

logOut()

bool tgbotxx::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.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#logout

promoteChatMember()

bool tgbotxx::Api::promoteChatMember	(	const std::variant< std::int64_t, std::string > &	chatId,
		std::int64_t	userId,
		bool	isAnonymous = false,
		bool	canManageChat = false,
		bool	canDeleteMessages = false,
		bool	canManageVideoChats = false,
		bool	canRestrictMembers = false,
		bool	canPromoteMembers = false,
		bool	canChangeInfo = false,
		bool	canInviteUsers = false,
		bool	canPostMessages = false,
		bool	canEditMessages = false,
		bool	canPinMessages = false,
		bool	canPostStories = false,
		bool	canEditStories = false,
		bool	canDeleteStories = false,
		bool	canManageTopics = 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user
isAnonymous	Optional. Pass True if the administrator's presence in the chat is hidden
canManageChat	Optional. Pass True if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
canDeleteMessages	Optional. Pass True if the administrator can delete messages of other users
canManageVideoChats	Optional. Pass True if the administrator can manage video chats
canRestrictMembers	Optional. Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics
canPromoteMembers	Optional. 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)
canChangeInfo	Optional. Pass True if the administrator can change chat title, photo and other settings
canInviteUsers	Optional. Pass True if the administrator can invite new users to the chat
canPostMessages	Optional. Pass True if the administrator can post messages in the channel, or access channel statistics; channels only
canEditMessages	Optional. Pass True if the administrator can edit messages of other users and can pin messages; channels only
canPinMessages	Optional. Pass True if the administrator can pin messages, supergroups only
canPostStories	Optional. Pass True if the administrator can post stories in the channel; channels only
canEditStories	Optional. Pass True if the administrator can edit stories posted by other users; channels only
canDeleteStories	Optional. Pass True if the administrator can delete stories posted by other users; channels only
canManageTopics	Optional. Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#promotechatmember

reopenGeneralForumTopic()

bool tgbotxx::Api::reopenGeneralForumTopic

(

const 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 canManageTopics administrator right in the supergroup.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#reopengeneralforumtopic

restrictChatMember()

bool tgbotxx::Api::restrictChatMember	(	const std::variant< std::int64_t, std::string > &	chatId,
		std::int64_t	userId,
		const Ptr< ChatPermissions > &	permissions,
		bool	useIndependentChatPermissions = false,
		std::time_t	untilDate = 0
	)		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 of ChatPermissions object to lift restrictions from a user.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user
permissions	A ChatPermissions object for new user permissions
useIndependentChatPermissions	Optional. 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.
untilDate	Optional. 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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#restrictchatmember

sendAnimation()

Ptr<Message> tgbotxx::Api::sendAnimation	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	animation,
		std::int32_t	messageThreadId = 0,
		std::int32_t	duration = 0,
		std::int32_t	width = 0,
		std::int32_t	height = 0,
		const std::optional< std::variant< cpr::File, std::string >> &	thumbnail = std::nullopt,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		bool	hasSpoiler = false,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
animation	Animation to send. Pass a fileId as String to send an animation that exists on the Telegram servers (recommended), Pass an HTTP URL as a String for Telegram to get a animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
duration	Optional. Duration of sent animation in seconds
width	Optional. Animation width
height	Optional. Animation height
thumbnail	Optional. 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 » https://core.telegram.org/bots/api#sending-files
caption	Optional. Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the animation caption. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
hasSpoiler	Optional. Pass True if the animation needs to be covered with a spoiler animation
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure

Note

Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. https://core.telegram.org/bots/api#sendanimation

sendAudio()

Ptr<Message> tgbotxx::Api::sendAudio	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	audio,
		std::int32_t	messageThreadId = 0,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		std::int32_t	duration = 0,
		const std::string &	performer = "",
		const std::string &	title = "",
		const std::optional< std::variant< cpr::File, std::string >> &	thumbnail = std::nullopt,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
audio	Audio file to send. cpr::File or std::string. Pass a fileId 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 » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
caption	Optional. Audio caption, 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the audio caption. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
duration	Optional. Duration of the audio in seconds
performer	Optional. Performer
title	Optional. Track name
thumbnail	Optional. 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 » https://core.telegram.org/bots/api#sending-files
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure

Note

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. https://core.telegram.org/bots/api#sendaudio

sendChatAction()

bool tgbotxx::Api::sendChatAction	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::string &	action,
		std::int32_t	messageThreadId = 0
	)		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).

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
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" "upload_video_note" for video notes
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

Returns

True on success.

Exceptions

Exception

on failure Example: The ImageBot needs some time to process a request and upload the image. https://t.me/imagebot Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.

Note

We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. https://core.telegram.org/bots/api#sendchataction

sendContact()

Ptr<Message> tgbotxx::Api::sendContact	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::string &	phoneNumber,
		const std::string &	firstName,
		const std::string &	lastName = "",
		const std::string &	vcard = "",
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send phone contacts.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
phoneNumber	Contact's phone number
firstName	Contact's first name
lastName	Optional. Contact's last name
vcard	Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes https://en.wikipedia.org/wiki/VCard
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendcontact

sendDice()

Ptr<Message> tgbotxx::Api::sendDice	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::string &	emoji = "🎲",
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
emoji	Optional. 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	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#senddice

sendDocument()

Ptr<Message> tgbotxx::Api::sendDocument	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	document,
		std::int32_t	messageThreadId = 0,
		const std::optional< std::variant< cpr::File, std::string >> &	thumbnail = std::nullopt,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send general files.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
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 » » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
thumbnail	Optional. 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 » https://core.telegram.org/bots/api#sending-files
caption	Optional. Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the document text. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure

Note

Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

For sending voice messages, use the sendVoice method instead. https://core.telegram.org/bots/api#senddocument

sendGame()

Ptr<Message> tgbotxx::Api::sendGame	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::string &	gameShortName,
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		const Ptr< ReplyParameters > &	replyParameters = nullptr,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send a game.

Games

Parameters

chatId	Unique identifier for the target chat
gameShortName	Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyParameters	Optional. Description of the message to reply to
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendgame

sendInvoice()

Ptr<Message> tgbotxx::Api::sendInvoice	(	const 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< Ptr< LabeledPrice >> &	prices,
		std::int32_t	messageThreadId = 0,
		std::int32_t	maxTipAmount = 0,
		const std::vector< std::int32_t > &	suggestedTipAmounts = std::vector< std::int32_t >(),
		const std::string &	startParameter = "",
		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,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send invoices.

Payments methods https://core.telegram.org/bots/api#payments

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
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 for your internal processes.
providerToken	Payment provider token, obtained via @BotFather
currency	Three-letter ISO 4217 currency code, see more on currencies
prices	Array of LabeledPrice, Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
maxTipAmount	Optional. 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
suggestedTipAmounts	Optional. 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 maxTipAmount.
startParameter	Optional. 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
providerData	Optional. 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	Optional. 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	Optional. Photo size in bytes
photoWidth	Optional. Photo width
photoHeight	Optional. Photo height
needName	Optional. Pass True if you require the user's full name to complete the order
needPhoneNumber	Optional. Pass True if you require the user's phone number to complete the order
needEmail	Optional. Pass True if you require the user's email address to complete the order
needShippingAddress	Optional. Pass True if you require the user's shipping address to complete the order
sendPhoneNumberToProvider	Optional. Pass True if the user's phone number should be sent to provider
sendEmailToProvider	Optional. Pass True if the user's email address should be sent to provider
isFlexible	Optional. Pass True if the final price depends on the shipping method
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. 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. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

sent Message object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendinvoice

sendLocation()

Ptr<Message> tgbotxx::Api::sendLocation	(	const std::variant< std::int64_t, std::string > &	chatId,
		float	latitude,
		float	longitude,
		std::int32_t	messageThreadId = 0,
		float	horizontalAccuracy = 0.0f,
		std::int32_t	livePeriod = 0,
		std::int32_t	heading = 0,
		std::int32_t	proximityAlertRadius = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send point on the map.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
latitude	Latitude of the location
longitude	Longitude of the location
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
horizontalAccuracy	Optional. The radius of uncertainty for the location, measured in meters; 0-1500
livePeriod	Optional. Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. https://telegram.org/blog/live-locations
heading	Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximityAlertRadius	Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendlocation

sendMediaGroup()

std::vector<Ptr<Message> > tgbotxx::Api::sendMediaGroup	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::vector< Ptr< InputMedia >> &	media,
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false
	)		const

Use this method to send a group of 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
media	A JSON-serialized array describing messages to be sent, must include 2-10 items. Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto and InputMediaVideo https://core.telegram.org/bots/api#inputmedia
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found

Returns

an array of Messages that were sent.

Exceptions

Exception

on failure

Note

Documents and audio files can be only grouped in an album with messages of the same type. https://core.telegram.org/bots/api#sendmediagroup

sendMessage()

Ptr<Message> tgbotxx::Api::sendMessage	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::string &	text,
		std::int32_t	messageThreadId = 0,
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	entities = std::vector< Ptr< MessageEntity >>(),
		bool	disableWebPagePreview = false,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
text	Text of the message to be sent, 1-4096 characters after entities parsing
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode	Optional. Mode for parsing entities in the message text. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
entities	Optional. A JSON-serialized list of special entities that appear in message text, which can be specified instead of parseMode
disableWebPagePreview	Optional. Disables link previews for links in this message
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

sent Message object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendmessage

sendPhoto()

Ptr<Message> tgbotxx::Api::sendPhoto	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	photo,
		std::int32_t	messageThreadId = 0,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send photos.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
photo	Photo to send. cpr::File or std::string. Pass a fileId 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 » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
caption	Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the photo caption. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendphoto

sendPoll()

Ptr<Message> tgbotxx::Api::sendPoll	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::string &	question,
		const std::vector< std::string > &	options,
		bool	isAnonymous = true,
		const std::string &	type = "regular",
		bool	allowsMultipleAnswers = false,
		std::int32_t	correctOptionId = -1,
		const std::string &	explanation = "",
		const std::string &	explanationParseMode = "",
		const std::vector< Ptr< MessageEntity >> &	explanationEntities = std::vector< Ptr< MessageEntity >>(),
		std::int32_t	openPeriod = 0,
		std::int32_t	closeDate = 0,
		bool	isClosed = false,
		std::int32_t	messageThreadId = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send a native poll.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
question	Poll question, 1-300 characters
options	A list of answer options, 2-10 strings 1-100 characters each
isAnonymous	Optional. True, if the poll needs to be anonymous, defaults to True
type	Optional. Poll type, “quiz” or “regular”, defaults to “regular”
allowsMultipleAnswers	Optional. True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
correctOptionId	Optional. 0-based identifier of the correct answer option, required for polls in quiz mode
explanation	Optional. 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	Optional. Mode for parsing entities in the explanation. See formatting options for more details.
explanationEntities	Optional. A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parseMode
openPeriod	Optional. Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with closeDate.
closeDate	Optional. Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with openPeriod.
isClosed	Optional. Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendpoll

sendSticker()

Ptr<Message> tgbotxx::Api::sendSticker	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	sticker,
		std::int32_t	messageThreadId = 0,
		const std::string &	emoji = "",
		bool	disableNotification = false,
		bool	protectContent = false,
		const Ptr< ReplyParameters > &	replyParameters = nullptr,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Stickers

Parameters

chatId	Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sticker	Sticker to send. Pass a file_id std::string to send a file that exists on the Telegram servers (recommended), Pass an HTTP URL as an std::string for Telegram to get a .WEBP sticker from the Internet, or Pass a cpr::File to upload a new .WEBP or .TGS sticker
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
emoji	Optional. Emoji associated with the sticker; only for just uploaded stickers
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyParameters	Optional. Description of the message to reply to
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

sent Message object on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendsticker

sendVenue()

Ptr<Message> tgbotxx::Api::sendVenue	(	const std::variant< std::int64_t, std::string > &	chatId,
		float	latitude,
		float	longitude,
		const std::string &	title,
		const std::string &	address,
		std::int32_t	messageThreadId = 0,
		const std::string &	foursquareId = "",
		const std::string &	foursquareType = "",
		const std::string &	googlePlaceId = "",
		const std::string &	googlePlaceType = "",
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

Use this method to send information about a venue.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
latitude	Latitude of the venue
longitude	Longitude of the venue
title	Name of the venue
address	Address of the venue
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
foursquareId	Optional. Foursquare identifier of the venue
foursquareType	Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
googlePlaceId	Optional. Google Places identifier of the venue
googlePlaceType	Optional. Google Places type of the venue. (See supported types. https://developers.google.com/places/web-service/supported_types)
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#sendvenue

sendVideo()

Ptr<Message> tgbotxx::Api::sendVideo	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	video,
		std::int32_t	messageThreadId = 0,
		std::int32_t	duration = 0,
		std::int32_t	width = 0,
		std::int32_t	height = 0,
		const std::optional< std::variant< cpr::File, std::string >> &	thumbnail = std::nullopt,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		bool	hasSpoiler = false,
		bool	supportsStreaming = false,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
video	Video to send. Pass a fileId 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 » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
duration	Optional. Duration of sent video in seconds
width	Optional. Video width
height	Optional. Video height
thumbnail	Optional. 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 » https://core.telegram.org/bots/api#sending-files
caption	Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the video caption. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
hasSpoiler	Optional. Pass True if the video needs to be covered with a spoiler animation
supportsStreaming	Optional. Pass True if the uploaded video is suitable for streaming
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure

Note

Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. https://core.telegram.org/bots/api#sendvideo

sendVideoNote()

Ptr<Message> tgbotxx::Api::sendVideoNote	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	videoNote,
		std::int32_t	messageThreadId = 0,
		std::int32_t	duration = 0,
		std::int32_t	length = 0,
		const std::optional< std::variant< cpr::File, std::string >> &	thumbnail = std::nullopt,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = 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. https://telegram.org/blog/video-messages-and-telescope.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
videoNote	Video note to send. Pass a fileId as String to send a video note 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 » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
duration	Optional. Duration of sent video in seconds
length	Optional. Video width and height, i.e. diameter of the video message
thumbnail	Optional. 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 » https://core.telegram.org/bots/api#sending-files
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure

Note

Sending video notes by a URL is currently unsupported

Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. https://core.telegram.org/bots/api#sendvideonote

sendVoice()

Ptr<Message> tgbotxx::Api::sendVoice	(	const std::variant< std::int64_t, std::string > &	chatId,
		const std::variant< cpr::File, std::string > &	voice,
		std::int32_t	messageThreadId = 0,
		const std::string &	caption = "",
		const std::string &	parseMode = "",
		const std::vector< Ptr< MessageEntity >> &	captionEntities = std::vector< Ptr< MessageEntity >>(),
		std::int32_t	duration = 0,
		bool	disableNotification = false,
		bool	protectContent = false,
		std::int32_t	replyToMessageId = 0,
		bool	allowSendingWithoutReply = false,
		const Ptr< IReplyMarkup > &	replyMarkup = 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 (other formats may be sent as Audio or Document). Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
voice	Audio file to send. Pass a fileId 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 file using multipart/form-data. More information on Sending Files » https://core.telegram.org/bots/api#sending-files
messageThreadId	Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
caption	Optional. Voice message caption, 0-1024 characters after entities parsing
parseMode	Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. https://core.telegram.org/bots/api#formatting-options
captionEntities	Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode
duration	Optional. Duration of the voice message in seconds
disableNotification	Optional. Sends the message silently. Users will receive a notification with no sound.
protectContent	Optional. Protects the contents of the sent message from forwarding and saving
replyToMessageId	Optional. If the message is a reply, ID of the original message
allowSendingWithoutReply	Optional. Pass True if the message should be sent even if the specified replied-to message is not found
replyMarkup	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. One of InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply.

Returns

the sent Message on success.

Exceptions

Exception

on failure

Note

Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. https://core.telegram.org/bots/api#sendvoice

setAllowedUpdates()

void tgbotxx::Api::setAllowedUpdates ( const std::vector< std::string > &  allowedUpdates )

noexcept

Parameters

allowedUpdates

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 (default). If not specified, the previous setting will be used.

setChatAdministratorCustomTitle()

bool tgbotxx::Api::setChatAdministratorCustomTitle	(	const 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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setchatadministratorcustomtitle

setChatDescription()

bool tgbotxx::Api::setChatDescription	(	const 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
description	Optional. New chat description, 0-255 characters

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setchatdescription

setChatMenuButton()

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

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

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setmyshortdescription

setChatPermissions()

bool tgbotxx::Api::setChatPermissions	(	const std::variant< std::int64_t, std::string > &	chatId,
		const 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 canRestrictMembers administrator rights.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
permissions	A ChatPermissions object for new user permissions
useIndependentChatPermissions	Optional. Pass True if chat permissions are set independently. Otherwise, the canSendOtherMessages and canAddWebPagePreviews permissions will imply the canSendMessages, canSendAudios, canSendDocuments, canSendPhotos, canSendVideos, canSendVideoNotes, and canSendVoiceNotes permissions; the canSendPolls permission will imply the canSendMessages permission.

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setchatpermissions

setChatTitle()

bool tgbotxx::Api::setChatTitle	(	const 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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setchattitle

setConnectTimeout()

void tgbotxx::Api::setConnectTimeout ( const cpr::ConnectTimeout &  timeout )

noexcept

Set Api requests connection timeout.

setCustomEmojiStickerSetThumbnail()

bool tgbotxx::Api::setCustomEmojiStickerSetThumbnail	(	const std::string &	name,
		const std::optional< std::string > &	customEmojiId = std::nullopt
	)		const

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

Parameters

name	Sticker set name
customEmojiId	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail

setDownloadFilesTimeout()

void tgbotxx::Api::setDownloadFilesTimeout ( const cpr::Timeout &  timeout )

noexcept

Set Api file downloads timeout.

setGameScore()

Ptr<Message> tgbotxx::Api::setGameScore	(	std::int64_t	userId,
		std::int32_t	score,
		bool	force = false,
		bool	disableEditMessage = false,
		std::int64_t	chatId = 0,
		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.

Parameters

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

Returns

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.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setgamescore

setLongPollTimeout()

void tgbotxx::Api::setLongPollTimeout

(

const cpr::Timeout &

longPollTimeout

)

Set long polling timeout.

setMessageReaction()

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

Use this method to change the chosen reactions on a message. Service messages 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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
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	Optional. 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.
isBig	Optional. Pass True to set the reaction with a big animation

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setmessagereaction

setMyCommands()

bool tgbotxx::Api::setMyCommands	(	const std::vector< Ptr< BotCommand >> &	commands,
		const 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. https://core.telegram.org/bots/features#commands.

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	Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
languageCode	Optional. 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

True on success.

Exceptions

Exception

on failure

Note

Commands must not contain spaces and must be in snake case e.g "do_something" ✅ or "dosomthing" ✅ and not "doSomething" 𐄂 or "do something" 𐄂. https://core.telegram.org/bots/api#setmycommands

setMyDefaultAdministratorRights()

bool tgbotxx::Api::setMyDefaultAdministratorRights	(	const 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.

Parameters

rights	Optional. A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.
forChannels	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setmydefaultadministratorrights

setMyDescription()

bool tgbotxx::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.

Parameters

description	Optional. New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
languageCode	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setmydescription

setMyName()

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

Use this method to change the bot's name.

Parameters

name	Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.
languageCode	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setmyname

setMyShortDescription()

bool tgbotxx::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.

Parameters

shortDescription	Optional. New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
languageCode	Optional. 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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setmyshortdescription

setPassportDataErrors()

bool tgbotxx::Api::setPassportDataErrors	(	std::int64_t	userId,
		const std::vector< 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). 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.

Passport

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setpassportdataerrors

setStickerEmojiList()

bool tgbotxx::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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setstickeremojilist

setStickerKeywords()

bool tgbotxx::Api::setStickerKeywords	(	const std::string &	sticker,
		const std::vector< std::string > &	keywords = std::vector< std::string >()
	)		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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setstickerkeywords

setStickerMaskPosition()

bool tgbotxx::Api::setStickerMaskPosition	(	const std::string &	sticker,
		const 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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setstickermaskposition

setStickerPositionInSet()

bool tgbotxx::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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setstickerpositioninset

setStickerSetThumbnail()

bool tgbotxx::Api::setStickerSetThumbnail	(	const std::string &	name,
		const std::string &	title,
		const std::optional< std::variant< cpr::File, std::string >> &	thumbnail = std::nullopt
	)		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.

Parameters

name	Sticker set name
userId	User identifier of created sticker set owner
thumbnail	Optional. 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#animated-sticker-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-sticker-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

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setstickersetthumbnail

setStickerSetTitle()

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

Use this method to set the title of a created sticker set.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#setstickersettitle

setTimeout()

void tgbotxx::Api::setTimeout

(

const cpr::Timeout &

timeout

)

Set Api requests timeout.

setUploadFilesTimeout()

void tgbotxx::Api::setUploadFilesTimeout ( const cpr::Timeout &  timeout )

noexcept

Set Api file uploads timeout.

setUrl()

void tgbotxx::Api::setUrl ( const std::string &  url )

noexcept

Set Api URL.

Timeout setters/getters

setWebhook()

bool tgbotxx::Api::setWebhook	(	const std::string &	url,
		const std::optional< cpr::File > &	certificate = std::nullopt,
		const std::string &	ipAddress = "",
		std::int32_t	maxConnections = 40,
		const std::vector< std::string > &	allowedUpdates = std::vector< std::string >(),
		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, we will give up after a reasonable amount of attempts. 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	Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
ipAddress	Optional. The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
maxConnections	Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
allowedUpdates	Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (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.
dropPendingUpdates	Optional. Pass True to drop all pending updates.
secretToken	Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

Returns

True on success.

Exceptions

Exception

on failure

Note

You will not be able to receive updates using Api::getUpdates for as long as an outgoing webhook is set up.

To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.

Ports currently supported for webhooks: 443, 80, 88, 8443. If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks. https://core.telegram.org/bots/webhooks https://core.telegram.org/bots/api#setwebhook

stopMessageLiveLocation()

Ptr<Message> tgbotxx::Api::stopMessageLiveLocation	(	const std::variant< std::int64_t, std::string > &	chatId = 0,
		std::int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the message with live location to stop
inlineMessageId	Optional. Required if chatId and messageId are not specified. Identifier of the inline message
replyMarkup	Optional. A JSON-serialized object for a new inline keyboard.

Returns

On success, the edited Message is returned. Otherwise nullptr is returned. https://core.telegram.org/bots/api#stopmessagelivelocation

stopPoll()

Ptr<Poll> tgbotxx::Api::stopPoll	(	const std::variant< std::int64_t, std::string > &	chatId,
		std::int32_t	messageId,
		const Ptr< IReplyMarkup > &	replyMarkup = nullptr
	)		const

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

Parameters

chatId	Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Identifier of the original message with the poll
replyMarkup	Optional. A JSON-serialized object for a new message inline keyboard.

Returns

On success, the stopped Poll is returned. https://core.telegram.org/bots/api#stoppoll

unbanChatMember()

bool tgbotxx::Api::unbanChatMember	(	const 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 onlyIfBanned.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user
onlyIfBanned	Optional. Do nothing if the user is not banned

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#unbanchatmember

unhideGeneralForumTopic()

bool tgbotxx::Api::unhideGeneralForumTopic

(

const 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 canManageTopics administrator right in the supergroup.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#unhidegeneralforumtopic

unpinAllGeneralForumTopicMessages()

bool tgbotxx::Api::unpinAllGeneralForumTopicMessages

(

const 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 canPinMessages administrator right in the supergroup.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages

uploadStickerFile()

Ptr<File> tgbotxx::Api::uploadStickerFile	(	std::int64_t	userId,
		const cpr::File &	sticker,
		const std::string &	stickerFormat
	)		const

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

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

the uploaded File on success.

Exceptions

Exception

on failure https://core.telegram.org/bots/api#uploadstickerfile

Friends And Related Function Documentation

approveChatJoinRequest()

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

related

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 canInviteUsers administrator right.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user

Returns

True on success.

Exceptions

Exception

on failure

https://core.telegram.org/bots/api#approvechatjoinrequest

banChatSenderChat()

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

related

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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
senderChatId	Unique identifier of the target sender chat
customTitle	New custom title for the administrator; 0-16 characters, emoji are not allowed

Returns

True on success.

Exceptions

Exception

on failure

https://core.telegram.org/bots/api#banchatsenderchat

Bot

friend class Bot

friend

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 (default). If not specified, the previous setting will be used.

Definition at line 77 of file Api.hpp.

closeForumTopic()

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

related

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 canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

True on success.

Exceptions

Exception

on failure editForumTopic reopenForumTopic deleteForumTopic https://core.telegram.org/bots/api#closeforumtopic

createChatInviteLink()

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

related

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.

Parameters

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

Returns

the new invite link as ChatInviteLink object on success.

Exceptions

Exception

on failure revokeChatInviteLink https://core.telegram.org/bots/api#createchatinvitelink

createForumTopic()

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

related

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
name	Topic name, 1-128 characters
iconColor	Optional. 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	Optional. Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. https://core.telegram.org/bots/api#getforumtopiciconstickers

Returns

information about the created topic as a ForumTopic object.

Exceptions

Exception

on failure closeForumTopic reopenForumTopic deleteForumTopic https://core.telegram.org/bots/api#createforumtopic

declineChatJoinRequest()

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

related

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 canInviteUsers administrator right.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
userId	Unique identifier of the target user

Returns

True on success.

Exceptions

Exception

on failure

https://core.telegram.org/bots/api#declinechatjoinrequest

deleteChatPhoto()

bool deleteChatPhoto ( const std::variant< std::int64_t, std::string > &  chatId ) const

related

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.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure

https://core.telegram.org/bots/api#deletechatphoto

deleteChatStickerSet()

bool deleteChatStickerSet ( const std::variant< std::int64_t, std::string > &  chatId ) const

related

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 canSetStickerSet optionally returned in getChat requests to check if the bot can use this method.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure getForumTopicIconStickers Sticker::setName https://core.telegram.org/bots/api#deletechatstickerset

deleteForumTopic()

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

related

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

True on success.

Exceptions

Exception

on failure editForumTopic closeForumTopic reopenForumTopic https://core.telegram.org/bots/api#deleteforumtopic

editChatInviteLink()

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

related

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.

Parameters

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

Returns

The edited invite link as a ChatInviteLink object on success.

Exceptions

Exception

on failure revokeChatInviteLink https://core.telegram.org/bots/api#editchatinvitelink

editForumTopic()

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

related

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageThreadId	Unique identifier for the target message thread of the forum topic
name	Optional. New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept
iconCustomEmojiId	Optional. 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

True on success.

Exceptions

Exception

on failure closeForumTopic reopenForumTopic deleteForumTopic https://core.telegram.org/bots/api#editforumtopic

getForumTopicIconStickers()

std::vector<Ptr<Sticker> > getForumTopicIconStickers ( ) const

related

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

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

an Array of Sticker objects.

Exceptions

Exception

on failure deleteChatStickerSet https://core.telegram.org/bots/api#getforumtopiciconstickers

pinChatMessage()

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

related

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Identifier of a message to pin
disableNotification	Optional. 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

True on success.

Exceptions

Exception

on failure unpinAllChatMessages https://core.telegram.org/bots/api#pinchatmessage

reopenForumTopic()

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

related

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 canManageTopics administrator rights. https://core.telegram.org/bots/api#forumtopic.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

True on success.

Exceptions

Exception

on failure editForumTopic closeForumTopic deleteForumTopic https://core.telegram.org/bots/api#reopenforumtopic

revokeChatInviteLink()

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

related

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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
inviteLink	The invite link to revoke

Returns

The revoked invite link as ChatInviteLink object on success.

Exceptions

Exception

on failure editChatInviteLink https://core.telegram.org/bots/api#revokechatinvitelink

setChatPhoto()

bool setChatPhoto ( const std::variant< std::int64_t, std::string > &  chatId, const cpr::File &  photo  ) const

related

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.

Parameters

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

Returns

True on success.

Exceptions

Exception

on failure

https://core.telegram.org/bots/api#setchatphoto

setChatStickerSet()

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

related

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 canSetStickerSet optionally returned in getChat requests to check if the bot can use this method.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
stickerSetName	Name of the sticker set to be set as the group sticker set

Returns

True on success.

Exceptions

Exception

on failure getForumTopicIconStickers Sticker::setName https://core.telegram.org/bots/api#setchatstickerset

unbanChatSenderChat()

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

related

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.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
senderChatId	Unique identifier of the target sender chat
customTitle	New custom title for the administrator; 0-16 characters, emoji are not allowed

Returns

True on success.

Exceptions

Exception

on failure

https://core.telegram.org/bots/api#unbanchatsenderchat

unpinAllChatMessages()

bool unpinAllChatMessages ( const std::variant< std::int64_t, std::string > &  chatId ) const

related

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel.

Parameters

chatId

Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Returns

True on success.

Exceptions

Exception

on failure unpinChatMessage https://core.telegram.org/bots/api#unpinallchatmessages

unpinAllForumTopicMessages()

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

related

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

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageThreadId	Unique identifier for the target message thread of the forum topic

Returns

True on success.

Exceptions

Exception

on failure editForumTopic closeForumTopic reopenForumTopic deleteForumTopic https://core.telegram.org/bots/api#unpinallforumtopicmessages

unpinChatMessage()

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

related

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel.

Parameters

chatId	Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId	Optional. Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.

Returns

True on success.

Exceptions

Exception

on failure unpinAllChatMessages https://core.telegram.org/bots/api#unpinchatmessage

---

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

• include/tgbotxx/Api.hpp