Module teloxide_core::payloads
source · Expand description
Request data sent to Telegram.
Modules
This module re-exports all the setters traits as
_.Structs
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.
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.
Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an
Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an
Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.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.
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
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 admin rights. Returns True on success.
Use this method to ban a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights.
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn’t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to close an open ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
Use this method to copy messages of any kind. The method is analogous to the method forwardMessage, but the copied message doesn’t have a link to the original message. Returns the
MessageId of the sent message on success.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 admin rights. The link can be revoked using the method
RevokeChatInviteLink. Returns the new invite link as ChatInviteLink object.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 can_manage_topics administrator rights. Returns information about the created topic as a
ForumTopic object.Use this method to create a link for an invoice. Returns the created invoice link as String on success.
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.
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
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.
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
can_set_sticker_set optionally returned in GetChat requests to check if the bot can use this method. Returns True on success.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 can_delete_messages administrator rights. Returns True on success.
Use this method to delete a message, including service messages, with the following limitations:
Use this method to delete the list of the bot’s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
Use this method to delete a sticker from a set created by the bot. Returns True on success.
Use this method to remove webhook integration if you decide to switch back to
GetUpdates. Returns True on success. Requires no parameters.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 admin rights. Returns the edited invite link as a
ChatInviteLink object.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 can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
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 can_manage_topics administrator rights. Returns True on success.
Use this method to edit captions of messages. On success, the edited Message is returned.
Use this method to edit captions of messages. On success, True is returned.
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to
StopMessageLiveLocation. On success, the edited Message is returned.Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to
StopMessageLiveLocation. On success, True is returned.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.
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.
Use this method to edit only the reply markup of messages. On success, the edited Message is returned.
Use this method to edit only the reply markup of messages. On success, True is returned.
Use this method to edit text and games messages. On success, the edited Message is returned.
Use this method to edit text and games messages. On success, True is returned.
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.
Use this method to forward messages of any kind. On success, the sent
Message is returned.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.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.Use this method to get information about a member of a chat. Returns a
ChatMember object on success.Use this method to get the number of members in a chat. Returns Int on success.
Use this method to get the number of members in a chat. Returns Int on success.
Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button.
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
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<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling GetFile again.Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of
Sticker objects.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
GameHighScore objects.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.Use this method to get the current list of the bot’s commands. Requires no parameters. Returns Array of
BotCommand on success.Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button.
Use this method to get a sticker set. On success, a StickerSet object is returned.
Use this method to get a list of profile pictures for a user. Returns a
UserProfilePhotos object.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.Use this method to hide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
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.
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
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.
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.
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to reopen a closed ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
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.
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 admin rights. Returns the revoked invite link as
ChatInviteLink object.Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent
Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent
Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.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.
Use this method to send phone contacts. On success, the sent
Message is returned.Use this method to send an animated emoji that will display a random value. On success, the sent
Message is returned.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.Use this method to send invoices. On success, the sent
Message is returned.Use this method to send point on the map. On success, the sent
Message is returned.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. On success, an array of
Messages that were sent is returned.Use this method to send text messages. On success, the sent
Message is returned.Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
Use this method to send information about a venue. On success, the sent
Message is returned.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.Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns _True_on success.
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.
Use this method to change the bot’s menu button in a private chat, or the default menu button.
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.
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.
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.
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.
Use this method to set the score of the specified user in a game. On success, returns the edited
Message. Returns an error, if the new score is not greater than the user’s current score in the chat and force is False.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.
Use this method to change the list of the bot’s commands. Returns True on success.
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 are free to modify the list before adding the bot.
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
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.
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. Returns True on success.Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to
StopMessageLiveLocation. On success, the edited Message is returned.Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to
StopMessageLiveLocation. On success, True is returned.Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
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. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don’t want this, use the parameter only_if_banned. Returns True on success.
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.
Use this method to unhide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
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 ‘can_pin_messages’ admin right in a supergroup or ‘can_edit_messages’ admin right in a channel. Returns True on success.
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 can_pin_messages administrator right in the supergroup. Returns True on success.
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 ‘can_pin_messages’ admin right in a supergroup or ‘can_edit_messages’ admin right in a channel. Returns True on success.
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.
Traits
Setters for fields of
AddStickerToSetSetters for fields of
AnswerCallbackQuerySetters for fields of
AnswerInlineQuerySetters for fields of
AnswerPreCheckoutQuerySetters for fields of
AnswerShippingQuerySetters for fields of
AnswerWebAppQuerySetters for fields of
ApproveChatJoinRequestSetters for fields of
BanChatMemberSetters for fields of
BanChatSenderChatSetters for fields of
CloseForumTopicSetters for fields of
CloseGeneralForumTopicSetters for fields of
CloseSetters for fields of
CopyMessageSetters for fields of
CreateChatInviteLinkSetters for fields of
CreateForumTopicSetters for fields of
CreateInvoiceLinkSetters for fields of
CreateNewStickerSetSetters for fields of
DeclineChatJoinRequestSetters for fields of
DeleteChatPhotoSetters for fields of
DeleteChatStickerSetSetters for fields of
DeleteForumTopicSetters for fields of
DeleteMessageSetters for fields of
DeleteMyCommandsSetters for fields of
DeleteStickerFromSetSetters for fields of
DeleteWebhookSetters for fields of
EditChatInviteLinkSetters for fields of
EditForumTopicSetters for fields of
EditGeneralForumTopicSetters for fields of
EditMessageCaptionInlineSetters for fields of
EditMessageCaptionSetters for fields of
EditMessageLiveLocationInlineSetters for fields of
EditMessageLiveLocationSetters for fields of
EditMessageMediaInlineSetters for fields of
EditMessageMediaSetters for fields of
EditMessageReplyMarkupInlineSetters for fields of
EditMessageReplyMarkupSetters for fields of
EditMessageTextInlineSetters for fields of
EditMessageTextSetters for fields of
ExportChatInviteLinkSetters for fields of
ForwardMessageSetters for fields of
GetChatAdministratorsSetters for fields of
GetChatMemberCountSetters for fields of
GetChatMemberSetters for fields of
GetChatMembersCountSetters for fields of
GetChatMenuButtonSetters for fields of
GetChatSetters for fields of
GetCustomEmojiStickersSetters for fields of
GetFileSetters for fields of
GetForumTopicIconStickersSetters for fields of
GetGameHighScoresSetters for fields of
GetMeSetters for fields of
GetMyCommandsSetters for fields of
GetMyDefaultAdministratorRightsSetters for fields of
GetStickerSetSetters for fields of
GetUpdatesSetters for fields of
GetUserProfilePhotosSetters for fields of
GetWebhookInfoSetters for fields of
HideGeneralForumTopicSetters for fields of
KickChatMemberSetters for fields of
LeaveChatSetters for fields of
LogOutSetters for fields of
PinChatMessageSetters for fields of
PromoteChatMemberSetters for fields of
ReopenForumTopicSetters for fields of
ReopenGeneralForumTopicSetters for fields of
RestrictChatMemberSetters for fields of
RevokeChatInviteLinkSetters for fields of
SendAnimationSetters for fields of
SendAudioSetters for fields of
SendChatActionSetters for fields of
SendContactSetters for fields of
SendDiceSetters for fields of
SendDocumentSetters for fields of
SendGameSetters for fields of
SendInvoiceSetters for fields of
SendLocationSetters for fields of
SendMediaGroupSetters for fields of
SendMessageSetters for fields of
SendPhotoSetters for fields of
SendPollSetters for fields of
SendStickerSetters for fields of
SendVenueSetters for fields of
SendVideoNoteSetters for fields of
SendVideoSetters for fields of
SendVoiceSetters for fields of
SetChatAdministratorCustomTitleSetters for fields of
SetChatDescriptionSetters for fields of
SetChatMenuButtonSetters for fields of
SetChatPermissionsSetters for fields of
SetChatPhotoSetters for fields of
SetChatStickerSetSetters for fields of
SetChatTitleSetters for fields of
SetGameScoreInlineSetters for fields of
SetGameScoreSetters for fields of
SetMyCommandsSetters for fields of
SetMyDefaultAdministratorRightsSetters for fields of
SetPassportDataErrorsSetters for fields of
SetStickerPositionInSetSetters for fields of
SetStickerSetThumbSetters for fields of
SetWebhookSetters for fields of
StopMessageLiveLocationInlineSetters for fields of
StopMessageLiveLocationSetters for fields of
StopPollSetters for fields of
UnbanChatMemberSetters for fields of
UnbanChatSenderChatSetters for fields of
UnhideGeneralForumTopicSetters for fields of
UnpinAllChatMessagesSetters for fields of
UnpinAllForumTopicMessagesSetters for fields of
UnpinChatMessageSetters for fields of
UploadStickerFile