Module teloxide_core::payloads

source ·
Expand description

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. Emoji sticker sets can have up to 200 stickers. Other 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 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.
  • AnswerShippingQuery
    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.
  • AnswerWebAppQuery
    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.
  • ApproveChatJoinRequest
    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.
  • BanChatMember
    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.
  • BanChatSenderChat
    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.
  • Close
    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.
  • CloseForumTopic
    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.
  • CloseGeneralForumTopic
    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.
  • CopyMessage
    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.
  • CopyMessages
    Use this method to copy messages of any kind. If some of the specified messages can’t be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method ForwardMessages, but the copied messages don’t have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
  • CreateChatInviteLink
    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.
  • CreateForumTopic
    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.
  • CreateInvoiceLink
    Use this method to create a link for an invoice. Returns the created invoice link as String on success.
  • 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. Returns True on success.
  • DeclineChatJoinRequest
    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.
  • 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 can_set_sticker_set optionally returned in GetChat requests to check if the bot can use this method. Returns True on success.
  • DeleteForumTopic
    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.
  • DeleteMessage
    Use this method to delete a message, including service messages, with the following limitations:
  • DeleteMessages
    Use this method to delete multiple messages simultaneously. If some of the specified messages can’t be found, they are skipped. Returns True on success.
  • DeleteMyCommands
    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.
  • DeleteStickerFromSet
    Use this method to delete a sticker from a set created by the bot. Returns True on success.
  • DeleteStickerSet
    Use this method to delete a sticker set that was created by the bot. Returns True on success.
  • DeleteWebhook
    Use this method to remove webhook integration if you decide to switch back to GetUpdates. Returns True on success. Requires no parameters.
  • EditChatInviteLink
    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.
  • EditForumTopic
    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.
  • EditGeneralForumTopic
    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.
  • 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 StopMessageLiveLocation. On success, the edited Message is returned.
  • 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 StopMessageLiveLocation. On success, True is returned.
  • 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 Message is returned.
  • ForwardMessages
    Use this method to forward multiple messages of any kind. If some of the specified messages can’t be found or forwarded, they are skipped. Service messages and messages with protected content can’t be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages 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.
  • GetChatMemberCount
    Use this method to get the number of members in a chat. Returns Int on success.
  • GetChatMembersCount
    Use this method to get the number of members in a chat. Returns Int on success.
  • GetChatMenuButton
    Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button.
  • GetCustomEmojiStickers
    Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
  • 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<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.
  • GetForumTopicIconStickers
    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.
  • 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 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.
  • GetMyCommands
    Use this method to get the current list of the bot’s commands. Requires no parameters. Returns Array of BotCommand on success.
  • GetMyDefaultAdministratorRights
    Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button.
  • GetMyDescription
    Use this method to get the current bot description for the given user language. Returns BotDescription on success.
  • GetMyName
    Use this method to get the current bot name for the given user language. Returns BotName on success.
  • GetMyShortDescription
    Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
  • 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 Update objects is returned.
  • GetUserChatBoosts
    Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.
  • GetUserProfilePhotos
    Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
  • GetWebhookInfo
    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.
  • HideGeneralForumTopic
    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.
  • 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.
  • LogOut
    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.
  • 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.
  • ReopenForumTopic
    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.
  • ReopenGeneralForumTopic
    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.
  • 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.
  • RevokeChatInviteLink
    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.
  • SendAnimation
    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.
  • 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 Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
  • 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 Message is returned.
  • SendDice
    Use this method to send an animated emoji that will display a random value. 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.
  • SendInvoice
    Use this method to send invoices. 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
    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.
  • 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.
  • SendPoll
    Use this method to send a native poll. On success, the sent Message is returned.
  • 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 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.
  • 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 Message is returned.
  • 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.
  • 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.
  • SetChatMenuButton
    Use this method to change the bot’s menu button in a private chat, or the default menu button.
  • 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.
  • SetCustomEmojiStickerSetThumbnail
    Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
  • SetGameScore
    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.
  • 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.
  • SetMessageReaction
    Use this method to change the chosen reactions on a message. Service messages can’t be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.
  • SetMyCommands
    Use this method to change the list of the bot’s commands. Returns True on success.
  • SetMyDefaultAdministratorRights
    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.
  • SetMyDescription
    Use this method to change the bot’s description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
  • SetMyName
    Use this method to change the bot’s name. Returns True on success.
  • SetMyShortDescription
    Use this method to change the bot’s short description, which is shown on the bot’s profile page and is sent together with the link when users share the bot. 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.
  • SetStickerEmojiList
    Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
  • SetStickerKeywords
    Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
  • SetStickerMaskPosition
    Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. 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.
  • SetStickerSetThumbnail
    Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
  • SetStickerSetTitle
    Use this method to set the title of a created sticker set. 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 Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
  • 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 StopMessageLiveLocation. On success, the edited Message is returned.
  • 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 StopMessageLiveLocation. On success, True is returned.
  • 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. 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.
  • UnbanChatSenderChat
    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.
  • UnhideGeneralForumTopic
    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.
  • UnpinAllChatMessages
    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.
  • UnpinAllForumTopicMessages
    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.
  • UnpinAllGeneralForumTopicMessages
    Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
  • UnpinChatMessage
    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.
  • UploadStickerFile
    Use this method to upload a file with a sticker for later use in the CreateNewStickerSet and AddStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.

Traits§