twx.botapi
— Unofficial Telegram Bot API Client¶
Telegram Bot API Types¶
User¶
GroupChat¶
Message¶
-
class
twx.botapi.
Message
[source]¶ This object represents a message.
-
message_id
¶ int
Unique message identifier
-
from
¶ User
Sender
-
date
¶ int
Date the message was sent in Unix time
-
chat
¶ User or GroupChat
Conversation the message belongs to — user in case of a private message, GroupChat in case of a group
-
forward_from
¶ User
Optional. For forwarded messages, sender of the original message
-
forward_date
¶ int
Optional. For forwarded messages, date the original message was sent in Unix time
-
reply_to_message
¶ Message
Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
-
text
¶ str
Optional. For text messages, the actual UTF-8 text of the message
-
audio
¶ Audio
Optional. Message is an audio file, information about the file
-
document
¶ Document
Optional. Message is a general file, information about the file
-
photo
¶ Sequence[PhotoSize]
Optional. Message is a photo, available sizes of the photo
-
sticker
¶ Sticker
Optional. Message is a sticker, information about the sticker
-
video
¶ Video
Optional. Message is a video, information about the video
-
contact
¶ Contact
Optional. Message is a shared contact, information about the contact
-
location
¶ Location
Optional. Message is a shared location, information about the location
-
new_chat_participant
¶ User
Optional. A new member was added to the group, information about them (this member may be bot itself)
-
left_chat_participant
¶ User
Optional. A member was removed from the group, information about them (this member may be bot itself)
-
new_chat_title
¶ str
Optional. A group title was changed to this value
-
new_chat_photo
¶ Sequence[PhotoSize]
Optional. A group photo was change to this value
-
delete_chat_photo
¶ True
Optional. Informs that the group photo was deleted
-
group_chat_created
¶ True
Optional. Informs that the group has been created
-
PhotoSize¶
Audio¶
Document¶
-
class
twx.botapi.
Document
[source]¶ This object represents a general file (as opposed to photos and audio files).
-
file_id
¶ str
Unique file identifier
-
thumb
¶ PhotoSize
Document thumbnail as defined by sender
-
file_name
¶ str
Optional. Original filename as defined by sender
-
mime_type
¶ str
Optional. MIME type of the file as defined by sender
-
file_size
¶ int
Optional. File size
-
Sticker¶
Video¶
-
class
twx.botapi.
Video
[source]¶ This object represents a video file.
-
file_id
¶ str
Unique identifier for this file
-
width
¶ int
Video width as defined by sender
-
height
¶ int
Video height as defined by sender
-
duration
¶ int
Duration of the video in seconds as defined by sender
-
thumb
¶ PhotoSize
Video thumbnail
-
mime_type
¶ str
Optional. Mime type of a file as defined by sender
-
file_size
¶ int
Optional. File size
-
caption
¶ str
Optional. Text description of the video (usually empty)
-
Contact¶
Location¶
Update¶
-
class
twx.botapi.
Update
[source]¶ This object represents an incoming update.
-
update_id
¶ int
The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.
-
message
¶ Message
Optional. New incoming message of any kind — text, photo, sticker, etc.
-
InputFile¶
-
class
twx.botapi.
InputFile
[source]¶ This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
-
form
¶ str
the form used to submit (e.g. ‘photo’)
-
file_info
¶ InputFileInfo
The file metadata required
Example
fp = open('foo.png', 'rb') file_info = InputFileInfo('foo.png', fp, 'image/png') InputFile('photo', file_info) bot.send_photo(chat_id=12345678, photo=InputFile)
Note
While creating the FileInput currently requires a reasonable amount of preparation just to send a file. This class will be extended in the future to make the process easier.
-
UserProfilePhotos¶
ReplyKeyboardMarkup¶
-
class
twx.botapi.
ReplyKeyboardMarkup
[source]¶ This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
-
keyboard
¶ list of list of str
Array of button rows, each represented by an Array of Strings
-
resize_keyboard
¶ bool
Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.
-
one_time_keyboard
¶ bool
Optional. Requests clients to hide the keyboard as soon as it’s been used. Defaults to false.
-
selective
¶ bool
Optional. Use this parameter if you want to show the keyboard to specific users only. Targets:
- users that are @mentioned in the text of the Message object;
- if the bot’s message is a reply (has reply_to_message_id), sender of the original message.
Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.
Example
keyboard = [ ['7', '8', '9'], ['4', '5', '6'], ['1', '2', '3'], ['0'] ] reply_markup = ReplyKeyboardMarkup.create(keyboard) bot.send_message(12345678, 'testing reply_markup', reply_markup=reply_markup)
-
ReplyKeyboardHide¶
-
class
twx.botapi.
ReplyKeyboardHide
[source]¶ - Upon receiving a message with this object, Telegram clients will hide 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
ReplyKeyboardMarkup
).
-
hide_keyboard
¶ True
Requests clients to hide the custom keyboard
-
selective
¶ bool
Optional. Use this parameter if you want to hide keyboard for specific users only. Targets:
- users that are @mentioned in the text of the Message object;
- if the bot’s message is a reply (has reply_to_message_id), sender of the original message.
Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven’t voted yet.
ForceReply¶
-
class
twx.botapi.
ForceReply
[source]¶ - 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.
-
force_reply
¶ True
Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply’
-
selective
¶ bool
Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply (has reply_to_message_id), sender of the original message.
Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
- Guide the user through a step-by-step process. ‘Please send me your question’, ‘Cool, now let’s add the first answer option‘, ’Great. Keep adding answer options, then send /done when you‘re ready’.
The last option is definitely more attractive. And if you use ForceReply in your bot‘s questions, it will receive the user’s answers even if it only receives replies, commands and mentions — without any extra work for the user.
Additional Types¶
Error¶
-
class
twx.botapi.
Error
[source]¶ The error code and message returned when a request was successfuly but the method call was invalid
-
error_code
¶ int
An Integer ‘error_code’ field is also returned, but its contents are subject to change in the future.
-
description
¶ str
The description of the error as reported by Telegram
-
Telegram Bot API Methods¶
get_me¶
-
twx.botapi.
get_me
(*, request_args=None, **kwargs)[source]¶ 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.
Parameters: request_args – Args passed down to TelegramBotRPCRequest Returns: Returns basic information about the bot in form of a User object. Return type: User
send_message¶
-
twx.botapi.
send_message
(chat_id: int, text: str, disable_web_page_preview: bool=None, reply_to_message_id: int=None, reply_markup: ReplyMarkup=None, *, request_args=None, **kwargs)[source]¶ Use this method to send text messages.
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- text (str) – Text of the message to be sent
- disable_web_page_preview (bool) – Disables link previews for links in this message
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (
ReplyKeyboardMarkup
orReplyKeyboardHide
orForceReply
) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. - request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type:
forward_message¶
send_photo¶
-
twx.botapi.
send_photo
(chat_id: int, photo: InputFile, caption: str=None, reply_to_message_id: int=None, reply_markup: ReplyMarkup=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ Use this method to send photos.
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- photo (InputFile or str) – Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.
- caption (str) – Photo caption (may also be used when resending photos by file_id).
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (
ReplyKeyboardMarkup
orReplyKeyboardHide
orForceReply
) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. - request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type: TelegramBotRPCRequest
send_audio¶
-
twx.botapi.
send_audio
(chat_id: int, audio: InputFile, reply_to_message_id: int=None, reply_markup: ReplyKeyboardMarkup=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ 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 Document).
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- audio (InputFile or str) – Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
- request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type: TelegramBotRPCRequest
send_document¶
-
twx.botapi.
send_document
(chat_id: int, document: InputFile, reply_to_message_id: int=None, reply_markup: ReplyKeyboardMarkup=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ Use this method to send general files.
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- document (InputFile or str) – File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
- request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type: TelegramBotRPCRequest
send_sticker¶
-
twx.botapi.
send_sticker
(chat_id: int, sticker: InputFile, reply_to_message_id: int=None, reply_markup: ReplyKeyboardMarkup=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- sticker (InputFile or str) – Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data.
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
- request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type: TelegramBotRPCRequest
send_video¶
-
twx.botapi.
send_video
(chat_id: int, video: InputFile, reply_to_message_id: int=None, reply_markup: ReplyKeyboardMarkup=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- video (InputFile or str) – Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video using multipart/form-data.
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
- request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type: TelegramBotRPCRequest
send_location¶
-
twx.botapi.
send_location
(chat_id: int, latitude: float, longitude: float, reply_to_message_id: int=None, reply_markup: ReplyKeyboardMarkup=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ Use this method to send point on the map.
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- latitude (float) – Latitude of location.
- longitude (float) – Longitude of location.
- reply_to_message_id (int) – If the message is a reply, ID of the original message
- reply_markup (ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply) – Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
- request_args – Args passed down to TelegramBotRPCRequest
Returns: On success, the sent Message is returned.
Return type: TelegramBotRPCRequest
send_chat_action¶
-
twx.botapi.
send_chat_action
(chat_id: int, action: ChatAction, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ - 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).
Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
Parameters: - chat_id (int) – Unique identifier for the message recipient — User or GroupChat id
- action (ChatAction) – Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data.
- request_args – Args passed down to TelegramBotRPCRequest
Returns: Returns True on success.
Return type:
get_user_profile_photos¶
-
twx.botapi.
get_user_profile_photos
(user_id: int, offset: int=None, limit: int=None, *, request_args: dict=None, **kwargs)[source]¶ Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
Parameters: - user_id (int) – Unique identifier of the target user
- offset (int) – Sequential number of the first photo to be returned. By default, all photos are returned.
- limit (int) – Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.
- request_args – Args passed down to the TelegramBotRPCRequest
Returns: Returns a UserProfilePhotos object.
Return type: TelegramBotRPCRequest
get_updates¶
-
twx.botapi.
get_updates
(offset: int=None, limit: int=None, timeout: int=None, *, request_args, **kwargs)[source]¶ Use this method to receive incoming updates using long polling.
Note
- This method will not work if an outgoing webhook is set up.
- In order to avoid getting duplicate updates, recalculate offset after each server response.
Parameters: - offset (int) – Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id.
- limit (int) – Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100
- timeout (int) – Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling
- request_args – Args passed down to the TelegramBotRPCRequest
- kwargs – Args passed down to the TelegramBotRPCRequest (Overrides request_args)
Returns: An Array of Update objects is returned.
Return type: TelegramBotRPCRequest
set_webhook¶
-
twx.botapi.
set_webhook
(url: str=None, *, request_args=None, **kwargs) → TelegramBotRPCRequest[source]¶ 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.
Please note that you will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
Parameters: - url (str) – HTTPS url to send updates to. Use an empty string to remove webhook integration
- request_args – Args passed down to TelegramBotRPCRequest
Returns: Returns True on success.
Return type: TelegramBotRPCRequest