Module teloxide_core::payloads [−][src]
Request data sent to Telegram.
Modules
| setters | This module re-exports all the setters traits as |
Structs
| AddStickerToSet | Use this method to add a new sticker to a set created by the bot. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. 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. |
| AnswerPreCheckoutQuery | Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an |
| AnswerShippingQuery | If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an |
| CreateNewStickerSet | 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. You must use exactly one of the fields png_sticker or tgs_sticker. 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. |
| DeleteChatStickerSet | 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 admin rights. Use the field |
| DeleteMessage | Use this method to delete a message, including service messages, with the following limitations: |
| DeleteStickerFromSet | Use this method to delete a sticker from a set created by the bot. Returns True on success. |
| DeleteWebhook | Use this method to remove webhook integration if you decide to switch back to |
| EditMessageCaption | Use this method to edit captions of messages. On success, the edited Message is returned. |
| EditMessageCaptionInline | Use this method to edit captions of messages. On success, True is returned. |
| EditMessageLiveLocation | Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to |
| EditMessageLiveLocationInline | Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to |
| EditMessageMedia | Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, the edited Message is returned. |
| EditMessageMediaInline | Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, True is returned. |
| EditMessageReplyMarkup | Use this method to edit only the reply markup of messages. On success, the edited Message is returned. |
| EditMessageReplyMarkupInline | Use this method to edit only the reply markup of messages. On success, True is returned. |
| EditMessageText | Use this method to edit text and games messages. On success, the edited Message is returned. |
| EditMessageTextInline | Use this method to edit text and games messages. On success, 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. |
| ForwardMessage | Use this method to forward messages of any kind. On success, the sent |
| 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 |
| GetChatAdministrators | Use this method to get a list of administrators in a chat. On success, returns an Array of |
| GetChatMember | Use this method to get information about a member of a chat. Returns a |
| GetChatMembersCount | 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 |
| GetGameHighScores | Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of |
| GetMe | A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a |
| GetMyCommands | Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of |
| GetStickerSet | Use this method to get a sticker set. On success, a StickerSet object is returned. |
| GetUpdates | Use this method to receive incoming updates using long polling (wiki). An Array of |
| GetUserProfilePhotos | Use this method to get a list of profile pictures for a user. Returns a |
| GetWebhookInfo | Use this method to get current webhook status. Requires no parameters. On success, returns a |
| KickChatMember | Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, 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 chat for this to work and must have the appropriate admin rights. 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 group, 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 permissions to lift restrictions from a user. Returns True on success. |
| SendAnimation | Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent |
| 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 or .M4A format. On success, the sent |
| SendChatAction | 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. |
| SendContact | Use this method to send phone contacts. On success, the sent |
| SendDice | Use this method to send an animated emoji that will display a random value. On success, the sent |
| SendDocument | Use this method to send general files. On success, the sent |
| SendGame | Use this method to send a game. On success, the sent |
| SendInvoice | Use this method to send invoices. On success, the sent |
| SendLocation | Use this method to send point on the map. On success, the sent |
| SendMediaGroup | Use this method to send a group of photos or videos as an album. On success, an array of the sent |
| SendMessage | Use this method to send text messages. On success, the sent |
| SendPhoto | Use this method to send photos. On success, the sent |
| SendPoll | Use this method to send phone contacts. On success, the sent |
| SendSticker | Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned. |
| SendVenue | Use this method to send information about a venue. On success, the sent |
| SendVideo | Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as |
| SendVideoNote | As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent |
| 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 |
| SetChatAdministratorCustomTitle | Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns _True_on success. |
| SetChatDescription | 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 admin rights. Returns True on success. |
| SetChatPermissions | Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success. |
| SetChatPhoto | 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 admin rights. Returns True on success. |
| SetChatStickerSet | 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 admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. |
| 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, returns the edited |
| SetGameScoreInline | Use this method to set the score of the specified user in a game. On success, 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. |
| SetMyCommands | Use this method to change the list of the bot's commands. Returns True on success. |
| SetPassportDataErrors | Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. |
| SetStickerPositionInSet | Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success. |
| SetStickerSetThumb | Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success. |
| SetWebhook | 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 |
| StopMessageLiveLocation | Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to |
| StopMessageLiveLocationInline | Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to |
| StopPoll | Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned. |
| UnbanChatMember | Use this method to unban a previously kicked 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. Returns True on success. |
| UnpinChatMessage | Use this method to unpin a message in a group, 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. |
| UploadStickerFile | Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success. |