[−][src]Module rutebot::requests
Requests for client::Rutebot. Each request struct represent some method telegram bot api
Structs
| AnswerCallbackQuery | Use this struct 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, |
| DeleteChatPhoto | Use this struct 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 |
| DeleteChatStickerSet | Use this struct 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 |
| DeleteMessage | Use this struct to delete a message, including service messages, with the following limitations: |
| EditLiveLocation | Use this struct to edit live location messages.
A location can be edited until its live_period expires or editing is explicitly disabled by a
call to |
| EditMessageCaption | Use this struct to edit captions of messages. On success,
if edited message is sent by the bot, the edited |
| EditMessageMedia | Use this struct 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,
if the edited message was sent by the bot, the edited |
| EditMessageReplyMarkup | Use this struct to edit only the reply markup of messages.
On success, if edited message is sent by the bot, the edited |
| EditMessageText | Use this struct to edit text and game messages. On success, if edited message is sent by the bot, the edited
|
| ExportChatInviteLink | Use this struct 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
|
| ForceReply | Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. |
| ForwardMessage | Use this struct to forward messages of any kind. On success, the sent |
| GetChat | Use this struct 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 struct 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 struct to get the number of members in a chat. Returns |
| GetFile | Use this struct 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 |
| GetMe | A simple struct for testing your bot's auth token. Requires no parameters.
Returns basic information about the bot in form of a |
| GetUpdates | Use this struct to receive incoming updates using long polling. An Array of |
| GetUserProfilePhotos | Use this struct to send text messages. On success, the sent |
| InlineKeyboard | This object represents an inline keyboard that appears right next to the message it belongs to |
| InputMediaAnimation | Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. |
| InputMediaAudio | Represents an audio file to be treated as music to be sent. |
| InputMediaDocument | Represents a general file to be sent. |
| InputMediaPhoto | Represents a photo to be sent. |
| InputMediaVideo | Represents a video to be sent. |
| KickChatMember | Use this struct 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 |
| LeaveChat | Use this method for your bot to leave a group, supergroup or channel. Returns |
| PinChatMessage | Use this struct 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 |
| PromoteChatMember | Use this struct 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 |
| ReplyKeyboardMarkup | This object represents a custom keyboard with reply options. |
| ReplyKeyboardRemove | Upon receiving a message with this object, Telegram clients will remove the current custom keyboard
and display the default letter-keyboard. By default, custom keyboards are displayed until a
new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden
immediately after the user presses a button (see |
| RestrictChatMember | Use this struct 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 |
| SendAnimation | Use this struct to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
On success, the sent |
| SendAudio | Use this struct 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 |
| SendChatAction | Use this struct 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 |
| SendContact | Use this struct to send phone contacts. On success, the sent |
| SendDocument | Use this struct to send general files. On success, the sent |
| SendLocation | Use this struct to send point on the map. On success, the sent |
| SendMediaGroup | Use this struct to send a group of photos or videos as an album.
On success, an array of the sent |
| SendMessage | Use this struct to send text messages. On success, the sent |
| SendPhoto | Use this struct to send photos. On success, the sent |
| SendPoll | Use this struct to send a native poll. A native poll can't be sent to a private chat.
On success, the sent |
| SendVenue | Use this struct to send information about a venue. On success, the sent |
| SendVideo | Use this struct to send video files, Telegram clients support mp4 videos (other formats may be sent by |
| SendVideoNote | As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long.
Use this struct to send video messages. On success, the sent |
| SendVoice | Use this struct 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 |
| SetChatDescription | Use this struct 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 |
| SetChatPhoto | Use this struct 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 |
| SetChatStickerSet | Use this struct 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 |
| SetChatTitle | Use this struct 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 |
| StopLiveLocation | Use this struct 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 struct to stop a poll which was sent by the bot. On success, the stopped |
| UnbanChatMember | Use this struct 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 |
| UnpinChatMessage | Use this struct 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 |
Enums
| AllowedUpdate | Enumeration of possible update types from telegram bot api |
| ChatAction | |
| ChatId | Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) |
| FileKind | File to send |
| InlineKeyboardButton | |
| InputMedia | |
| InputMediaPhotoOrVideo | |
| KeyboardButton | This object represents one button of the reply keyboard |
| MessageOrInlineMessageId | |
| ParseMode | |
| ReplyMarkup | Additional interface options |
Traits
| Request | Basic request type. |