pyTelegramBotAPI -
A simple, but extensible Python implementation for the Telegram Bot API. +
A simple, but extensible Python implementation for the Telegram Bot API.
+Both synchronous and asynchronous.
+ +##Supported Bot API version: 
client buttons
+hapticFeedback (notification)
+tweak color [Bot API 6.1+]
+Header color:
+Background color:
+popup and alert [Bot API 6.2+]
+request [Bot API 6.9+]
+story [Bot API 7.8+]
+cloud storage [Bot API 6.9+]
+| key | +value | +
|---|---|
| - | +- | +
data from telegram
+initDataUnsafe
+ThemeParams
+Biometrics Manager
+| support | +Unsupported in this platform | +
event from telegram
+vertical scroll behaviour [Bot API 7.7+]
+close the miniapp when scroll vertically
+closing confirmation [Bot API 6.2+]
+Confimation dialog when closing miniapp
+links
+pyTelegramBotApi - opens telegram link in telegram
+Telegram - opens link inside telegram in browser.
+other
+version:+
platform:+
color scheme:+
${JSON.stringify(telegram.initDataUnsafe, null, 2)} `;
+document.getElementById('themeParams-block').innerHTML += ` ${JSON.stringify(telegram.themeParams, null, 2)} `;
+
+let biometrics_table_modify = new TableModify(table.biometrics_table);
+
+telegram.BiometricManager.init(() => {['isInited', 'isBiometricAvailable', 'biometricType', 'isAccessRequested', 'isAccessGranted', 'isBiometricTokenSaved', 'deviceId'].forEach((field) => {
+ biometrics_table_modify.addElements(field, eval(`telegram.BiometricManager.${field}`));
+}); biometrics_table_modify.removeElement('null-biometrics-row') });
+
+['themeChanged', 'viewportChanged', 'mainButtonClicked', 'backButtonClicked', 'settingsButtonClicked', 'invoiceClosed', 'popupClosed', 'qrTextReceived', 'scanQrPopupClosed',
+'clipboardTextReceived', 'writeAccessRequested', 'contactRequested', 'biometricManagerUpdated', 'biometricAuthRequested', 'biometricTokenUpdated'].forEach((element) => {
+ telegram.onEvent(element, () => {
+ document.getElementById('event-block').innerHTML += `${element}
`; + }); +}); + +text.color_scheme.innerText += telegram.colorScheme; +text.version.innerText += telegram.version; +text.platform.innerText += telegram.platform; + +button.send_message.addEventListener('click', () => { + telegram.sendData(input.message.value); + if (telegram.initDataUnsafe) telegram.showAlert('SendData only works in miniapp that opened with reply keyboard.') + input.message.value = '' +}); + +button.main.addEventListener('click', (e) => { + const modify_button = new ModifyStyle(e.currentTarget); + if (e.currentTarget.value == 'enable') { + e.currentTarget.value = 'disable'; + modify_button.disableButton(); + telegram.MainButton.hide(); + } else { + e.currentTarget.value = 'enable'; + modify_button.enableButton(); + telegram.MainButton.show(); + } +}); + +button.back.addEventListener('click', (e) => { + const modify_button = new ModifyStyle(e.currentTarget); + if (e.currentTarget.value == 'enable') { + e.currentTarget.value = 'disable'; + modify_button.disableButton(); + telegram.BackButton.hide(); + } else { + e.currentTarget.value = 'enable'; + modify_button.enableButton(); + telegram.BackButton.show(); + } +}); + +button.settings.addEventListener('click', (e) => { + const modify_button = new ModifyStyle(e.currentTarget); + if (e.currentTarget.value == 'enable') { + e.currentTarget.value = 'disable'; + modify_button.disableButton(); + telegram.SettingsButton.hide(); + } else { + e.currentTarget.value = 'enable'; + modify_button.enableButton(); + telegram.SettingsButton.show(); + } +}); + +button.success.addEventListener('click', () => { + telegram.HapticFeedback.notificationOccurred('success'); +}); + +button.warning.addEventListener('click', () => { + telegram.HapticFeedback.notificationOccurred('warning'); +}); + +button.error.addEventListener('click', () => { + telegram.HapticFeedback.notificationOccurred('error'); +}); + +button.popup.addEventListener('click', () => { + telegram.showPopup({title: 'popup', message: 'this is popup message', buttons: [{ text: 'roger'}]}); +}); + +button.alert.addEventListener('click', () => { + telegram.showAlert('This is alert message'); +}); + +button.confirm.addEventListener('click', () => { + telegram.showConfirm('This is confirm message'); +}); + +button.contact.addEventListener('click', () => { + telegram.requestContact(); +}); + +button.write_access.addEventListener('click', () => { + telegram.requestWriteAccess(); +}); + +button.biometrics.addEventListener('click', () => { + telegram.BiometricManager.requestAccess({'reseaon': 'this is biometrics request'}); +}); + +button.vertical_scroll_enable.addEventListener('click', (e) => { + const modify_scroll_enable = new ModifyStyle(e.currentTarget); + const modify_scroll_disable = new ModifyStyle(button.vertical_scroll_disable); + if (e.currentTarget.value == 'disable') { + e.currentTarget.value = 'enable'; + modify_scroll_enable.enableButton(); + modify_scroll_disable.disableButton(); + button.vertical_scroll_disable.value = 'disable'; + telegram.enableVerticalSwipes(); + }; +}); + +button.vertical_scroll_disable.addEventListener('click', (e) => { + const modify_scroll_disable = new ModifyStyle(e.currentTarget); + const modify_scroll_enable = new ModifyStyle(button.vertical_scroll_enable); + if (e.currentTarget.value == 'disable') { + e.currentTarget.value = 'enable'; + modify_scroll_disable.enableButton(); + modify_scroll_enable.disableButton(); + telegram.disableVerticalSwipes(); + button.vertical_scroll_enable.value = 'disable'; + }; +}); + +button.close_confirm_enable.addEventListener('click', (e) => { + const modify_close_confirm_enable = new ModifyStyle(e.currentTarget); + const modify_close_confirm_disable = new ModifyStyle(button.close_confirm_disable); + if (e.currentTarget.value == 'disable') { + e.currentTarget.value = 'enable'; + modify_close_confirm_enable.enableButton(); + modify_close_confirm_disable.disableButton(); + button.close_confirm_disable.value = 'disable'; + telegram.enableClosingConfirmation(); + }; +}); + +button.close_confirm_disable.addEventListener('click', (e) => { + const modify_close_confirm_disable= new ModifyStyle(e.currentTarget); + const modify_close_confirm_enable= new ModifyStyle(button.close_confirm_enable); + if (e.currentTarget.value == 'disable') { + e.currentTarget.id = 'enable'; + modify_close_confirm_enable.disableButton(); + modify_close_confirm_disable.enableButton(); + button.close_confirm_enable.value = 'disable'; + telegram.disableClosingConfirmation(); + }; +}); + +button.show_QR.addEventListener('click', () => { + telegram.showScanQrPopup({text: "this is QR scanner"}); +}); + +button.expand.addEventListener('click', () => { + telegram.expand(); +}); + +button.close.addEventListener('click', () => { + telegram.close(); +}); + +button.cloud_add.addEventListener('click', () => { + let table_modify = new TableModify(table.cloud_table); + telegram.CloudStorage.setItem(input.cloud_add_key.value, input.cloud_add_value.value, (error, is_stored) => { + if (!is_stored) telegram.showAlert(error); + else { + table_modify.addElements(input.cloud_add_key.value, input.cloud_add_value.value); + new TableModify(table.cloud_table).removeElement('null-storage-row'); + }; + input.cloud_add_key.value = ''; + input.cloud_add_value.value = ''; + }); +}); + +button.cloud_remove.addEventListener('click', () => { + let table_modify = new TableModify(table.cloud_table); + telegram.CloudStorage.removeItem(input.cloud_remove_key.value, (error, is_removed) => { + if (!is_removed) telegram.showAlert(error); + else table_modify.removeElement(input.cloud_remove_key.value); + input.cloud_remove_key.value = ''; + }); +}); + +button.post_story_photo.addEventListener('click', () => { + telegram.shareToStory('https://telegra.ph/file/e194a37aed103485469b4.jpg', {text: 'This is photo story'}); +}); + +button.post_story_video.addEventListener('click', () => { + telegram.shareToStory('https://telegra.ph/file/16ffd9385a017b59f458e.mp4', {text: 'This is video story'}); +}); + +button.post_story_with_link.addEventListener('click', () => { + telegram.shareToStory('https://telegra.ph/file/e194a37aed103485469b4.jpg', {text: 'This is story with link', widget_link: {url: 'https://t.me/joinchat/Bn4ixj84FIZVkwhk2jag6A'}}); +}); + +colors_tweaks.forEach((element) => { + element.addEventListener('click', (e) => { + const color = window.getComputedStyle(e.currentTarget).backgroundColor; + if (e.currentTarget.id.includes('header')){ + telegram.setHeaderColor(color); + } else { + telegram.setBackgroundColor(color); + document.querySelector('.body').style.backgroundColor = telegram.backgroundColor; + }; + }); +}); + +text.telegram_link.addEventListener('click', () => { + telegram.openTelegramLink("https://t.me/joinchat/Bn4ixj84FIZVkwhk2jag6A"); +}); + +text.internal_link.addEventListener('click', () => { + telegram.openLink('https://telegram.org', {try_instant_view: false}); +}); diff --git a/examples/mini_app_web/style.css b/examples/mini_app_web/style.css new file mode 100644 index 000000000..30fad466c --- /dev/null +++ b/examples/mini_app_web/style.css @@ -0,0 +1,338 @@ +:root { + --red-color: #ba4d47; + --yellow-color: #bab05b; +} + +.body { + background-color: (--tg-theme-secondary-bg-color); +} + +* { + font-family: Arial, Helvetica, sans-serif; + margin: 0; + padding: 0; +} + +input { + color: var(--tg-theme-text-color); +} + +table { + width: 93vw; + border-collapse: collapse; + border: solid 0px var(--tg-theme-hint-color); + border-radius: 5px; +} + +th { + font-weight: bold; +} + +td { + font-weight: lighter; + max-width: 46.5vw; + overflow-x: hidden; +} + + +th, td { + padding: 3px; + font-size: 14px; + color: var(--tg-theme-text-color); + text-align: center; + border: solid 1px var(--tg-theme-hint-color); +} + +input:focus { + outline: none; +} + +::placeholder { + color: var(--tg-theme-hint-color); +} + +.content-block { + display: flex; + flex-direction: row; + justify-content: center; + align-items: center; + gap: 9.24px; + background-color: var(--tg-theme-bg-color); + height: 70px; +} + +.content-block_send-message { + flex-direction: column; + height: 160px; +} + +.content-block_tweak-color { + flex-direction: column; + align-items: start; + justify-content: center; + gap: 17px; + height: 96px; +} + +.content-block_cloud-storage { + flex-direction: column; + height: 320px; + gap: 9.6px; +} + +.content-block_link { + height: 104px; + flex-direction: column; +} + +.content-block_event{ + height: 220px; +} + +.content-block_scroll-behaviour, .content-block_close-confirmation { + height: 100px; + align-items: flex-start; + align-self: flex-start; + flex-direction: column; + padding-left: 4.2vw; +} + +.content-block_data { + height: 100%; + flex-direction: column; + align-items: flex-start; + padding:5vh 3vw 5vh 3vw ; + overflow: hidden; +} + +.scroll-behaviour__toggle-box, .content-block__toggle-box { + display: flex; + gap: 9.6px; +} + +.link__content { + display: flex; + flex-direction: row; +} + +.tweak-color__header, .tweak-color__background { + display: flex; + flex-direction: row; + justify-content: flex-end; + gap: 9.6px; + width: 65vw; +} + +.tweak-color__circle-block { + display: flex; + flex-direction: row; + gap: 2vw; +} + +.event__content { + overflow-y: auto; + height: 170px; + width: 88vw; + border: solid 1px var(--tg-theme-hint-color); + border-radius: 5px; + padding: 10px; +} + +.data__content { + padding-top: 10px; + padding-bottom: 10px; +} + +.cloud-storage__input-block { + width: 93vw; + display: flex; + flex-direction: row; + gap: 0px; +} + +.cloud-storage__input-block_remove { + width: 94vw; + display: flex; + flex-direction: column; + justify-content: center; + align-items: center; +} + +.description-block { + display: flex; + justify-content: center; + align-items: center; + flex-direction: column; + margin: 10px; + gap: 3px; +} + +.send-message__button{ + border: none; + color: var(--tg-theme-text-color); + background-color: var(--tg-theme-button-color); + border-radius: 5px; + width: 70vw; + height: 40px; +} + +.default-button { + color: var(--tg-theme-text-color); + background-color: var(--tg-theme-button-color); + border: none; + border-radius: 5px; + width: 29vw;; + height: 35px; +} + +.default-button_yellow { + background-color: var(--yellow-color); +} + +.default-button_red { + background-color: var(--red-color); +} + +.default-button_disable { + background: transparent; + color: var(--tg-theme-button-color); + border: solid 1px var(--tg-theme-button-color); +} + +.cloud-storage__button { + border: none; + border-radius: 5px; + color: var(--button_text_color); + width: 93vw; + height: 38px; +} + +.cloud-storage__button_add { + color: var(--tg-theme-text-color); + background-color: var(--tg-theme-button-color); + margin-bottom: 10px; +} + +.cloud-storage__button_remove { + color: var(--tg-theme-text-color); + background-color: var(--red-color); +} + +.header-text { + font-size: 14px; + color: var(--tg-theme-hint-color); + margin-top: 13px; + margin-bottom: 5px; + margin-left: 6px; +} + +.content-block__text { + color: var(--tg-theme-text-color); + font-size: 14px; + padding-bottom: 3px; +} + +.tweak-color__text { + font-size: 13px; + color: var(--tg-theme-text-color); + } + +.data__text { + color: var(--tg-theme-text-color); + font-weight: 300; + font-size: 15px; +} + +.link__text { + font-size: 14px; + color: var(--tg-theme-hint-color); + padding: 2px; +} + +.link__text_blue { + color: var(--tg-theme-link-color); +} + +.event__text { + color: var(--tg-theme-text-color); + font-weight: lighter; + font-size: 13px; +} + + +.description__text { + color: var(--tg-theme-hint-color); + font-size: 13px; + font-weight: 300; +} + +.send-message__input { + border: solid var(--tg-theme-hint-color) 1px; + background-color: transparent; + border-radius: 5px; + width: 67vw; + height: 40px; + padding-left: 10px; +} + +.cloud-storage__input { + border: solid 1px var(--tg-theme-hint-color); + background-color: transparent; + height: 30px; + padding-left: 10px; +} + +.cloud-storage__input_add-key { + border-radius: 5px 0px 0px 5px; + width: 35%; +} + +.cloud-storage__input_add-value { + border-radius: 0px 5px 5px 0px; + width: 65%; +} + +.cloud-storage__input_remove { + width: 90vw; + border: solid 1px var(--tg-theme-hint-color); + border-radius: 5px; + margin-bottom: 10px; +} + +.tweak-color__circle { + border-radius: 100%; + width: 20px; + height: 20px; +} + +.tweak-color__circle_yellow { + background-color: var(--yellow-color); +} + +.tweak-color__circle_red { + background-color: var(--red-color); +} + +.tweak-color__circle_button { + background-color: var(--tg-theme-button-color); +} + +.tweak-color__circle_header { + border: solid 1px var(--tg-theme-hint-color); + background-color: var(--tg-theme-header-bg-color); +} + +.tweak-color__circle_background { + border: solid 1px var(--tg-theme-hint-color); + background-color: var(--tg-theme-secondary-bg-color); +} + +.cloud-storage__table { + margin-bottom: 10px; +} + +.link__list { + color: var(--tg-theme-hint-color); + width: 88vw; +} + diff --git a/examples/multibot/README.MD b/examples/multibot/README.MD new file mode 100644 index 000000000..3693d363f --- /dev/null +++ b/examples/multibot/README.MD @@ -0,0 +1,17 @@ +You probably have seen bots which allow you to send them token of your bot and then handle updates providing some functionality for your bot. +{}'.format(escape_html(content) if escape else content)
+
+
+def hpre(content: str, escape: Optional[bool]=True, language: str="") -> str:
+ """
+ Returns an HTML-formatted preformatted string.
+
+ :param content: The string to preformatted.
+ :type content: :obj:`str`
+
+ :param escape: True if you need to escape special characters. Defaults to True.
+ :type escape: :obj:`bool`
+
+ :return: The formatted string.
+ :rtype: :obj:`str`
+ """
+ return '{}{text}",
+ "code": "{text}",
+ # "url": "{text}", # @badiboy plain URLs have no text and do not need tags
+ "text_link": "{text}",
+ "strikethrough": "{text}", + "expandable_blockquote": "
{text}", + + } + + if custom_subs: + for key, value in custom_subs.items(): + _subs[key] = value + utf16_text = text.encode("utf-16-le") + html_text = "" + + def func(upd_text, subst_type=None, url=None, user=None, custom_emoji_id=None, language=None): + upd_text = upd_text.decode("utf-16-le") + if subst_type == "text_mention": + subst_type = "text_link" + url = "tg://user?id={0}".format(user.id) + elif subst_type == "mention": + url = "https://t.me/{0}".format(upd_text[1:]) + upd_text = upd_text.replace("&", "&").replace("<", "<").replace(">", ">") + if not subst_type or not _subs.get(subst_type): + return upd_text + subs = _subs.get(subst_type) + if subst_type == "custom_emoji": + return subs.format(text=upd_text, custom_emoji_id=custom_emoji_id) + elif (subst_type == "pre") and language: + return "
{1}{text}",
- "code" : "{text}",
- "url" : "{text}",
- "text_link": "{text}"
- }
- if hasattr(self, "custom_subs"):
- for type in self.custom_subs:
- _subs[type] = self.custom_subs[type]
- utf16_text = text.encode("utf-16-le")
- html_text = ""
-
- def func(text, type=None, url=None, user=None):
- text = text.decode("utf-16-le")
- if type == "text_mention":
- type = "url"
- url = "tg://user?id={0}".format(user.id)
- elif type == "mention":
- url = "https://t.me/{0}".format(text[1:])
- if not type or not _subs.get(type):
- return text
- subs = _subs.get(type)
- text = text.replace("&", "&").replace("<", "<").replace(">", ">")
- return subs.format(text=text, url=url)
-
- offset = 0
- for entity in entities:
- if entity.offset > offset:
- html_text += func(utf16_text[offset * 2 : entity.offset * 2])
- offset = entity.offset
- html_text += func(utf16_text[offset * 2 : (offset + entity.length) * 2], entity.type, entity.url, entity.user)
- offset += entity.length
- if offset * 2 < len(utf16_text):
- html_text += func(utf16_text[offset * 2:])
- return html_text
+ :param my_chat_member: Optional. The bot's chat member status was updated in a chat. For private chats, this update
+ is received only when the bot is blocked or unblocked by the user.
+ :type my_chat_member: :class:`telebot.types.ChatMemberUpdated`
- @property
- def html_text(self):
- return self.__html_text(self.text, self.entities)
+ :param chat_member: Optional. A chat member's status was updated in a chat. The bot must be an administrator in the
+ chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.
+ :type chat_member: :class:`telebot.types.ChatMemberUpdated`
- @property
- def html_caption(self):
- return self.__html_text(self.caption, self.caption_entities)
+ :param chat_join_request: Optional. A request to join the chat has been sent. The bot must have the
+ can_invite_users administrator right in the chat to receive these updates.
+ :type chat_join_request: :class:`telebot.types.ChatJoinRequest`
+ :param chat_boost: Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
+ :type chat_boost: :class:`telebot.types.ChatBoostUpdated`
-class MessageEntity(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- type = obj['type']
- offset = obj['offset']
- length = obj['length']
- url = obj.get('url')
- user = None
- if 'user' in obj:
- user = User.de_json(obj['user'])
- return cls(type, offset, length, url, user)
+ :param removed_chat_boost: Optional. A chat boost was removed. The bot must be an administrator in the chat to receive these updates.
+ :type removed_chat_boost: :class:`telebot.types.RemovedChatBoost`
- def __init__(self, type, offset, length, url=None, user=None):
- self.type = type
- self.offset = offset
- self.length = length
- self.url = url
- self.user = user
+ :param business_connection: Optional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot
+ :type business_connection: :class:`telebot.types.BusinessConnection`
+ :param business_message: Optional. New non-service message from a connected business account
+ :type business_message: :class:`telebot.types.Message`
-class PhotoSize(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- file_id = obj['file_id']
- width = obj['width']
- height = obj['height']
- file_size = obj.get('file_size')
- return cls(file_id, width, height, file_size)
+ :param edited_business_message: Optional. New version of a non-service message from a connected business account that is known to the bot and was edited
+ :type edited_business_message: :class:`telebot.types.Message`
- def __init__(self, file_id, width, height, file_size=None):
- self.file_size = file_size
- self.height = height
- self.width = width
- self.file_id = file_id
+ :param deleted_business_messages: Optional. Service message: the chat connected to the business account was deleted
+ :type deleted_business_messages: :class:`telebot.types.BusinessMessagesDeleted`
+ :return: Instance of the class
+ :rtype: :class:`telebot.types.Update`
-class Audio(JsonDeserializable):
+ """
@classmethod
def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- file_id = obj['file_id']
- duration = obj['duration']
- performer = obj.get('performer')
- title = obj.get('title')
- mime_type = obj.get('mime_type')
- file_size = obj.get('file_size')
- return cls(file_id, duration, performer, title, mime_type, file_size)
+ if json_string is None: return None
+ obj = cls.check_json(json_string, dict_copy=False)
+ update_id = obj['update_id']
+ message = Message.de_json(obj.get('message'))
+ edited_message = Message.de_json(obj.get('edited_message'))
+ channel_post = Message.de_json(obj.get('channel_post'))
+ edited_channel_post = Message.de_json(obj.get('edited_channel_post'))
+ inline_query = InlineQuery.de_json(obj.get('inline_query'))
+ chosen_inline_result = ChosenInlineResult.de_json(obj.get('chosen_inline_result'))
+ callback_query = CallbackQuery.de_json(obj.get('callback_query'))
+ shipping_query = ShippingQuery.de_json(obj.get('shipping_query'))
+ pre_checkout_query = PreCheckoutQuery.de_json(obj.get('pre_checkout_query'))
+ poll = Poll.de_json(obj.get('poll'))
+ poll_answer = PollAnswer.de_json(obj.get('poll_answer'))
+ my_chat_member = ChatMemberUpdated.de_json(obj.get('my_chat_member'))
+ chat_member = ChatMemberUpdated.de_json(obj.get('chat_member'))
+ chat_join_request = ChatJoinRequest.de_json(obj.get('chat_join_request'))
+ message_reaction = MessageReactionUpdated.de_json(obj.get('message_reaction'))
+ message_reaction_count = MessageReactionCountUpdated.de_json(obj.get('message_reaction_count'))
+ removed_chat_boost = ChatBoostRemoved.de_json(obj.get('removed_chat_boost'))
+ chat_boost = ChatBoostUpdated.de_json(obj.get('chat_boost'))
+ business_connection = BusinessConnection.de_json(obj.get('business_connection'))
+ business_message = Message.de_json(obj.get('business_message'))
+ edited_business_message = Message.de_json(obj.get('edited_business_message'))
+ deleted_business_messages = BusinessMessagesDeleted.de_json(obj.get('deleted_business_messages'))
+ purchased_paid_media = PaidMediaPurchased.de_json(obj.get('purchased_paid_media'))
- def __init__(self, file_id, duration, performer=None, title=None, mime_type=None, file_size=None):
- self.file_id = file_id
- self.duration = duration
- self.performer = performer
- self.title = title
- self.mime_type = mime_type
- self.file_size = file_size
+ return cls(update_id, message, edited_message, channel_post, edited_channel_post, inline_query,
+ chosen_inline_result, callback_query, shipping_query, pre_checkout_query, poll, poll_answer,
+ my_chat_member, chat_member, chat_join_request, message_reaction, message_reaction_count,
+ removed_chat_boost, chat_boost, business_connection, business_message, edited_business_message,
+ deleted_business_messages, purchased_paid_media)
+ def __init__(self, update_id, message, edited_message, channel_post, edited_channel_post, inline_query,
+ chosen_inline_result, callback_query, shipping_query, pre_checkout_query, poll, poll_answer,
+ my_chat_member, chat_member, chat_join_request, message_reaction, message_reaction_count,
+ removed_chat_boost, chat_boost, business_connection, business_message, edited_business_message,
+ deleted_business_messages, purchased_paid_media):
+ self.update_id: int = update_id
+ self.message: Optional[Message] = message
+ self.edited_message: Optional[Message] = edited_message
+ self.channel_post: Optional[Message] = channel_post
+ self.edited_channel_post: Optional[Message] = edited_channel_post
+ self.inline_query: Optional[InlineQuery] = inline_query
+ self.chosen_inline_result: Optional[ChosenInlineResult] = chosen_inline_result
+ self.callback_query: Optional[CallbackQuery] = callback_query
+ self.shipping_query: Optional[ShippingQuery] = shipping_query
+ self.pre_checkout_query: Optional[PreCheckoutQuery] = pre_checkout_query
+ self.poll: Optional[Poll] = poll
+ self.poll_answer: Optional[PollAnswer] = poll_answer
+ self.my_chat_member: Optional[ChatMemberUpdated] = my_chat_member
+ self.chat_member: Optional[ChatMemberUpdated] = chat_member
+ self.chat_join_request: Optional[ChatJoinRequest] = chat_join_request
+ self.message_reaction: Optional[MessageReactionUpdated] = message_reaction
+ self.message_reaction_count: Optional[MessageReactionCountUpdated] = message_reaction_count
+ self.removed_chat_boost: Optional[ChatBoostRemoved] = removed_chat_boost
+ self.chat_boost: Optional[ChatBoostUpdated] = chat_boost
+ self.business_connection: Optional[BusinessConnection] = business_connection
+ self.business_message: Optional[Message] = business_message
+ self.edited_business_message: Optional[Message] = edited_business_message
+ self.deleted_business_messages: Optional[BusinessMessagesDeleted] = deleted_business_messages
+ self.purchased_paid_media: Optional[PaidMediaPurchased] = purchased_paid_media
+
+
+class ChatMemberUpdated(JsonDeserializable):
+ """
+ This object represents changes in the status of a chat member.
-class Voice(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- file_id = obj['file_id']
- duration = obj['duration']
- mime_type = obj.get('mime_type')
- file_size = obj.get('file_size')
- return cls(file_id, duration, mime_type, file_size)
+ Telegram Documentation: https://core.telegram.org/bots/api#chatmemberupdated
- def __init__(self, file_id, duration, mime_type=None, file_size=None):
- self.file_id = file_id
- self.duration = duration
- self.mime_type = mime_type
- self.file_size = file_size
+ :param chat: Chat the user belongs to
+ :type chat: :class:`telebot.types.Chat`
+ :param from_user: Performer of the action, which resulted in the change
+ :type from_user: :class:`telebot.types.User`
-class Document(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- file_id = obj['file_id']
- thumb = None
- if 'thumb' in obj and 'file_id' in obj['thumb']:
- thumb = PhotoSize.de_json(obj['thumb'])
- file_name = obj.get('file_name')
- mime_type = obj.get('mime_type')
- file_size = obj.get('file_size')
- return cls(file_id, thumb, file_name, mime_type, file_size)
+ :param date: Date the change was done in Unix time
+ :type date: :obj:`int`
- def __init__(self, file_id, thumb=None, file_name=None, mime_type=None, file_size=None):
- self.file_id = file_id
- self.thumb = thumb
- self.file_name = file_name
- self.mime_type = mime_type
- self.file_size = file_size
+ :param old_chat_member: Previous information about the chat member
+ :type old_chat_member: :class:`telebot.types.ChatMember`
+ :param new_chat_member: New information about the chat member
+ :type new_chat_member: :class:`telebot.types.ChatMember`
-class Video(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- file_id = obj['file_id']
- width = obj['width']
- height = obj['height']
- duration = obj['duration']
- thumb = None
- if 'thumb' in obj:
- thumb = PhotoSize.de_json(obj['thumb'])
- mime_type = obj.get('mime_type')
- file_size = obj.get('file_size')
- return cls(file_id, width, height, duration, thumb, mime_type, file_size)
+ :param invite_link: Optional. Chat invite link, which was used by the user to join the chat; for joining by invite
+ link events only.
+ :type invite_link: :class:`telebot.types.ChatInviteLink`
- def __init__(self, file_id, width, height, duration, thumb=None, mime_type=None, file_size=None):
- self.file_id = file_id
- self.width = width
- self.height = height
- self.duration = duration
- self.thumb = thumb
- self.mime_type = mime_type
- self.file_size = file_size
+ :param via_join_request: Optional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator
+ :type via_join_request: :obj:`bool`
+ :param via_chat_folder_invite_link: Optional. True, if the user joined the chat via a chat folder invite link
+ :type via_chat_folder_invite_link: :obj:`bool`
-class VideoNote(JsonDeserializable):
+ :return: Instance of the class
+ :rtype: :class:`telebot.types.ChatMemberUpdated`
+ """
@classmethod
def de_json(cls, json_string):
+ if json_string is None: return None
obj = cls.check_json(json_string)
- file_id = obj['file_id']
- length = obj['length']
- duration = obj['duration']
- thumb = None
- if 'thumb' in obj:
- thumb = PhotoSize.de_json(obj['thumb'])
- file_size = obj.get('file_size')
- return cls(file_id, length, duration, thumb, file_size)
+ obj['chat'] = Chat.de_json(obj['chat'])
+ obj['from_user'] = User.de_json(obj.pop('from'))
+ obj['old_chat_member'] = ChatMember.de_json(obj['old_chat_member'])
+ obj['new_chat_member'] = ChatMember.de_json(obj['new_chat_member'])
+ obj['invite_link'] = ChatInviteLink.de_json(obj.get('invite_link'))
+ return cls(**obj)
+
+ def __init__(self, chat, from_user, date, old_chat_member, new_chat_member, invite_link=None,
+ via_join_request=None, via_chat_folder_invite_link=None,
+ **kwargs):
+ self.chat: Chat = chat
+ self.from_user: User = from_user
+ self.date: int = date
+ self.old_chat_member: ChatMember = old_chat_member
+ self.new_chat_member: ChatMember = new_chat_member
+ self.invite_link: Optional[ChatInviteLink] = invite_link
+ self.via_join_request: Optional[bool] = via_join_request
+ self.via_chat_folder_invite_link: Optional[bool] = via_chat_folder_invite_link
- def __init__(self, file_id, length, duration, thumb=None, file_size=None):
- self.file_id = file_id
- self.length = length
- self.duration = duration
- self.thumb = thumb
- self.file_size = file_size
+ @property
+ def difference(self) -> Dict[str, List]:
+ """
+ Get the difference between `old_chat_member` and `new_chat_member`
+ as a dict in the following format {'parameter': [old_value, new_value]}
+ E.g {'status': ['member', 'kicked'], 'until_date': [None, 1625055092]}
-class Contact(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- phone_number = obj['phone_number']
- first_name = obj['first_name']
- last_name = obj.get('last_name')
- user_id = obj.get('user_id')
- return cls(phone_number, first_name, last_name, user_id)
+ :return: Dict of differences
+ :rtype: Dict[str, List]
+ """
+ old: Dict = self.old_chat_member.__dict__
+ new: Dict = self.new_chat_member.__dict__
+ dif = {}
+ for key in new:
+ if key == 'user': continue
+ if new[key] != old[key]:
+ dif[key] = [old[key], new[key]]
+ return dif
- def __init__(self, phone_number, first_name, last_name=None, user_id=None):
- self.phone_number = phone_number
- self.first_name = first_name
- self.last_name = last_name
- self.user_id = user_id
+class ChatJoinRequest(JsonDeserializable):
+ """
+ Represents a join request sent to a chat.
-class Location(JsonDeserializable):
- @classmethod
- def de_json(cls, json_string):
- obj = cls.check_json(json_string)
- longitude = obj['longitude']
- latitude = obj['latitude']
- return cls(longitude, latitude)
+ Telegram Documentation: https://core.telegram.org/bots/api#chatjoinrequest
- def __init__(self, longitude, latitude):
- self.longitude = longitude
- self.latitude = latitude
+ :param chat: Chat to which the request was sent
+ :type chat: :class:`telebot.types.Chat`
+ :param from_user: User that sent the join request
+ :type from_user: :class:`telebot.types.User`
-class Venue(JsonDeserializable):
- @classmethod
- def de_json(cls, json_type):
- obj = cls.check_json(json_type)
- location = Location.de_json(obj['location'])
- title = obj['title']
- address = obj['address']
- foursquare_id = obj.get('foursquare_id')
- return cls(location, title, address, foursquare_id)
+ :param user_chat_id: Optional. Identifier of a private chat with the user who sent the join request.
+ This number may have more than 32 significant bits and some programming languages may have difficulty/silent
+ defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision
+ float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages
+ until the join request is processed, assuming no other administrator contacted the user.
+ :type user_chat_id: :obj:`int`
- def __init__(self, location, title, address, foursquare_id=None):
- self.location = location
- self.title = title
- self.address = address
- self.foursquare_id = foursquare_id
+ :param date: Date the request was sent in Unix time
+ :type date: :obj:`int`
+ :param bio: Optional. Bio of the user.
+ :type bio: :obj:`str`
-class UserProfilePhotos(JsonDeserializable):
+ :param invite_link: Optional. Chat invite link that was used by the user to send the join request
+ :type invite_link: :class:`telebot.types.ChatInviteLink`
+
+ :return: Instance of the class
+ :rtype: :class:`telebot.types.ChatJoinRequest`
+ """
@classmethod
def de_json(cls, json_string):
+ if json_string is None: return None
obj = cls.check_json(json_string)
- total_count = obj['total_count']
- photos = [[PhotoSize.de_json(y) for y in x] for x in obj['photos']]
- return cls(total_count, photos)
+ obj['chat'] = Chat.de_json(obj['chat'])
+ obj['from_user'] = User.de_json(obj['from'])
+ obj['invite_link'] = ChatInviteLink.de_json(obj.get('invite_link'))
+ return cls(**obj)
- def __init__(self, total_count, photos):
- self.total_count = total_count
- self.photos = photos
+ def __init__(self, chat, from_user, user_chat_id, date, bio=None, invite_link=None, **kwargs):
+ self.chat: Chat = chat
+ self.from_user: User = from_user
+ self.date: str = date
+ self.bio: Optional[str] = bio
+ self.invite_link: Optional[ChatInviteLink] = invite_link
+ self.user_chat_id: int = user_chat_id
-class File(JsonDeserializable):
- @classmethod
- def de_json(cls, json_type):
- obj = cls.check_json(json_type)
- file_id = obj['file_id']
- file_size = obj.get('file_size')
- file_path = obj.get('file_path')
- return cls(file_id, file_size, file_path)
+class WebhookInfo(JsonDeserializable):
+ """
+ Describes the current status of a webhook.
- def __init__(self, file_id, file_size, file_path):
- self.file_id = file_id
- self.file_size = file_size
- self.file_path = file_path
+ Telegram Documentation: https://core.telegram.org/bots/api#webhookinfo
+ :param url: Webhook URL, may be empty if webhook is not set up
+ :type url: :obj:`str`
-class ForceReply(JsonSerializable):
- def __init__(self, selective=None):
- self.selective = selective
+ :param has_custom_certificate: True, if a custom certificate was provided for webhook certificate checks
+ :type has_custom_certificate: :obj:`bool`
- def to_json(self):
- json_dict = {'force_reply': True}
- if self.selective:
- json_dict['selective'] = True
- return json.dumps(json_dict)
+ :param pending_update_count: Number of updates awaiting delivery
+ :type pending_update_count: :obj:`int`
+ :param ip_address: Optional. Currently used webhook IP address
+ :type ip_address: :obj:`str`
-class ReplyKeyboardRemove(JsonSerializable):
- def __init__(self, selective=None):
- self.selective = selective
+ :param last_error_date: Optional. Unix time for the most recent error that happened when trying to deliver an
+ update via webhook
+ :type last_error_date: :obj:`int`
- def to_json(self):
- json_dict = {'remove_keyboard': True}
- if self.selective:
- json_dict['selective'] = True
- return json.dumps(json_dict)
+ :param last_error_message: Optional. Error message in human-readable format for the most recent error that
+ happened when trying to deliver an update via webhook
+ :type last_error_message: :obj:`str`
+ :param last_synchronization_error_date: Optional. Unix time of the most recent error that happened when trying
+ to synchronize available updates with Telegram datacenters
+ :type last_synchronization_error_date: :obj:`int`
-class ReplyKeyboardMarkup(JsonSerializable):
- def __init__(self, resize_keyboard=None, one_time_keyboard=None, selective=None, row_width=3):
- self.resize_keyboard = resize_keyboard
- self.one_time_keyboard = one_time_keyboard
- self.selective = selective
- self.row_width = row_width
+ :param max_connections: Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook
+ for update delivery
+ :type max_connections: :obj:`int`
- self.keyboard = []
+ :param allowed_updates: Optional. A list of update types the bot is subscribed to. Defaults to all update types
+ except chat_member
+ :type allowed_updates: :obj:`list` of :obj:`str`
- def add(self, *args):
- """
- This function adds strings to the keyboard, while not exceeding row_width.
- E.g. ReplyKeyboardMarkup#add("A", "B", "C") yields the json result {keyboard: [["A"], ["B"], ["C"]]}
- when row_width is set to 1.
- When row_width is set to 2, the following is the result of this function: {keyboard: [["A", "B"], ["C"]]}
- See https://core.telegram.org/bots/api#replykeyboardmarkup
- :param args: KeyboardButton to append to the keyboard
- """
- i = 1
- row = []
- for button in args:
- if util.is_string(button):
- row.append({'text': button})
- elif isinstance(button, bytes):
- row.append({'text': button.decode('utf-8')})
- else:
- row.append(button.to_dic())
- if i % self.row_width == 0:
- self.keyboard.append(row)
- row = []
- i += 1
- if len(row) > 0:
- self.keyboard.append(row)
+ :return: Instance of the class
+ :rtype: :class:`telebot.types.WebhookInfo`
+ """
+ @classmethod
+ def de_json(cls, json_string):
+ if json_string is None: return None
+ obj = cls.check_json(json_string, dict_copy=False)
+ return cls(**obj)
+
+ def __init__(self, url, has_custom_certificate, pending_update_count, ip_address=None,
+ last_error_date=None, last_error_message=None, last_synchronization_error_date=None,
+ max_connections=None, allowed_updates=None, **kwargs):
+ self.url: str = url
+ self.has_custom_certificate: bool = has_custom_certificate
+ self.pending_update_count: int = pending_update_count
+ self.ip_address: Optional[str] = ip_address
+ self.last_error_date: Optional[int] = last_error_date
+ self.last_error_message: Optional[str] = last_error_message
+ self.last_synchronization_error_date: Optional[int] = last_synchronization_error_date
+ self.max_connections: Optional[int] = max_connections
+ self.allowed_updates: Optional[int] = allowed_updates
+
+
+class User(JsonDeserializable, Dictionaryable, JsonSerializable):
+ """
+ This object represents a Telegram user or bot.
- def row(self, *args):
- """
- Adds a list of KeyboardButton to the keyboard. This function does not consider row_width.
- ReplyKeyboardMarkup#row("A")#row("B", "C")#to_json() outputs '{keyboard: [["A"], ["B", "C"]]}'
- See https://core.telegram.org/bots/api#replykeyboardmarkup
- :param args: strings
- :return: self, to allow function chaining.
- """
- btn_array = []
- for button in args:
- if util.is_string(button):
- btn_array.append({'text': button})
- else:
- btn_array.append(button.to_dic())
- self.keyboard.append(btn_array)
- return self
+ Telegram Documentation: https://core.telegram.org/bots/api#user
- def to_json(self):
- """
- Converts this object to its json representation following the Telegram API guidelines described here:
- https://core.telegram.org/bots/api#replykeyboardmarkup
- :return:
- """
- json_dict = {'keyboard': self.keyboard}
- if self.one_time_keyboard:
- json_dict['one_time_keyboard'] = True
+ :param id: Unique identifier for this user or bot. This number may have more than 32 significant bits and some
+ programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant
+ bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
+ :type id: :obj:`int`
- if self.resize_keyboard:
- json_dict['resize_keyboard'] = True
+ :param is_bot: True, if this user is a bot
+ :type is_bot: :obj:`bool`
- if self.selective:
- json_dict['selective'] = True
+ :param first_name: User's or bot's first name
+ :type first_name: :obj:`str`
- return json.dumps(json_dict)
+ :param last_name: Optional. User's or bot's last name
+ :type last_name: :obj:`str`
+ :param username: Optional. User's or bot's username
+ :type username: :obj:`str`
-class KeyboardButton(Dictionaryable, JsonSerializable):
- def __init__(self, text, request_contact=None, request_location=None):
- self.text = text
- self.request_contact = request_contact
- self.request_location = request_location
+ :param language_code: Optional. IETF language tag of the user's language
+ :type language_code: :obj:`str`
- def to_json(self):
- return json.dumps(self.to_dic())
+ :param is_premium: Optional. :obj:`bool`, if this user is a Telegram Premium user
+ :type is_premium: :obj:`bool`
- def to_dic(self):
- json_dic = {'text': self.text}
- if self.request_contact:
- json_dic['request_contact'] = self.request_contact
- if self.request_location:
- json_dic['request_location'] = self.request_location
- return json_dic
+ :param added_to_attachment_menu: Optional. :obj:`bool`, if this user added the bot to the attachment menu
+ :type added_to_attachment_menu: :obj:`bool`
+ :param can_join_groups: Optional. True, if the bot can be invited to groups. Returned only in getMe.
+ :type can_join_groups: :obj:`bool`
-class InlineKeyboardMarkup(Dictionaryable, JsonSerializable):
- def __init__(self, row_width=3):
- self.row_width = row_width
+ :param can_read_all_group_messages: Optional. True, if privacy mode is disabled for the bot. Returned only in
+ getMe.
+ :type can_read_all_group_messages: :obj:`bool`
- self.keyboard = []
+ :param supports_inline_queries: Optional. True, if the bot supports inline queries. Returned only in getMe.
+ :type supports_inline_queries: :obj:`bool`
- def add(self, *args):
- """
- This function adds strings to the keyboard, while not exceeding row_width.
- E.g. ReplyKeyboardMarkup#add("A", "B", "C") yields the json result {keyboard: [["A"], ["B"], ["C"]]}
- when row_width is set to 1.
- When row_width is set to 2, the following is the result of this function: {keyboard: [["A", "B"], ["C"]]}
- See https://core.telegram.org/bots/api#replykeyboardmarkup
- :param args: KeyboardButton to append to the keyboard
+ :param can_connect_to_business: Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe.
+ :type can_connect_to_business: :obj:`bool`
+
+ :param has_main_web_app: Optional. True, if the bot has a main Web App. Returned only in getMe.
+ :type has_main_web_app: :obj:`bool`
+
+ :return: Instance of the class
+ :rtype: :class:`telebot.types.User`
+ """
+ @classmethod
+ def de_json(cls, json_string):
+ if json_string is None: return None
+ obj = cls.check_json(json_string, dict_copy=False)
+ return cls(**obj)
+
+ # noinspection PyShadowingBuiltins
+ def __init__(self, id, is_bot, first_name, last_name=None, username=None, language_code=None,
+ can_join_groups=None, can_read_all_group_messages=None, supports_inline_queries=None,
+ is_premium=None, added_to_attachment_menu=None, can_connect_to_business=None,
+ has_main_web_app=None, **kwargs):
+ self.id: int = id
+ self.is_bot: bool = is_bot
+ self.first_name: str = first_name
+ self.username: Optional[str] = username
+ self.last_name: Optional[str] = last_name
+ self.language_code: Optional[str] = language_code
+ self.can_join_groups: Optional[bool] = can_join_groups
+ self.can_read_all_group_messages: Optional[bool] = can_read_all_group_messages
+ self.supports_inline_queries: Optional[bool] = supports_inline_queries
+ self.is_premium: Optional[bool] = is_premium
+ self.added_to_attachment_menu: Optional[bool] = added_to_attachment_menu
+ self.can_connect_to_business: Optional[bool] = can_connect_to_business
+ self.has_main_web_app: Optional[bool] = has_main_web_app
+
+ @property
+ def full_name(self) -> str:
+ """
+ :return: User's full name
+ """
+ full_name = self.first_name
+ if self.last_name:
+ full_name += ' {0}'.format(self.last_name)
+ return full_name
+
+ def to_json(self):
+ return json.dumps(self.to_dict())
+
+ def to_dict(self):
+ return {'id': self.id,
+ 'is_bot': self.is_bot,
+ 'first_name': self.first_name,
+ 'last_name': self.last_name,
+ 'username': self.username,
+ 'language_code': self.language_code,
+ 'can_join_groups': self.can_join_groups,
+ 'can_read_all_group_messages': self.can_read_all_group_messages,
+ 'supports_inline_queries': self.supports_inline_queries,
+ 'is_premium': self.is_premium,
+ 'added_to_attachment_menu': self.added_to_attachment_menu,
+ 'can_connect_to_business': self.can_connect_to_business,
+ 'has_main_web_app': self.has_main_web_app}
+
+
+# noinspection PyShadowingBuiltins
+class GroupChat(JsonDeserializable):
+ """
+ :meta private:
+ """
+ @classmethod
+ def de_json(cls, json_string):
+ if json_string is None: return None
+ obj = cls.check_json(json_string, dict_copy=False)
+ return cls(**obj)
+
+ def __init__(self, id, title, **kwargs):
+ self.id: int = id
+ self.title: str = title
+
+
+# noinspection PyShadowingBuiltins
+class ChatFullInfo(JsonDeserializable):
+ """
+ This object represents a chat.
+
+ Telegram Documentation: https://core.telegram.org/bots/api#chat
+
+ :param id: Unique identifier for this chat. This number may have more than 32 significant bits and some programming
+ languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed
+ 64-bit integer or double-precision float type are safe for storing this identifier.
+ :type id: :obj:`int`
+
+ :param type: Type of chat, can be either “private”, “group”, “supergroup” or “channel”
+ :type type: :obj:`str`
+
+ :param title: Optional. Title, for supergroups, channels and group chats
+ :type title: :obj:`str`
+
+ :param username: Optional. Username, for private chats, supergroups and channels if available
+ :type username: :obj:`str`
+
+ :param first_name: Optional. First name of the other party in a private chat
+ :type first_name: :obj:`str`
+
+ :param last_name: Optional. Last name of the other party in a private chat
+ :type last_name: :obj:`str`
+
+ :param is_forum: Optional. True, if the supergroup chat is a forum (has topics enabled)
+ :type is_forum: :obj:`bool`
+
+ :param is_direct_messages: Optional. True, if the chat is the direct messages chat of a channel
+ :type is_direct_messages: :obj:`bool`
+
+ :param max_reaction_count: Optional. The maximum number of reactions that can be set on a message in the chat
+ :type max_reaction_count: :obj:`int`
+
+ :param photo: Optional. Chat photo. Returned only in getChat.
+ :type photo: :class:`telebot.types.ChatPhoto`
+
+ :param active_usernames: Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.
+ :type active_usernames: :obj:`list` of :obj:`str`
+
+ :param birthdate: Optional. Birthdate of the other party in a private chat. Returned only in getChat.
+ :type birthdate: :obj:`str`
+
+ :param business_intro: Optional. Business intro for the chat. Returned only in getChat.
+ :type business_intro: :class:`telebot.types.BusinessIntro`
+
+ :param business_location: Optional. Business location for the chat. Returned only in getChat.
+ :type business_location: :class:`telebot.types.BusinessLocation`
+
+ :param business_opening_hours : Optional. Business opening hours for the chat. Returned only in getChat.
+ :type business_opening_hours: :class:`telebot.types.BusinessHours`
+
+ :param personal_chat: Optional. For private chats, the personal channel of the user. Returned only in getChat.
+ :type personal_chat: :class:`telebot.types.Chat`
+
+ :param parent_chat: Optional. Information about the corresponding channel chat; for direct messages chats only
+ :type parent_chat: :class:`telebot.types.Chat`
+
+ :param available_reactions: Optional. List of available chat reactions; for private chats, supergroups and channels. Returned only in getChat.
+ :type available_reactions: :obj:`list` of :class:`telebot.types.ReactionType`
+
+ :param accent_color_id: Optional. Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo,
+ reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.
+ :type accent_color_id: :obj:`int`
+
+ :param background_custom_emoji_id: Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.
+ :type background_custom_emoji_id: :obj:`str`
+
+ :param profile_accent_color_id: Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.
+ :type profile_accent_color_id: :obj:`int`
+
+ :param profile_background_custom_emoji_id: Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.
+ :type profile_background_custom_emoji_id: :obj:`str`
+
+ :param emoji_status_custom_emoji_id: Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.
+ :type emoji_status_custom_emoji_id: :obj:`str`
+
+ :param emoji_status_expiration_date: Optional. Expiration date of the emoji status of the other party in a private chat, if any. Returned only in getChat.
+ :type emoji_status_expiration_date: :obj:`int`
+
+ :param bio: Optional. Bio of the other party in a private chat. Returned only in getChat.
+ :type bio: :obj:`str`
+
+ :param has_private_forwards: Optional. :obj:`bool`, if privacy settings of the other party in the private chat allows to use tg://user?id=