TgBot::Api Class Reference

#include <Api.h>

Public Member Functions
	Api (const std::string &token)
User::Ptr	getMe () const
Message::Ptr	sendMessage (int64_t chatId, const std::string &text, bool disableWebPagePreview=false, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	forwardMessage (int64_t chatId, int64_t fromChatId, int32_t messageId, bool disableNotification=false) const
Message::Ptr	sendPhoto (int64_t chatId, const InputFile::Ptr photo, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendPhoto (int64_t chatId, const std::string &photoId, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendAudio (int64_t chatId, const InputFile::Ptr audio, const std::string &caption="", int32_t duration=0, const std::string &performer="", const std::string &title="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendAudio (int64_t chatId, const std::string &audioId, const std::string &caption="", int32_t duration=0, const std::string &performer="", const std::string &title="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendDocument (int64_t chatId, const InputFile::Ptr document, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendDocument (int64_t chatId, const std::string &documentId, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendSticker (int64_t chatId, const InputFile::Ptr sticker, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), bool disableNotification=false) const
Message::Ptr	sendSticker (int64_t chatId, const std::string &stickerId, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), bool disableNotification=false) const
StickerSet::Ptr	getStickerSet (const std::string &name) const
File::Ptr	uploadStickerFile (int32_t userId, const InputFile::Ptr pngSticker) const
bool	createNewStickerSet (int32_t userId, const std::string &name, const std::string &title, InputFile::Ptr pngSticker, const std::string &emojis, bool containsMasks=false, MaskPosition::Ptr maskPosition=nullptr) const
bool	createNewStickerSet (int32_t userId, const std::string &name, const std::string &title, const std::string &pngSticker, const std::string &emojis, bool containsMasks=false, MaskPosition::Ptr maskPosition=nullptr) const
bool	addStickerToSet (int32_t userId, const std::string &name, const std::string &title, InputFile::Ptr pngSticker, const std::string &emojis, MaskPosition::Ptr maskPosition=nullptr) const
bool	addStickerToSet (int32_t userId, const std::string &name, const std::string &title, const std::string &pngSticker, const std::string &emojis, MaskPosition::Ptr maskPosition=nullptr) const
bool	setStickerPositionInSet (const std::string &sticker, uint32_t position) const
bool	deleteStickerPositionInSet (const std::string &sticker) const
Message::Ptr	sendVideo (int64_t chatId, const InputFile::Ptr video, bool supportsStreaming=false, int32_t duration=0, int32_t width=0, int32_t height=0, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendVideo (int64_t chatId, const std::string &videoId, bool supportsStreaming=false, int32_t duration=0, int32_t width=0, int32_t height=0, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendVideoNote (int64_t chatId, const InputFile::Ptr videoNote, int64_t replyToMessageId=0, bool disableNotification=false, int32_t duration=0, int32_t length=0, const GenericReply::Ptr replyMarkup=GenericReply::Ptr())
Message::Ptr	sendVideoNote (int64_t chatId, const std::string &videoNote, int64_t replyToMessageId=0, bool disableNotification=false, int32_t duration=0, int32_t length=0, const GenericReply::Ptr replyMarkup=GenericReply::Ptr())
std::vector< Message::Ptr >	sendMediaGroup (int64_t chatId, const std::vector< InputMedia::Ptr > &media, bool disableNotification=false, int32_t replyToMessageId=0) const
Message::Ptr	sendVoice (int64_t chatId, const InputFile::Ptr voice, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendVoice (int64_t chatId, const std::string &voiceId, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), const std::string &parseMode="", bool disableNotification=false) const
Message::Ptr	sendLocation (int64_t chatId, float latitude, float longitude, uint32_t livePeriod=0, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >(), bool disableNotification=false) const
Message::Ptr	editMessageLiveLocation (float latitude, float longitude, int64_t chatId=0, int32_t messageId=0, int32_t inlineMessageId=0, const InlineKeyboardMarkup::Ptr replyMarkup=std::make_shared< InlineKeyboardMarkup >()) const
Message::Ptr	stopMessageLiveLocation (int64_t chatId=0, int32_t messageId=0, int32_t inlineMessageId=0, const InlineKeyboardMarkup::Ptr replyMarkup=std::make_shared< InlineKeyboardMarkup >()) const
Message::Ptr	sendVenue (int64_t chatId, float latitude, float longitude, const std::string &title, const std::string &address, const std::string &foursquareId="", bool disableNotification=false, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >()) const
Message::Ptr	sendContact (int64_t chatId, const std::string &phoneNumber, const std::string &firstName, const std::string &lastName="", bool disableNotification=false, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >()) const
void	sendChatAction (int64_t chatId, const std::string &action) const
UserProfilePhotos::Ptr	getUserProfilePhotos (int32_t userId, int32_t offset=0, int32_t limit=100) const
File::Ptr	getFile (const std::string &fileId) const
bool	leaveChat (int64_t chatId) const
Chat::Ptr	getChat (int64_t chatId) const
std::vector< ChatMember::Ptr >	getChatAdministrators (int64_t chatId) const
int32_t	getChatMembersCount (int64_t chatId) const
ChatMember::Ptr	getChatMember (int64_t chatId, int32_t userId) const
bool	setChatStickerSet (int64_t chatId, const std::string &stickerSetName) const
bool	deleteChatStickerSet (int64_t chatId) const
bool	answerCallbackQuery (const std::string &callbackQueryId, const std::string &text="", bool showAlert=false, const std::string &url="", int32_t cacheTime=0) const
Message::Ptr	editMessageText (const std::string &text, int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const std::string &parseMode="", bool disableWebPagePreview=false, const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >()) const
Message::Ptr	editMessageCaption (int64_t chatId=0, int32_t messageId=0, const std::string &caption="", const std::string &inlineMessageId="", const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >()) const
Message::Ptr	editMessageReplyMarkup (int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const GenericReply::Ptr replyMarkup=std::make_shared< GenericReply >()) const
void	deleteMessage (int64_t chatId, int32_t messageId) const
std::vector< Update::Ptr >	getUpdates (int32_t offset=0, int32_t limit=100, int32_t timeout=0, const StringArrayPtr &allowedUpdates=nullptr) const
void	setWebhook (const std::string &url="", const InputFile::Ptr certificate=nullptr, int32_t maxConnection=40, const StringArrayPtr &allowedUpdates=nullptr) const
bool	deleteWebhook () const
WebhookInfo::Ptr	getWebhookInfo () const
bool	answerInlineQuery (const std::string &inlineQueryId, const std::vector< InlineQueryResult::Ptr > &results, int32_t cacheTime=300, bool isPersonal=false, const std::string &nextOffset="", const std::string &switchPmText="", const std::string &switchPmParameter="") const
bool	kickChatMember (int64_t chatId, int32_t userId, uint64_t untilDate=0) const
bool	unbanChatMember (int64_t chatId, int32_t userId) const
bool	restrictChatMember (int64_t chatId, int32_t userId, uint64_t untilDate=0, bool canSendMessages=false, bool canSendMediaMessages=false, bool canSendOtherMessages=false, bool canAddWebPagePreviews=false) const
bool	promoteChatMember (int64_t chatId, int32_t userId, bool canChangeInfo=false, bool canPostMessages=false, bool canEditMessages=false, bool canDeleteMessages=false, bool canInviteUsers=false, bool canPinMessages=false, bool canPromoteMembers=false) const
std::string	exportChatInviteLink (int64_t chatId) const
bool	setChatPhoto (int64_t chatId, const InputFile::Ptr photo) const
bool	deleteChatPhoto (int64_t chatId) const
bool	setChatTitle (int64_t chatId, const std::string &title) const
bool	setChatDescription (int64_t chatId, const std::string &description) const
bool	pinChatMessage (int64_t chatId, int32_t messageId, bool disableNotification=false) const
bool	unpinChatMessage (int64_t chatId) const
std::string	downloadFile (const std::string &filePath, const std::vector< HttpReqArg > &args=std::vector< HttpReqArg >()) const

Friends
class	Bot

Detailed Description

This class executes telegram api methods. Telegram docs: https://core.telegram.org/bots/api#available-methods

Definition at line 54 of file Api.h.

Constructor & Destructor Documentation

Api()

TgBot::Api::Api

(

const std::string &

token

)

Member Function Documentation

addStickerToSet() [1/2]

bool TgBot::Api::addStickerToSet	(	int32_t	userId,
		const std::string &	name,
		const std::string &	title,
		InputFile::Ptr	pngSticker,
		const std::string &	emojis,
		MaskPosition::Ptr	maskPosition = nullptr
	)		const

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

Parameters

userId	User identifier of created sticker set owner.
name	Sticker set name.
title	Sticker set title, 1-64 characters.
pngSticker	Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px.
emojis	One or more emoji corresponding to the sticker.
maskPosition	Optional. A JSON-serialized object for position where the mask should be placed on faces.

Returns

Returns True on success.

addStickerToSet() [2/2]

bool TgBot::Api::addStickerToSet	(	int32_t	userId,
		const std::string &	name,
		const std::string &	title,
		const std::string &	pngSticker,
		const std::string &	emojis,
		MaskPosition::Ptr	maskPosition = nullptr
	)		const

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

Parameters

userId	User identifier of created sticker set owner.
name	Sticker set name.
title	Sticker set title, 1-64 characters.
pngSticker	Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. 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.
emojis	One or more emoji corresponding to the sticker.
maskPosition	Optional. A JSON-serialized object for position where the mask should be placed on faces.

Returns

Returns True on success.

answerCallbackQuery()

bool TgBot::Api::answerCallbackQuery	(	const std::string &	callbackQueryId,
		const std::string &	text = "",
		bool	showAlert = false,
		const std::string &	url = "",
		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.

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 , specify the URL that opens your game – note that this will only work if the query comes from a callback_game button
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

answerInlineQuery()

bool TgBot::Api::answerInlineQuery	(	const std::string &	inlineQueryId,
		const std::vector< InlineQueryResult::Ptr > &	results,
		int32_t	cacheTime = 300,
		bool	isPersonal = false,
		const std::string &	nextOffset = "",
		const std::string &	switchPmText = "",
		const std::string &	switchPmParameter = ""
	)		const

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

Parameters

inlineQueryId	Unique identifier for the answered query.
results	Array of results for the inline query.
cacheTime	The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
isPersonal	Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
nextOffset	Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.
switchPmText	If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter
switchPmParameter	Parameter for the start message sent to the bot when user presses the switch button

Returns

True on success

createNewStickerSet() [1/2]

bool TgBot::Api::createNewStickerSet	(	int32_t	userId,
		const std::string &	name,
		const std::string &	title,
		InputFile::Ptr	pngSticker,
		const std::string &	emojis,
		bool	containsMasks = false,
		MaskPosition::Ptr	maskPosition = nullptr
	)		const

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

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.
pngSticker	Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px.
emojis	One or more emoji corresponding to the sticker.
containsMasks	Optional. Pass True, if a set of mask stickers should be created.
maskPosition	Optional. A JSON-serialized object for position where the mask should be placed on faces.

Returns

Returns True on success.

createNewStickerSet() [2/2]

bool TgBot::Api::createNewStickerSet	(	int32_t	userId,
		const std::string &	name,
		const std::string &	title,
		const std::string &	pngSticker,
		const std::string &	emojis,
		bool	containsMasks = false,
		MaskPosition::Ptr	maskPosition = nullptr
	)		const

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

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.
pngSticker	Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. 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.
emojis	One or more emoji corresponding to the sticker.
containsMasks	Optional. Pass True, if a set of mask stickers should be created.
maskPosition	Optional. A JSON-serialized object for position where the mask should be placed on faces.

Returns

Returns True on success.

deleteChatPhoto()

bool TgBot::Api::deleteChatPhoto

(

int64_t

chatId

)

const

Use this method to delete a chat photo. Photos can't be changed for private chats.

Parameters

chatId

Unique identifier for the target chat.

Returns

True on success

deleteChatStickerSet()

bool TgBot::Api::deleteChatStickerSet

(

int64_t

chatId

)

const

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

Parameters

chatId

Unique identifier for the target chat of the target supergroup or channel.

Returns

Returns True on success.

deleteMessage()

void TgBot::Api::deleteMessage	(	int64_t	chatId,
		int32_t	messageId
	)		const

Use this method to delete messages sent by bot (or by other users if bot is admin).

Parameters

chatId	Unique identifier for the target chat.
messageId	Unique identifier for the target message.

deleteStickerPositionInSet()

bool TgBot::Api::deleteStickerPositionInSet

(

const std::string &

sticker

)

const

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

Parameters

stickers

File identifier of the sticker.

Returns

Returns True on success.

deleteWebhook()

bool TgBot::Api::deleteWebhook

(

)

const

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

downloadFile()

std::string TgBot::Api::downloadFile	(	const std::string &	filePath,
		const std::vector< HttpReqArg > &	args = std::vector< HttpReqArg >()
	)		const

Downloads file from Telegram and saves it in memory.

Parameters

filePath	Telegram file path.
args	Additional api parameters.

Returns

File contents in a string.

editMessageCaption()

Message::Ptr TgBot::Api::editMessageCaption	(	int64_t	chatId = 0,
		int32_t	messageId = 0,
		const std::string &	caption = "",
		const std::string &	inlineMessageId = "",
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >()
	)		const

Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).

Parameters

chatId	Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel.
messageId	Optional Required if inline_message_id is not specified. Identifier of the sent message
caption	Optional New caption of the message
inlineMessageId	Optional Required if chat_id and message_id are not specified. Identifier of the inline message
replyMarkup	Optional A JSON-serialized object for an inline keyboard.

Returns

Message object on success, otherwise nullptr

editMessageLiveLocation()

Message::Ptr TgBot::Api::editMessageLiveLocation	(	float	latitude,
		float	longitude,
		int64_t	chatId = 0,
		int32_t	messageId = 0,
		int32_t	inlineMessageId = 0,
		const InlineKeyboardMarkup::Ptr	replyMarkup = std::make_shared< InlineKeyboardMarkup >()
	)		const

Use this method to edit live location messages sent by the bot or via the bot (for inline bots).

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 of the target channel.
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the sent message.
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 was sent by the bot, the edited Message is returned, otherwise nullptr is returned.

editMessageReplyMarkup()

Message::Ptr TgBot::Api::editMessageReplyMarkup	(	int64_t	chatId = 0,
		int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >()
	)		const

Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).

Parameters

chatId	Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel.
messageId	Optional Required if inline_message_id is not specified. Identifier of the sent message
inlineMessageId	Optional Required if chat_id and message_id are not specified. Identifier of the inline message
replyMarkup	Optional A JSON-serialized object for an inline keyboard.

Returns

Message object on success, otherwise nullptr

editMessageText()

Message::Ptr TgBot::Api::editMessageText	(	const std::string &	text,
		int64_t	chatId = 0,
		int32_t	messageId = 0,
		const std::string &	inlineMessageId = "",
		const std::string &	parseMode = "",
		bool	disableWebPagePreview = false,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >()
	)		const

Use this method to edit text and game messages sent by the bot or via the bot (for inline bots)

Parameters

text	New text of the message
chatId	Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel.
messageId	Optional Required if inline_message_id is not specified. Identifier of the sent message
inlineMessageId	Optional Required if chat_id and message_id are not specified. Identifier of the inline message
parseMode	Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableWebPagePreview	Optional Disables link previews for links in this message
replyMarkup	Optional A JSON-serialized object for an inline keyboard.

Returns

Message object on success, otherwise nullptr

exportChatInviteLink()

std::string TgBot::Api::exportChatInviteLink

(

int64_t

chatId

)

const

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

Parameters

chatId

Unique identifier for the target chat.

Returns

The new invite link as String on success.

forwardMessage()

Message::Ptr TgBot::Api::forwardMessage	(	int64_t	chatId,
		int64_t	fromChatId,
		int32_t	messageId,
		bool	disableNotification = false
	)		const

Use this method to forward messages of any kind.

Parameters

chatId	Unique identifier for the target chat.
fromChatId	Unique identifier for the chat where the original message was sent — User or GroupChat id.
messageId	Unique message identifier.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

getChat()

Chat::Ptr TgBot::Api::getChat

(

int64_t

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.). Returns a Chat object on success.

Parameters

chatId

Unique identifier for the target chat of the target supergroup or channel.

Returns

Chat object.

getChatAdministrators()

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

(

int64_t

chatId

)

const

Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

Parameters

chatId

Unique identifier for the target chat of the target supergroup or channel.

Returns

ChatMember object.

getChatMember()

ChatMember::Ptr TgBot::Api::getChatMember	(	int64_t	chatId,
		int32_t	userId
	)		const

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

Parameters

chatId	Unique identifier for the target chat of the target supergroup or channel.
userId	Unique identifier of the target user

Returns

ChatMember object.

getChatMembersCount()

int32_t TgBot::Api::getChatMembersCount

(

int64_t

chatId

)

const

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

Parameters

chatId

Unique identifier for the target chat of the target supergroup or channel.

Returns

Int.

getFile()

File::Ptr TgBot::Api::getFile

(

const std::string &

fileId

)

const

Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size.

Parameters

fileId

File identifier to get info about

Returns

A File object.

getMe()

User::Ptr TgBot::Api::getMe

(

)

const

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

Returns

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

getStickerSet()

StickerSet::Ptr TgBot::Api::getStickerSet

(

const std::string &

name

)

const

Use this method to get a sticker set.

Parameters

chatId

Name of the sticker set.

Returns

On success, a StickerSet object is returned.

getUpdates()

std::vector<Update::Ptr> TgBot::Api::getUpdates	(	int32_t	offset = 0,
		int32_t	limit = 100,
		int32_t	timeout = 0,
		const StringArrayPtr &	allowedUpdates = nullptr
	)		const

Use this method to receive incoming updates using long polling. 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.

Parameters

offset	Optional. 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.
limit	Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.
timeout	Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling.
allowed_updates	Optional. List the types of updates 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 updates regardless of type (default). If not specified, the previous setting will be used.

Returns

An Array of Update objects

getUserProfilePhotos()

UserProfilePhotos::Ptr TgBot::Api::getUserProfilePhotos	(	int32_t	userId,
		int32_t	offset = 0,
		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

A UserProfilePhotos object.

getWebhookInfo()

WebhookInfo::Ptr TgBot::Api::getWebhookInfo

(

)

const

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

kickChatMember()

bool TgBot::Api::kickChatMember	(	int64_t	chatId,
		int32_t	userId,
		uint64_t	untilDate = 0
	)		const

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

Parameters

chatId	Unique identifier for the target group.
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.

Returns

True on success

leaveChat()

bool TgBot::Api::leaveChat

(

int64_t

chatId

)

const

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

Parameters

chatId

Unique identifier for the target chat of the target supergroup or channel.

Returns

True on success

pinChatMessage()

bool TgBot::Api::pinChatMessage	(	int64_t	chatId,
		int32_t	messageId,
		bool	disableNotification = false
	)		const

Use this method to pin a message in a supergroup or a channel.

Parameters

chatId	Unique identifier for the target chat.
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.

Returns

True on success

promoteChatMember()

bool TgBot::Api::promoteChatMember	(	int64_t	chatId,
		int32_t	userId,
		bool	canChangeInfo = false,
		bool	canPostMessages = false,
		bool	canEditMessages = false,
		bool	canDeleteMessages = false,
		bool	canInviteUsers = false,
		bool	canPinMessages = false,
		bool	canPromoteMembers = false
	)		const

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

Parameters

chatId	Unique identifier for the target chat of the target supergroup or channal.
userId	Unique identifier of the target user.
canChangeInfo	Optional. Pass True, if the administrator can change chat title, photo and other settings.
canPostMessages	Optional. Pass True, if the administrator can create channel posts, channels only.
canEditMessages	Optional. Pass True, if the administrator can edit messages of other users and can pin messages, channels only.
canDeleteMessages	Optional. Pass True, if the administrator can delete messages of other users.
canInviteUsers	Optional. Pass True, if the administrator can invite new users to the chat.
canRestrictMembers	Optional. Pass True, if the administrator can restrict, ban or unban chat members.
canPinMessages	Optional. Pass True, if the administrator can pin messages, supergroups only.
canPromoteMembers	Optional. Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him).

Returns

True on success

restrictChatMember()

bool TgBot::Api::restrictChatMember	(	int64_t	chatId,
		int32_t	userId,
		uint64_t	untilDate = 0,
		bool	canSendMessages = false,
		bool	canSendMediaMessages = false,
		bool	canSendOtherMessages = false,
		bool	canAddWebPagePreviews = false
	)		const

Use this method to restrict a user in a supergroup.

Parameters

chatId	Unique identifier for the target chat of the target supergroup.
userId	Unique identifier of the target user.
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.
canSendMessages	Optional. Pass True, if the user can send text messages, contacts, locations and venues.
canSendMediaMessages	Optional. Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages.
canSendOtherMessages	Optional. Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages.
canAddWebPagePreviews	Optional. Pass True, if the user may add web page previews to their messages, implies can_send_media_messages.

Returns

True on success

sendAudio() [1/2]

Message::Ptr TgBot::Api::sendAudio	(	int64_t	chatId,
		const InputFile::Ptr	audio,
		const std::string &	caption = "",
		int32_t	duration = 0,
		const std::string &	performer = "",
		const std::string &	title = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		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 Document).

Parameters

chatId	Unique identifier for the target chat.
audio	Audio to send.
caption	Audio caption, 0-200 characters
duration	Duration of sent audio in seconds.
performer	Performer
title	Track name
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendAudio() [2/2]

Message::Ptr TgBot::Api::sendAudio	(	int64_t	chatId,
		const std::string &	audioId,
		const std::string &	caption = "",
		int32_t	duration = 0,
		const std::string &	performer = "",
		const std::string &	title = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		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 Document).

Parameters

chatId	Unique identifier for the target chat.
audio	Id of the audio that is already on the Telegram servers.
caption	Audio caption, 0-200 characters
duration	Duration of sent audio in seconds.
performer	Performer
title	Track name
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendChatAction()

void TgBot::Api::sendChatAction	(	int64_t	chatId,
		const std::string &	action
	)		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). Example: The ImageBot needs some time to process a request and upload the image. 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. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Parameters

chatId	Unique identifier for the target chat.
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_audio or upload_audio for audio files, upload_document for general files, find_location for location data.

sendContact()

Message::Ptr TgBot::Api::sendContact	(	int64_t	chatId,
		const std::string &	phoneNumber,
		const std::string &	firstName,
		const std::string &	lastName = "",
		bool	disableNotification = false,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >()
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
phoneNumber	Contact's phone number.
firstName	Contact's first name.
lastName	Contact's last name.
disableNotification	Optional. Sends the message silenty.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

Returns

On success, the sent message is returned.

sendDocument() [1/2]

Message::Ptr TgBot::Api::sendDocument	(	int64_t	chatId,
		const InputFile::Ptr	document,
		const std::string &	caption = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

Use this method to send general files.

Parameters

chatId	Unique identifier for the target chat.
document	Document to send.
caption	Document caption (may also be used when resending documents by file_id), 0-200 characters
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendDocument() [2/2]

Message::Ptr TgBot::Api::sendDocument	(	int64_t	chatId,
		const std::string &	documentId,
		const std::string &	caption = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

Use this method to send general files.

Parameters

chatId	Unique identifier for the target chat.
document	Id of the document that is already on the Telegram servers.
caption	Document caption (may also be used when resending documents by file_id), 0-200 characters
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendLocation()

Message::Ptr TgBot::Api::sendLocation	(	int64_t	chatId,
		float	latitude,
		float	longitude,
		uint32_t	livePeriod = 0,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		bool	disableNotification = false
	)		const

Use this method to send point on the map.

Parameters

chatId	Unique identifier for the target chat.
latitude	Latitude of location.
longitude	Longitude of location.
livePeriod	Optional. Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400).
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendMediaGroup()

std::vector<Message::Ptr> TgBot::Api::sendMediaGroup	(	int64_t	chatId,
		const std::vector< InputMedia::Ptr > &	media,
		bool	disableNotification = false,
		int32_t	replyToMessageId = 0
	)		const

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

Parameters

chatId	Unique identifier for the target chat of the target channel.
media	A JSON-serialized array describing photos and videos to be sent, must include 2–10 items.
disableNotification	Optional. Sends the messages silently. Users will receive a notification with no sound.
replyToMessageId	Optional. If the messages are a reply, ID of the original message.

Returns

On success, an array of the sent Messages is returned.

sendMessage()

Message::Ptr TgBot::Api::sendMessage	(	int64_t	chatId,
		const std::string &	text,
		bool	disableWebPagePreview = false,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

Use this method to send text messages.

Parameters

chatId	Unique identifier for the target chat.
text	Text of the message to be sent.
disableWebPagePreview	Optional. Disables link previews for links in this message.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendPhoto() [1/2]

Message::Ptr TgBot::Api::sendPhoto	(	int64_t	chatId,
		const InputFile::Ptr	photo,
		const std::string &	caption = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

Use this method to send photos.

Parameters

chatId	Unique identifier for the target chat.
photo	Photo to send.
caption	Optional. Photo caption.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendPhoto() [2/2]

Message::Ptr TgBot::Api::sendPhoto	(	int64_t	chatId,
		const std::string &	photoId,
		const std::string &	caption = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

Use this method to send photos.

Parameters

chatId	Unique identifier for the target chat.
photo	Photo to send. Id of the photo that is already on the Telegram servers.
caption	Optional. Photo caption.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendSticker() [1/2]

Message::Ptr TgBot::Api::sendSticker	(	int64_t	chatId,
		const InputFile::Ptr	sticker,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		bool	disableNotification = false
	)		const

Use this method to send .webp stickers.

Parameters

chatId	Unique identifier for the target chat.
sticker	Sticker to send.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendSticker() [2/2]

Message::Ptr TgBot::Api::sendSticker	(	int64_t	chatId,
		const std::string &	stickerId,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		bool	disableNotification = false
	)		const

Use this method to send .webp stickers.

Parameters

chatId	Unique identifier for the target chat.
stickerId	Id of the sticker that is already on the Telegram servers.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendVenue()

Message::Ptr TgBot::Api::sendVenue	(	int64_t	chatId,
		float	latitude,
		float	longitude,
		const std::string &	title,
		const std::string &	address,
		const std::string &	foursquareId = "",
		bool	disableNotification = false,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >()
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
latitude	Latitude of location.
longitude	Longitude of location.
title	Name of the venue.
address	Address of the venue.
foursquare_id	Foursquare identifier of the venue.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendVideo() [1/2]

Message::Ptr TgBot::Api::sendVideo	(	int64_t	chatId,
		const InputFile::Ptr	video,
		bool	supportsStreaming = false,
		int32_t	duration = 0,
		int32_t	width = 0,
		int32_t	height = 0,
		const std::string &	caption = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
video	Video to send.
supportsStreaming	Optional. Pass True, if the uploaded video is suitable for streaming.
duration	Optional. Duration of sent video in seconds
width	Optional. Video width
height	Optional. Video height
caption	Optional. Video caption (may also be used when resending videos by file_id), 0-200 characters
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendVideo() [2/2]

Message::Ptr TgBot::Api::sendVideo	(	int64_t	chatId,
		const std::string &	videoId,
		bool	supportsStreaming = false,
		int32_t	duration = 0,
		int32_t	width = 0,
		int32_t	height = 0,
		const std::string &	caption = "",
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
videoId	Id of the video that is already on the Telegram servers.
supportsStreaming	Optional. Pass True, if the uploaded video is suitable for streaming.
duration	Optional. Duration of sent video in seconds
width	Optional. Video width
height	Optional. Video height
caption	Optional. Video caption (may also be used when resending videos by file_id), 0-200 characters
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendVideoNote() [1/2]

Message::Ptr TgBot::Api::sendVideoNote	(	int64_t	chatId,
		const InputFile::Ptr	videoNote,
		int64_t	replyToMessageId = 0,
		bool	disableNotification = false,
		int32_t	duration = 0,
		int32_t	length = 0,
		const GenericReply::Ptr	replyMarkup = GenericReply::Ptr()
	)

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

Parameters

chatId	Unique identifier for the target chat.
videoNote	Video note to send.
replyToMessageId	If the message is a reply, ID of the original message.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
duration	Duration of sent video in seconds.
length	Video width and height.
replyMarkup	Additional interface options. A object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Returns

On success, the sent Message is returned.

sendVideoNote() [2/2]

Message::Ptr TgBot::Api::sendVideoNote	(	int64_t	chatId,
		const std::string &	videoNote,
		int64_t	replyToMessageId = 0,
		bool	disableNotification = false,
		int32_t	duration = 0,
		int32_t	length = 0,
		const GenericReply::Ptr	replyMarkup = GenericReply::Ptr()
	)

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

Parameters

chatId	Unique identifier for the target chat.
videoNote	Id of the video note that exists on the Telegram servers.
replyToMessageId	If the message is a reply, ID of the original message.
disableNotification	Sends the message silently. Users will receive a notification with no sound.
duration	Duration of sent video in seconds.
length	Video width and height.
replyMarkup	Additional interface options. A object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Returns

On success, the sent Message is returned.

sendVoice() [1/2]

Message::Ptr TgBot::Api::sendVoice	(	int64_t	chatId,
		const InputFile::Ptr	voice,
		const std::string &	caption = "",
		int	duration = 0,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
voice	Audio file to send.
caption	Voice message caption, 0-200 characters
duration	Duration of send audio in seconds.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

sendVoice() [2/2]

Message::Ptr TgBot::Api::sendVoice	(	int64_t	chatId,
		const std::string &	voiceId,
		const std::string &	caption = "",
		int	duration = 0,
		int32_t	replyToMessageId = 0,
		const GenericReply::Ptr	replyMarkup = std::make_shared< GenericReply >(),
		const std::string &	parseMode = "",
		bool	disableNotification = false
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
voiceId	Id of the voice that is already on the Telegram servers.
caption	Voice message caption, 0-200 characters
duration	Duration of send audio in seconds.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
parseMode	Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableNotification	Optional. Sends the message silenty.

Returns

On success, the sent message is returned.

setChatDescription()

bool TgBot::Api::setChatDescription	(	int64_t	chatId,
		const std::string &	description
	)		const

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

Parameters

chatId	Unique identifier for the target chat.
description	New chat description, 1-255 characters.

Returns

True on success

setChatPhoto()

bool TgBot::Api::setChatPhoto	(	int64_t	chatId,
		const InputFile::Ptr	photo
	)		const

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats.

Parameters

chatId	Unique identifier for the target chat.
photo	New chat photo.

Returns

True on success

setChatStickerSet()

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

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

Parameters

chatId	Unique identifier for the target chat of the target supergroup or channel.
stickerSetName	Name of the sticker set to be set as the group sticker set.

Returns

Returns True on success.

setChatTitle()

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

Use this method to change the title of a chat. Titles can't be changed for private chats.

Parameters

chatId	Unique identifier for the target chat.
title	New chat title, 1-255 characters.

Returns

True on success

setStickerPositionInSet()

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

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

Parameters

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

Returns

Returns True on success.

setWebhook()

void TgBot::Api::setWebhook	(	const std::string &	url = "",
		const InputFile::Ptr	certificate = nullptr,
		int32_t	maxConnection = 40,
		const StringArrayPtr &	allowedUpdates = nullptr
	)		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 request comes from Telegram, we recommend using a secret path in the URL, e.g. www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. We currently do not support self-signed certificates. Ports currently supported for Webhooks: 443, 80, 88, 8443.

Parameters

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

stopMessageLiveLocation()

Message::Ptr TgBot::Api::stopMessageLiveLocation	(	int64_t	chatId = 0,
		int32_t	messageId = 0,
		int32_t	inlineMessageId = 0,
		const InlineKeyboardMarkup::Ptr	replyMarkup = std::make_shared< InlineKeyboardMarkup >()
	)		const

Use this method to edit live location messages sent by the bot or via the bot (for inline bots).

Parameters

chatId	Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat of the target channel.
messageId	Optional. Required if inlineMessageId is not specified. Identifier of the sent message.
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 was sent by the bot, the edited Message is returned, otherwise nullptr is returned.

unbanChatMember()

bool TgBot::Api::unbanChatMember	(	int64_t	chatId,
		int32_t	userId
	)		const

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

Parameters

chatId	Unique identifier for the target group.
userId	Unique identifier of the target user.

Returns

True on success

unpinChatMessage()

bool TgBot::Api::unpinChatMessage

(

int64_t

chatId

)

const

Use this method to unpin a message in a supergroup or a channel.

Parameters

chatId

Unique identifier for the target chat.

Returns

True on success

uploadStickerFile()

File::Ptr TgBot::Api::uploadStickerFile	(	int32_t	userId,
		const InputFile::Ptr	pngSticker
	)		const

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

Parameters

userId	User identifier of sticker file owner.
pngSticker	Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px.

Returns

Returns the uploaded File on success.

Friends And Related Function Documentation

Bot

friend class Bot

friend

Definition at line 58 of file Api.h.

---

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

• include/tgbot/Api.h