[−][src]Module telebot::functions
Available telegram functions, copied from https://core.telegram.org/bots/api#available-methods
telebot-derive implements setter, setter and send methods to each struct
Structs
| AddStickerToSet | Use this method to add a new sticker to a set created by the bot. Returns True on success. |
| AnswerCallbackQuery | Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned. |
| AnswerInlineQuery | Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed. |
| CreateNewStickerSet | Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success. |
| DeleteChatPhoto | 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 admin rights. Returns True on success. |
| DeleteMessage | Use this method to delete a message, including service messages, with the following limitations: |
| DeleteStickerFromSet | Use this method to add a new sticker to a set created by the bot. Returns True on success. |
| EditMessageCaption | Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. |
| EditMessageReplyMarkup | Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. |
| EditMessageText | Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. |
| ExportChatInviteLink | Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success. |
| FowardMessage | Use this method to forward messages. On success, the sent Message is returned. |
| GetChat | 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. |
| GetChatAdministrators | 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. |
| GetChatMember | Use this method to get information about a member of a chat. Returns a ChatMember object on success. |
| GetChatMemberCounts | Use this method to get the number of members in a chat. Returns Int on success. |
| GetFile | 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. On success, a File object is returned. The file
can then be downloaded via the link https://api.telegram.org/file/bot |
| GetGameHighScores | Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects. |
| GetMe | A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object. |
| GetUpdates | Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned. |
| GetUserProfilePhotos | Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. |
| KickChatMember | Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the group for this to work. Returns True on success. |
| LeaveChat | Use this method for your bot to leave a group, supergroup or channel. Returns True on success. |
| PinChatMessage | Use this method to pin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success. |
| PromoteChatMember | 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 admin rights. Pass False for all boolean parameters to demote a user. Returns True on success. |
| RestrictChatMember | 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 admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success. |
| SendAction | Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. |
| SendAudio | 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 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. |
| SendContact | Use this method to send phone contacts. On success, the sent Message is returned. |
| SendDocument | Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. |
| SendGame | Use this method to send a game. On success, the sent Message is returned. |
| SendLocation | Use this method to send point on the map. On success, the sent Message is returned. |
| SendMediaGroup | |
| SendMessage | Use this method to send text messages. On success, the sent Message is returned. |
| SendPhoto | Use this method to send photos. On success, the sent Message is returned. |
| SendSticker | Use this method to send .webp stickers. On success, the sent Message is returned. |
| SendVenue | Use this method to send information about a venue. On success, the sent Message is returned. |
| SendVideo | Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. |
| SendVoice | 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). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. |
| SetChatDescription | Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. |
| SetChatTitle | 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 admin rights. Returns True on success. |
| SetGameScore | Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False. |
| UnbanChatMember | Use this method to unban a previously kicked user in a supergroup. The user will not return to the group automatically, but will be able to join via link, etc. The bot must be an administrator in the group for this to work. Returns True on success. |
| UnpinChatMessage | Use this method to unpin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success. |
| WrapperAddStickerToSet | |
| WrapperAnswerCallbackQuery | |
| WrapperAnswerInlineQuery | |
| WrapperCreateNewStickerSet | |
| WrapperDeleteChatPhoto | |
| WrapperDeleteMessage | |
| WrapperDeleteStickerFromSet | |
| WrapperEditMessageCaption | |
| WrapperEditMessageReplyMarkup | |
| WrapperEditMessageText | |
| WrapperExportChatInviteLink | |
| WrapperFowardMessage | |
| WrapperGetChat | |
| WrapperGetChatAdministrators | |
| WrapperGetChatMember | |
| WrapperGetChatMemberCounts | |
| WrapperGetFile | |
| WrapperGetGameHighScores | |
| WrapperGetMe | |
| WrapperGetUpdates | |
| WrapperGetUserProfilePhotos | |
| WrapperKickChatMember | |
| WrapperLeaveChat | |
| WrapperPinChatMessage | |
| WrapperPromoteChatMember | |
| WrapperRestrictChatMember | |
| WrapperSendAction | |
| WrapperSendAudio | |
| WrapperSendContact | |
| WrapperSendDocument | |
| WrapperSendGame | |
| WrapperSendLocation | |
| WrapperSendMediaGroup | |
| WrapperSendMessage | |
| WrapperSendPhoto | |
| WrapperSendSticker | |
| WrapperSendVenue | |
| WrapperSendVideo | |
| WrapperSendVoice | |
| WrapperSetChatDescription | |
| WrapperSetChatTitle | |
| WrapperSetGameScore | |
| WrapperUnbanChatMember | |
| WrapperUnpinChatMessage |
Enums
| Action | The strongly typed version of the action field which indicates the type of action |
| ParseMode | The strongly typed version of the parse_mode field which indicates the type of text |
| ReplyMarkup | Possible types of reply markups |