mirror of
https://github.com/langgenius/dify-plugin-sdks.git
synced 2026-07-22 10:25:23 -04:00
Yeuoly
1004fa255c
- Renamed "Message Received" to more specific labels: - message_edited.yaml → "Message Edited" - business_message_received.yaml → "Business Message Received" - business_message_edited.yaml → "Business Message Edited" - channel_post_created.yaml → "Channel Post Created" - channel_post_edited.yaml → "Channel Post Edited" Now all event labels are unique and clearly describe their specific purpose. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
4868 lines
200 KiB
YAML
4868 lines
200 KiB
YAML
identity:
|
|
name: message_edited
|
|
author: langgenius
|
|
label:
|
|
en_US: Message Edited
|
|
zh_Hans: 消息已编辑
|
|
ja_JP: メッセージ編集
|
|
description:
|
|
en_US: Triggers when a previously sent message is edited.
|
|
zh_Hans: 当已发送的消息被编辑时触发。
|
|
ja_JP: 送信済みメッセージが編集されたときにトリガーします。
|
|
parameters: []
|
|
output_schema:
|
|
type: object
|
|
additionalProperties: false
|
|
required:
|
|
- update_id
|
|
- message
|
|
properties:
|
|
update_id:
|
|
type: integer
|
|
description: Unique identifier for the Telegram update.
|
|
message:
|
|
type: object
|
|
description: Telegram Message object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
message_id:
|
|
type: integer
|
|
description: Unique message identifier inside this chat.
|
|
message_thread_id:
|
|
type: integer
|
|
description: Identifier of the message thread to which the message belongs.
|
|
from:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_chat:
|
|
type: object
|
|
description: Telegram Chat object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
is_forum:
|
|
type: boolean
|
|
description: True if the supergroup chat is a forum.
|
|
photo:
|
|
type: object
|
|
description: Chat photo information.
|
|
properties:
|
|
small_file_id:
|
|
type: string
|
|
description: File identifier of the small (160x160) chat photo version.
|
|
small_file_unique_id:
|
|
type: string
|
|
description: Unique file identifier of the small chat photo version.
|
|
big_file_id:
|
|
type: string
|
|
description: File identifier of the big (640x640) chat photo version.
|
|
big_file_unique_id:
|
|
type: string
|
|
description: Unique file identifier of the big chat photo version.
|
|
additionalProperties: false
|
|
active_usernames:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of all active chat usernames.
|
|
emoji_status_custom_emoji_id:
|
|
type: string
|
|
description: Custom emoji identifier of the chat emoji status.
|
|
bio:
|
|
type: string
|
|
description: Bio of the other party in a private chat.
|
|
has_private_forwards:
|
|
type: boolean
|
|
description: True if privacy settings allow private forwards.
|
|
has_restricted_voice_and_video_messages:
|
|
type: boolean
|
|
description: True if voice and video messages are restricted.
|
|
join_to_send_messages:
|
|
type: boolean
|
|
description: True if all users must join before they can send messages.
|
|
join_by_request:
|
|
type: boolean
|
|
description: True if only users invited by administrators can join.
|
|
description:
|
|
type: string
|
|
description: Chat description for supergroups and channels.
|
|
invite_link:
|
|
type: string
|
|
description: Primary invite link for the chat.
|
|
pinned_message:
|
|
type: object
|
|
description: Pinned message in the sender chat.
|
|
additionalProperties: false
|
|
properties:
|
|
message_id:
|
|
type: integer
|
|
description: Unique message identifier inside the chat.
|
|
message_thread_id:
|
|
type: integer
|
|
description: Identifier of the thread the message belongs to, for
|
|
forum topics.
|
|
date:
|
|
type: integer
|
|
description: Date the message was sent in Unix time.
|
|
chat:
|
|
type: object
|
|
description: Chat the message belongs to.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
from:
|
|
type: object
|
|
description: Sender of the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_chat:
|
|
type: object
|
|
description: Channel on behalf of which the message was sent.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
text:
|
|
type: string
|
|
description: Text of the message.
|
|
entities:
|
|
type: array
|
|
description: Special entities that appear in message text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the
|
|
entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the
|
|
bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline
|
|
mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
permissions:
|
|
type: object
|
|
description: Default chat member permissions.
|
|
properties:
|
|
can_send_messages:
|
|
type: boolean
|
|
description: True if the user may send text messages.
|
|
can_send_audios:
|
|
type: boolean
|
|
description: True if the user may send audio messages.
|
|
can_send_documents:
|
|
type: boolean
|
|
description: True if the user may send document messages.
|
|
can_send_photos:
|
|
type: boolean
|
|
description: True if the user may send photos.
|
|
can_send_videos:
|
|
type: boolean
|
|
description: True if the user may send videos.
|
|
can_send_video_notes:
|
|
type: boolean
|
|
description: True if the user may send video notes.
|
|
can_send_voice_notes:
|
|
type: boolean
|
|
description: True if the user may send voice notes.
|
|
can_send_polls:
|
|
type: boolean
|
|
description: True if the user may send polls.
|
|
can_send_other_messages:
|
|
type: boolean
|
|
description: True if the user may send animations, games, stickers,
|
|
and use inline bots.
|
|
can_add_web_page_previews:
|
|
type: boolean
|
|
description: True if the user may add web page previews to messages.
|
|
can_change_info:
|
|
type: boolean
|
|
description: True if the user may change the chat title, photo,
|
|
and other settings.
|
|
can_invite_users:
|
|
type: boolean
|
|
description: True if the user may invite new users to the chat.
|
|
can_pin_messages:
|
|
type: boolean
|
|
description: True if the user may pin messages.
|
|
can_manage_topics:
|
|
type: boolean
|
|
description: True if the user may manage forum topics.
|
|
can_manage_video_chats:
|
|
type: boolean
|
|
description: True if the user may manage video chats.
|
|
can_post_stories:
|
|
type: boolean
|
|
description: True if the user may post stories.
|
|
can_edit_stories:
|
|
type: boolean
|
|
description: True if the user may edit stories.
|
|
can_delete_stories:
|
|
type: boolean
|
|
description: True if the user may delete stories.
|
|
additionalProperties: false
|
|
slow_mode_delay:
|
|
type: integer
|
|
description: Allowed delay between consecutive messages for non-administrators.
|
|
message_auto_delete_time:
|
|
type: integer
|
|
description: Time after which messages are automatically deleted.
|
|
has_protected_content:
|
|
type: boolean
|
|
description: True if content protection is enabled.
|
|
sticker_set_name:
|
|
type: string
|
|
description: Name of the group sticker set.
|
|
can_set_sticker_set:
|
|
type: boolean
|
|
description: True if the bot can change the group sticker set.
|
|
linked_chat_id:
|
|
type: integer
|
|
description: Identifier of the linked channel for supergroups.
|
|
location:
|
|
type: object
|
|
description: Location to which the supergroup is connected.
|
|
properties:
|
|
location:
|
|
type: object
|
|
description: Location coordinates of the chat.
|
|
additionalProperties: false
|
|
required:
|
|
- latitude
|
|
- longitude
|
|
properties:
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by the sender.
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by the sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: Radius of uncertainty for the location, in meters;
|
|
0-1500.
|
|
live_period:
|
|
type: integer
|
|
description: Time in seconds while the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which the user is moving, in degrees
|
|
1-360.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts about approaching
|
|
another chat member, in meters.
|
|
address:
|
|
type: string
|
|
description: Address of the location; 1-64 characters, as defined
|
|
by the sender.
|
|
additionalProperties: false
|
|
required:
|
|
- location
|
|
- address
|
|
has_hidden_members:
|
|
type: boolean
|
|
description: True if members are hidden in the chat.
|
|
has_aggressive_anti_spam_enabled:
|
|
type: boolean
|
|
description: True if aggressive anti-spam is enabled.
|
|
has_hidden_participants:
|
|
type: boolean
|
|
description: True if only admins can see other participants.
|
|
has_visible_history:
|
|
type: boolean
|
|
description: True if new members can see message history.
|
|
boost_level:
|
|
type: integer
|
|
description: Current boost level of the chat.
|
|
emoji_status_expiration_date:
|
|
type: integer
|
|
description: Expiration date of the emoji status in Unix time.
|
|
custom_emoji_sticker_set_name:
|
|
type: string
|
|
description: Name of the custom emoji sticker set used in the chat.
|
|
business_intro:
|
|
type: object
|
|
description: Business intro information for the chat.
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Localized title displayed in the business intro.
|
|
message:
|
|
type: string
|
|
description: Introductory message shown to customers.
|
|
sticker:
|
|
type: object
|
|
description: Sticker used in the business intro.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this sticker file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this sticker file.
|
|
emoji:
|
|
type: string
|
|
description: Emoji associated with the sticker.
|
|
type:
|
|
type: string
|
|
description: Sticker type, e.g. regular or custom_emoji.
|
|
width:
|
|
type: integer
|
|
description: Sticker width in pixels.
|
|
height:
|
|
type: integer
|
|
description: Sticker height in pixels.
|
|
is_animated:
|
|
type: boolean
|
|
description: True if the sticker is animated.
|
|
is_video:
|
|
type: boolean
|
|
description: True if the sticker is a video sticker.
|
|
additionalProperties: false
|
|
business_location:
|
|
type: object
|
|
description: Business location information for the chat.
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: Business address used for profile disclosure.
|
|
location:
|
|
type: object
|
|
description: Location coordinates of the chat.
|
|
additionalProperties: false
|
|
required:
|
|
- latitude
|
|
- longitude
|
|
properties:
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by the sender.
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by the sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: Radius of uncertainty for the location, in meters;
|
|
0-1500.
|
|
live_period:
|
|
type: integer
|
|
description: Time in seconds while the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which the user is moving, in degrees
|
|
1-360.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts about approaching
|
|
another chat member, in meters.
|
|
additionalProperties: false
|
|
business_opening_hours:
|
|
type: object
|
|
description: Business opening hours for the chat.
|
|
properties:
|
|
time_zone_name:
|
|
type: string
|
|
description: Time zone in IANA format that the business hours relate
|
|
to.
|
|
opening_hours:
|
|
type: array
|
|
description: Opening hour intervals within the week.
|
|
items:
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
opening_minute:
|
|
type: integer
|
|
description: Minute of the day when the business opens (0-1439).
|
|
closing_minute:
|
|
type: integer
|
|
description: Minute of the day when the business closes (0-1439).
|
|
opening_day:
|
|
type: integer
|
|
description: Day of week when the interval starts, 1 (Monday)
|
|
to 7 (Sunday).
|
|
closing_day:
|
|
type: integer
|
|
description: Day of week when the interval ends, 1 (Monday)
|
|
to 7 (Sunday).
|
|
additionalProperties: false
|
|
personal_chat:
|
|
type: object
|
|
description: Personal chat information if applicable.
|
|
properties:
|
|
chat_id:
|
|
type: integer
|
|
description: Identifier for the personal chat with the business.
|
|
user:
|
|
type: object
|
|
description: User that is part of this personal chat.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
additionalProperties: false
|
|
sender_boost_count:
|
|
type: integer
|
|
description: Number of boosts applied by the sender at the time of sending.
|
|
sender_business_bot:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
date:
|
|
type: integer
|
|
description: Date the message was sent in Unix time.
|
|
business_connection_id:
|
|
type: string
|
|
description: Unique identifier of the business connection through which
|
|
the message was received.
|
|
chat:
|
|
type: object
|
|
description: Telegram Chat object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
is_forum:
|
|
type: boolean
|
|
description: True if the supergroup chat is a forum.
|
|
photo:
|
|
type: object
|
|
description: Chat photo information.
|
|
properties:
|
|
small_file_id:
|
|
type: string
|
|
description: File identifier of the small (160x160) chat photo version.
|
|
small_file_unique_id:
|
|
type: string
|
|
description: Unique file identifier of the small chat photo version.
|
|
big_file_id:
|
|
type: string
|
|
description: File identifier of the big (640x640) chat photo version.
|
|
big_file_unique_id:
|
|
type: string
|
|
description: Unique file identifier of the big chat photo version.
|
|
additionalProperties: false
|
|
active_usernames:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of all active chat usernames.
|
|
emoji_status_custom_emoji_id:
|
|
type: string
|
|
description: Custom emoji identifier of the chat emoji status.
|
|
bio:
|
|
type: string
|
|
description: Bio of the other party in a private chat.
|
|
has_private_forwards:
|
|
type: boolean
|
|
description: True if privacy settings allow private forwards.
|
|
has_restricted_voice_and_video_messages:
|
|
type: boolean
|
|
description: True if voice and video messages are restricted.
|
|
join_to_send_messages:
|
|
type: boolean
|
|
description: True if all users must join before they can send messages.
|
|
join_by_request:
|
|
type: boolean
|
|
description: True if only users invited by administrators can join.
|
|
description:
|
|
type: string
|
|
description: Chat description for supergroups and channels.
|
|
invite_link:
|
|
type: string
|
|
description: Primary invite link for the chat.
|
|
pinned_message:
|
|
type: object
|
|
description: Pinned message in the chat.
|
|
additionalProperties: false
|
|
properties:
|
|
message_id:
|
|
type: integer
|
|
description: Unique message identifier inside the chat.
|
|
message_thread_id:
|
|
type: integer
|
|
description: Identifier of the thread the message belongs to, for
|
|
forum topics.
|
|
date:
|
|
type: integer
|
|
description: Date the message was sent in Unix time.
|
|
chat:
|
|
type: object
|
|
description: Chat the message belongs to.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
from:
|
|
type: object
|
|
description: Sender of the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_chat:
|
|
type: object
|
|
description: Channel on behalf of which the message was sent.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
text:
|
|
type: string
|
|
description: Text of the message.
|
|
entities:
|
|
type: array
|
|
description: Special entities that appear in message text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the
|
|
entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the
|
|
bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline
|
|
mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
permissions:
|
|
type: object
|
|
description: Default chat member permissions.
|
|
properties:
|
|
can_send_messages:
|
|
type: boolean
|
|
description: True if the user may send text messages.
|
|
can_send_audios:
|
|
type: boolean
|
|
description: True if the user may send audio messages.
|
|
can_send_documents:
|
|
type: boolean
|
|
description: True if the user may send document messages.
|
|
can_send_photos:
|
|
type: boolean
|
|
description: True if the user may send photos.
|
|
can_send_videos:
|
|
type: boolean
|
|
description: True if the user may send videos.
|
|
can_send_video_notes:
|
|
type: boolean
|
|
description: True if the user may send video notes.
|
|
can_send_voice_notes:
|
|
type: boolean
|
|
description: True if the user may send voice notes.
|
|
can_send_polls:
|
|
type: boolean
|
|
description: True if the user may send polls.
|
|
can_send_other_messages:
|
|
type: boolean
|
|
description: True if the user may send animations, games, stickers,
|
|
and use inline bots.
|
|
can_add_web_page_previews:
|
|
type: boolean
|
|
description: True if the user may add web page previews to messages.
|
|
can_change_info:
|
|
type: boolean
|
|
description: True if the user may change the chat title, photo,
|
|
and other settings.
|
|
can_invite_users:
|
|
type: boolean
|
|
description: True if the user may invite new users to the chat.
|
|
can_pin_messages:
|
|
type: boolean
|
|
description: True if the user may pin messages.
|
|
can_manage_topics:
|
|
type: boolean
|
|
description: True if the user may manage forum topics.
|
|
can_manage_video_chats:
|
|
type: boolean
|
|
description: True if the user may manage video chats.
|
|
can_post_stories:
|
|
type: boolean
|
|
description: True if the user may post stories.
|
|
can_edit_stories:
|
|
type: boolean
|
|
description: True if the user may edit stories.
|
|
can_delete_stories:
|
|
type: boolean
|
|
description: True if the user may delete stories.
|
|
additionalProperties: false
|
|
slow_mode_delay:
|
|
type: integer
|
|
description: Allowed delay between consecutive messages for non-administrators.
|
|
message_auto_delete_time:
|
|
type: integer
|
|
description: Time after which messages are automatically deleted.
|
|
has_protected_content:
|
|
type: boolean
|
|
description: True if content protection is enabled.
|
|
sticker_set_name:
|
|
type: string
|
|
description: Name of the group sticker set.
|
|
can_set_sticker_set:
|
|
type: boolean
|
|
description: True if the bot can change the group sticker set.
|
|
linked_chat_id:
|
|
type: integer
|
|
description: Identifier of the linked channel for supergroups.
|
|
location:
|
|
type: object
|
|
description: Location to which the supergroup is connected.
|
|
properties:
|
|
location:
|
|
type: object
|
|
description: Location coordinates of the chat.
|
|
additionalProperties: false
|
|
required:
|
|
- latitude
|
|
- longitude
|
|
properties:
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by the sender.
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by the sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: Radius of uncertainty for the location, in meters;
|
|
0-1500.
|
|
live_period:
|
|
type: integer
|
|
description: Time in seconds while the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which the user is moving, in degrees
|
|
1-360.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts about approaching
|
|
another chat member, in meters.
|
|
address:
|
|
type: string
|
|
description: Address of the location; 1-64 characters, as defined
|
|
by the sender.
|
|
additionalProperties: false
|
|
required:
|
|
- location
|
|
- address
|
|
has_hidden_members:
|
|
type: boolean
|
|
description: True if members are hidden in the chat.
|
|
has_aggressive_anti_spam_enabled:
|
|
type: boolean
|
|
description: True if aggressive anti-spam is enabled.
|
|
has_hidden_participants:
|
|
type: boolean
|
|
description: True if only admins can see other participants.
|
|
has_visible_history:
|
|
type: boolean
|
|
description: True if new members can see message history.
|
|
boost_level:
|
|
type: integer
|
|
description: Current boost level of the chat.
|
|
emoji_status_expiration_date:
|
|
type: integer
|
|
description: Expiration date of the emoji status in Unix time.
|
|
custom_emoji_sticker_set_name:
|
|
type: string
|
|
description: Name of the custom emoji sticker set used in the chat.
|
|
business_intro:
|
|
type: object
|
|
description: Business intro information for the chat.
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Localized title displayed in the business intro.
|
|
message:
|
|
type: string
|
|
description: Introductory message shown to customers.
|
|
sticker:
|
|
type: object
|
|
description: Sticker used in the business intro.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this sticker file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this sticker file.
|
|
emoji:
|
|
type: string
|
|
description: Emoji associated with the sticker.
|
|
type:
|
|
type: string
|
|
description: Sticker type, e.g. regular or custom_emoji.
|
|
width:
|
|
type: integer
|
|
description: Sticker width in pixels.
|
|
height:
|
|
type: integer
|
|
description: Sticker height in pixels.
|
|
is_animated:
|
|
type: boolean
|
|
description: True if the sticker is animated.
|
|
is_video:
|
|
type: boolean
|
|
description: True if the sticker is a video sticker.
|
|
additionalProperties: false
|
|
business_location:
|
|
type: object
|
|
description: Business location information for the chat.
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: Business address used for profile disclosure.
|
|
location:
|
|
type: object
|
|
description: Location coordinates of the chat.
|
|
additionalProperties: false
|
|
required:
|
|
- latitude
|
|
- longitude
|
|
properties:
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by the sender.
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by the sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: Radius of uncertainty for the location, in meters;
|
|
0-1500.
|
|
live_period:
|
|
type: integer
|
|
description: Time in seconds while the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which the user is moving, in degrees
|
|
1-360.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts about approaching
|
|
another chat member, in meters.
|
|
additionalProperties: false
|
|
business_opening_hours:
|
|
type: object
|
|
description: Business opening hours for the chat.
|
|
properties:
|
|
time_zone_name:
|
|
type: string
|
|
description: Time zone in IANA format that the business hours relate
|
|
to.
|
|
opening_hours:
|
|
type: array
|
|
description: Opening hour intervals within the week.
|
|
items:
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
opening_minute:
|
|
type: integer
|
|
description: Minute of the day when the business opens (0-1439).
|
|
closing_minute:
|
|
type: integer
|
|
description: Minute of the day when the business closes (0-1439).
|
|
opening_day:
|
|
type: integer
|
|
description: Day of week when the interval starts, 1 (Monday)
|
|
to 7 (Sunday).
|
|
closing_day:
|
|
type: integer
|
|
description: Day of week when the interval ends, 1 (Monday)
|
|
to 7 (Sunday).
|
|
additionalProperties: false
|
|
personal_chat:
|
|
type: object
|
|
description: Personal chat information if applicable.
|
|
properties:
|
|
chat_id:
|
|
type: integer
|
|
description: Identifier for the personal chat with the business.
|
|
user:
|
|
type: object
|
|
description: User that is part of this personal chat.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
additionalProperties: false
|
|
forward_origin:
|
|
type: object
|
|
description: Origin details for forwarded messages.
|
|
additionalProperties: false
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: 'Type of the origin: user, hidden_user, chat, channel,
|
|
message_link, or story.'
|
|
date:
|
|
type: integer
|
|
description: Date the original message was sent in Unix time.
|
|
sender_user:
|
|
type: object
|
|
description: User that originally sent the forwarded message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_user_name:
|
|
type: string
|
|
description: Name of the anonymous user that sent the forwarded message.
|
|
chat:
|
|
type: object
|
|
description: Chat that originally posted the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
message_id:
|
|
type: integer
|
|
description: Identifier of the original channel message.
|
|
author_signature:
|
|
type: string
|
|
description: Signature of the original channel message author.
|
|
has_protected_content:
|
|
type: boolean
|
|
description: True if the original message had protected content.
|
|
story:
|
|
type: object
|
|
description: Story that was forwarded.
|
|
additionalProperties: false
|
|
properties:
|
|
chat:
|
|
type: object
|
|
description: Chat that posted the story.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
id:
|
|
type: integer
|
|
description: Identifier of the story inside the chat.
|
|
message_link:
|
|
type: string
|
|
description: Link to the original message when available.
|
|
is_topic_message:
|
|
type: boolean
|
|
description: True if the message is a forum topic message.
|
|
is_automatic_forward:
|
|
type: boolean
|
|
description: True if the message is automatically forwarded.
|
|
reply_to_message:
|
|
type: object
|
|
description: Message that this message is replying to.
|
|
additionalProperties: false
|
|
properties:
|
|
message_id:
|
|
type: integer
|
|
description: Unique message identifier inside the chat.
|
|
message_thread_id:
|
|
type: integer
|
|
description: Identifier of the thread the message belongs to, for forum
|
|
topics.
|
|
date:
|
|
type: integer
|
|
description: Date the message was sent in Unix time.
|
|
chat:
|
|
type: object
|
|
description: Chat the message belongs to.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
from:
|
|
type: object
|
|
description: Sender of the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_chat:
|
|
type: object
|
|
description: Channel on behalf of which the message was sent.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
text:
|
|
type: string
|
|
description: Text of the message.
|
|
entities:
|
|
type: array
|
|
description: Special entities that appear in message text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
external_reply:
|
|
type: object
|
|
description: Information about the externally replied-to message.
|
|
additionalProperties: false
|
|
properties:
|
|
origin:
|
|
type: object
|
|
description: Details about the original message origin.
|
|
additionalProperties: false
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Origin type such as user, chat, channel, or message_link.
|
|
date:
|
|
type: integer
|
|
description: Date the original message was sent in Unix time.
|
|
sender_user:
|
|
type: object
|
|
description: Original message sender.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_user_name:
|
|
type: string
|
|
description: Name of the anonymous sender for hidden users.
|
|
chat:
|
|
type: object
|
|
description: Chat that originally posted the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
message_id:
|
|
type: integer
|
|
description: Identifier of the original channel message.
|
|
author_signature:
|
|
type: string
|
|
description: Signature of the channel message author.
|
|
story:
|
|
type: object
|
|
description: Story that was forwarded or replied to.
|
|
additionalProperties: false
|
|
properties:
|
|
chat:
|
|
type: object
|
|
description: Chat that posted the story.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private
|
|
chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
id:
|
|
type: integer
|
|
description: Identifier of the story inside the chat.
|
|
url:
|
|
type: string
|
|
description: Link to the original message when available.
|
|
chat:
|
|
type: object
|
|
description: Chat containing the replied-to message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
message_id:
|
|
type: integer
|
|
description: Identifier of the replied-to message.
|
|
link_preview_options:
|
|
type: object
|
|
description: Options used for link previews in messages.
|
|
additionalProperties: false
|
|
properties:
|
|
is_disabled:
|
|
type: boolean
|
|
description: True if the link preview is disabled.
|
|
url:
|
|
type: string
|
|
description: URL used for the preview if it differs from message
|
|
text.
|
|
prefer_small_media:
|
|
type: boolean
|
|
description: True if media with smaller dimensions should be shown
|
|
first.
|
|
prefer_large_media:
|
|
type: boolean
|
|
description: True if media with larger dimensions should be shown
|
|
first.
|
|
show_above_text:
|
|
type: boolean
|
|
description: True if the preview should be shown above the text
|
|
of the message.
|
|
location:
|
|
type: object
|
|
description: Geographical position information.
|
|
additionalProperties: true
|
|
properties:
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by sender.
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: The radius of uncertainty for the location.
|
|
live_period:
|
|
type: integer
|
|
description: Time during which the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which user is moving.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts.
|
|
photo:
|
|
type: array
|
|
description: Available sizes of the attached photo.
|
|
items:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
animation:
|
|
type: object
|
|
description: Animation file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique file identifier.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original animation filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
audio:
|
|
type: object
|
|
description: Audio file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
duration:
|
|
type: integer
|
|
description: Duration in seconds.
|
|
performer:
|
|
type: string
|
|
description: Performer of the audio.
|
|
title:
|
|
type: string
|
|
description: Track name.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
document: &id001
|
|
type: object
|
|
description: General file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
sticker:
|
|
type: object
|
|
description: Sticker included in the message.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
type:
|
|
type: string
|
|
description: Sticker type, e.g. regular or custom_emoji.
|
|
width:
|
|
type: integer
|
|
description: Sticker width in pixels.
|
|
height:
|
|
type: integer
|
|
description: Sticker height in pixels.
|
|
is_animated:
|
|
type: boolean
|
|
description: True if the sticker is animated.
|
|
is_video:
|
|
type: boolean
|
|
description: True if the sticker is a video sticker.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
emoji:
|
|
type: string
|
|
description: Emoji associated with the sticker.
|
|
set_name:
|
|
type: string
|
|
description: Name of the sticker set the sticker belongs to.
|
|
premium_animation:
|
|
type: object
|
|
description: Animation file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique file identifier.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original animation filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
mask_position:
|
|
type: object
|
|
description: For mask stickers, the position where the mask should
|
|
be placed.
|
|
additionalProperties: false
|
|
properties:
|
|
point:
|
|
type: string
|
|
description: Part of the face relative to which the mask is
|
|
placed.
|
|
x_shift:
|
|
type: number
|
|
description: Shift by the X axis measured in mask widths.
|
|
y_shift:
|
|
type: number
|
|
description: Shift by the Y axis measured in mask heights.
|
|
scale:
|
|
type: number
|
|
description: Mask scaling coefficient.
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of the custom emoji to which the sticker
|
|
corresponds.
|
|
needs_repainting:
|
|
type: boolean
|
|
description: True if the sticker must be repainted to match the
|
|
background.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
keywords:
|
|
type: array
|
|
description: List of search keywords for the sticker.
|
|
items:
|
|
type: string
|
|
video:
|
|
type: object
|
|
description: Video file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
video_note:
|
|
type: object
|
|
description: Video note information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
length:
|
|
type: integer
|
|
description: Diameter of the video message in pixels.
|
|
duration:
|
|
type: integer
|
|
description: Duration in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
voice:
|
|
type: object
|
|
description: Voice note information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
duration:
|
|
type: integer
|
|
description: Duration in seconds.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
has_media_spoiler:
|
|
type: boolean
|
|
description: True if the original message media was marked as spoilers.
|
|
quote:
|
|
type: object
|
|
description: Quoted part of a message that was replied to.
|
|
additionalProperties: false
|
|
properties:
|
|
text:
|
|
type: string
|
|
description: Quoted text.
|
|
entities:
|
|
type: array
|
|
description: Special entities that appear in the quote.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
position:
|
|
type: integer
|
|
description: Position of the quote in the original message text.
|
|
is_manual:
|
|
type: boolean
|
|
description: True if the quote was added manually.
|
|
translation:
|
|
type: object
|
|
description: Translated variant of the quote.
|
|
additionalProperties: false
|
|
properties:
|
|
text:
|
|
type: string
|
|
description: Translated quote text.
|
|
entities:
|
|
type: array
|
|
description: Entities found in the translated quote.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the
|
|
entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the
|
|
bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline
|
|
mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
reply_to_story:
|
|
type: object
|
|
description: Story that this message is replying to.
|
|
additionalProperties: false
|
|
properties:
|
|
chat:
|
|
type: object
|
|
description: Chat that posted the story.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
id:
|
|
type: integer
|
|
description: Identifier of the story inside the chat.
|
|
via_bot:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
edit_date:
|
|
type: integer
|
|
description: Date the message was last edited in Unix time.
|
|
has_protected_content:
|
|
type: boolean
|
|
description: True if the message is protected from forwarding and saving.
|
|
is_from_offline:
|
|
type: boolean
|
|
description: True if the message was sent via the bot's offline queue.
|
|
media_group_id:
|
|
type: string
|
|
description: Media group identifier.
|
|
author_signature:
|
|
type: string
|
|
description: Signature of the post author for channel messages.
|
|
text:
|
|
type: string
|
|
description: Text of the message.
|
|
entities:
|
|
type: array
|
|
description: Special entities in the message text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
link_preview_options:
|
|
type: object
|
|
description: Options used for link previews in messages.
|
|
additionalProperties: false
|
|
properties:
|
|
is_disabled:
|
|
type: boolean
|
|
description: True if the link preview is disabled.
|
|
url:
|
|
type: string
|
|
description: URL used for the preview if it differs from message text.
|
|
prefer_small_media:
|
|
type: boolean
|
|
description: True if media with smaller dimensions should be shown first.
|
|
prefer_large_media:
|
|
type: boolean
|
|
description: True if media with larger dimensions should be shown first.
|
|
show_above_text:
|
|
type: boolean
|
|
description: True if the preview should be shown above the text of the
|
|
message.
|
|
effect_id:
|
|
type: string
|
|
description: Unique identifier of the message effect.
|
|
animation:
|
|
type: object
|
|
description: Animation file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique file identifier.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original animation filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
audio:
|
|
type: object
|
|
description: Audio file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
duration:
|
|
type: integer
|
|
description: Duration in seconds.
|
|
performer:
|
|
type: string
|
|
description: Performer of the audio.
|
|
title:
|
|
type: string
|
|
description: Track name.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
document:
|
|
type: object
|
|
description: General file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
paid_media:
|
|
type: object
|
|
description: Information about paid media attached to the message.
|
|
additionalProperties: false
|
|
properties:
|
|
star_count:
|
|
type: integer
|
|
description: Number of Telegram Stars required to unlock the media.
|
|
paid_media:
|
|
type: array
|
|
description: Collection of paid media objects included with the message.
|
|
items:
|
|
type: object
|
|
description: Single paid media item.
|
|
additionalProperties: false
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the paid media, such as photo or video.
|
|
photo:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
video:
|
|
type: object
|
|
description: Video file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
description:
|
|
type: string
|
|
description: Optional caption describing the paid media package.
|
|
photo:
|
|
type: array
|
|
description: Available sizes of the photo.
|
|
items:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
sticker:
|
|
type: object
|
|
description: Sticker included in the message.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
type:
|
|
type: string
|
|
description: Sticker type, e.g. regular or custom_emoji.
|
|
width:
|
|
type: integer
|
|
description: Sticker width in pixels.
|
|
height:
|
|
type: integer
|
|
description: Sticker height in pixels.
|
|
is_animated:
|
|
type: boolean
|
|
description: True if the sticker is animated.
|
|
is_video:
|
|
type: boolean
|
|
description: True if the sticker is a video sticker.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
emoji:
|
|
type: string
|
|
description: Emoji associated with the sticker.
|
|
set_name:
|
|
type: string
|
|
description: Name of the sticker set the sticker belongs to.
|
|
premium_animation:
|
|
type: object
|
|
description: Animation file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique file identifier.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original animation filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
mask_position:
|
|
type: object
|
|
description: For mask stickers, the position where the mask should be
|
|
placed.
|
|
additionalProperties: false
|
|
properties:
|
|
point:
|
|
type: string
|
|
description: Part of the face relative to which the mask is placed.
|
|
x_shift:
|
|
type: number
|
|
description: Shift by the X axis measured in mask widths.
|
|
y_shift:
|
|
type: number
|
|
description: Shift by the Y axis measured in mask heights.
|
|
scale:
|
|
type: number
|
|
description: Mask scaling coefficient.
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of the custom emoji to which the sticker corresponds.
|
|
needs_repainting:
|
|
type: boolean
|
|
description: True if the sticker must be repainted to match the background.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
keywords:
|
|
type: array
|
|
description: List of search keywords for the sticker.
|
|
items:
|
|
type: string
|
|
story:
|
|
type: object
|
|
description: Story attached to the message.
|
|
additionalProperties: false
|
|
properties:
|
|
chat:
|
|
type: object
|
|
description: Chat that posted the story.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
id:
|
|
type: integer
|
|
description: Identifier of the story inside the chat.
|
|
video:
|
|
type: object
|
|
description: Video file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
video_note:
|
|
type: object
|
|
description: Video note information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
length:
|
|
type: integer
|
|
description: Diameter of the video message in pixels.
|
|
duration:
|
|
type: integer
|
|
description: Duration in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
voice:
|
|
type: object
|
|
description: Voice note information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
duration:
|
|
type: integer
|
|
description: Duration in seconds.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
caption:
|
|
type: string
|
|
description: Caption for the animation, audio, document, photo, or video.
|
|
caption_entities:
|
|
type: array
|
|
description: Special entities in the caption.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
show_caption_above_media:
|
|
type: boolean
|
|
description: True if the caption should be shown above the media.
|
|
has_media_spoiler:
|
|
type: boolean
|
|
description: True if the message has a spoiler animation.
|
|
contact:
|
|
type: object
|
|
description: Contact information shared with the bot.
|
|
additionalProperties: true
|
|
properties:
|
|
phone_number:
|
|
type: string
|
|
description: Contact phone number.
|
|
first_name:
|
|
type: string
|
|
description: Contact first name.
|
|
last_name:
|
|
type: string
|
|
description: Contact last name.
|
|
user_id:
|
|
type: integer
|
|
description: Telegram user identifier if available.
|
|
vcard:
|
|
type: string
|
|
description: Additional data about the contact in vCard format.
|
|
dice:
|
|
type: object
|
|
description: Animated emoji with random value.
|
|
additionalProperties: true
|
|
properties:
|
|
emoji:
|
|
type: string
|
|
description: Emoji on which the dice throw animation is based.
|
|
value:
|
|
type: integer
|
|
description: Value of the dice.
|
|
game:
|
|
type: object
|
|
description: Telegram game shared in the message.
|
|
additionalProperties: false
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Title of the game.
|
|
description:
|
|
type: string
|
|
description: Game description.
|
|
photo:
|
|
type: array
|
|
description: Available sizes of the game photo.
|
|
items:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
text:
|
|
type: string
|
|
description: Brief description of the game or high score text.
|
|
text_entities:
|
|
type: array
|
|
description: Special entities that appear in the game description text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
animation:
|
|
type: object
|
|
description: Animation file information.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique file identifier.
|
|
width:
|
|
type: integer
|
|
description: Video width.
|
|
height:
|
|
type: integer
|
|
description: Video height.
|
|
duration:
|
|
type: integer
|
|
description: Duration of the video in seconds.
|
|
thumbnail:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
file_name:
|
|
type: string
|
|
description: Original animation filename.
|
|
mime_type:
|
|
type: string
|
|
description: MIME type of the file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
poll:
|
|
type: object
|
|
description: Poll information.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Unique poll identifier.
|
|
question:
|
|
type: string
|
|
description: Poll question.
|
|
options:
|
|
type: array
|
|
description: List of poll options.
|
|
items:
|
|
type: object
|
|
description: Information about one answer option in a poll.
|
|
additionalProperties: false
|
|
properties:
|
|
text:
|
|
type: string
|
|
description: Option text, 1-100 characters.
|
|
text_entities:
|
|
type: array
|
|
description: Special entities that appear in the option text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of
|
|
the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot
|
|
API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium
|
|
subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the
|
|
bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline
|
|
mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram
|
|
Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for
|
|
"pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
voter_count:
|
|
type: integer
|
|
description: Number of users that voted for this option.
|
|
total_voter_count:
|
|
type: integer
|
|
description: Total number of users that voted in the poll.
|
|
is_closed:
|
|
type: boolean
|
|
description: True if the poll is closed.
|
|
is_anonymous:
|
|
type: boolean
|
|
description: True if the poll is anonymous.
|
|
type:
|
|
type: string
|
|
description: Poll type, currently "regular" or "quiz".
|
|
allows_multiple_answers:
|
|
type: boolean
|
|
description: True if the poll allows multiple answers.
|
|
correct_option_id:
|
|
type: integer
|
|
description: 0-based identifier of the correct option for quiz-style
|
|
polls.
|
|
explanation:
|
|
type: string
|
|
description: Text that is shown when a user chooses an incorrect answer
|
|
or taps the lamp icon.
|
|
open_period:
|
|
type: integer
|
|
description: Amount of time in seconds the poll will be active after
|
|
creation.
|
|
close_date:
|
|
type: integer
|
|
description: Point in time when the poll will be automatically closed.
|
|
venue:
|
|
type: object
|
|
description: Venue information.
|
|
additionalProperties: true
|
|
properties:
|
|
location:
|
|
type: object
|
|
description: Geographical position information.
|
|
additionalProperties: true
|
|
properties:
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by sender.
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: The radius of uncertainty for the location.
|
|
live_period:
|
|
type: integer
|
|
description: Time during which the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which user is moving.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts.
|
|
title:
|
|
type: string
|
|
description: Name of the venue.
|
|
address:
|
|
type: string
|
|
description: Address of the venue.
|
|
foursquare_id:
|
|
type: string
|
|
description: Foursquare identifier of the venue.
|
|
foursquare_type:
|
|
type: string
|
|
description: Type of the venue in Foursquare.
|
|
google_place_id:
|
|
type: string
|
|
description: Google Places identifier of the venue.
|
|
google_place_type:
|
|
type: string
|
|
description: Type of the venue in Google Places.
|
|
location:
|
|
type: object
|
|
description: Geographical position information.
|
|
additionalProperties: true
|
|
properties:
|
|
longitude:
|
|
type: number
|
|
description: Longitude as defined by sender.
|
|
latitude:
|
|
type: number
|
|
description: Latitude as defined by sender.
|
|
horizontal_accuracy:
|
|
type: number
|
|
description: The radius of uncertainty for the location.
|
|
live_period:
|
|
type: integer
|
|
description: Time during which the location can be updated.
|
|
heading:
|
|
type: integer
|
|
description: Direction in which user is moving.
|
|
proximity_alert_radius:
|
|
type: integer
|
|
description: Maximum distance for proximity alerts.
|
|
new_chat_members:
|
|
type: array
|
|
description: New members that were added to the group.
|
|
items:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
left_chat_member:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
new_chat_title:
|
|
type: string
|
|
description: New chat title if it was changed.
|
|
new_chat_photo:
|
|
type: array
|
|
description: New chat photo.
|
|
items:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
delete_chat_photo:
|
|
type: boolean
|
|
description: True if the chat photo was deleted.
|
|
group_chat_created:
|
|
type: boolean
|
|
description: True if the group has been created.
|
|
supergroup_chat_created:
|
|
type: boolean
|
|
description: True if the supergroup has been created.
|
|
channel_chat_created:
|
|
type: boolean
|
|
description: True if the channel has been created.
|
|
message_auto_delete_timer_changed:
|
|
type: object
|
|
description: Service message about message auto-delete timer changed.
|
|
properties:
|
|
message_auto_delete_time:
|
|
type: integer
|
|
description: New auto-delete time for messages in the chat, in seconds.
|
|
additionalProperties: false
|
|
migrate_to_chat_id:
|
|
type: integer
|
|
description: Identifier of the supergroup the chat migrated to.
|
|
migrate_from_chat_id:
|
|
type: integer
|
|
description: Identifier of the chat the supergroup migrated from.
|
|
pinned_message:
|
|
type: object
|
|
description: Pinned message in the chat.
|
|
additionalProperties: false
|
|
properties:
|
|
message_id:
|
|
type: integer
|
|
description: Unique message identifier inside the chat.
|
|
message_thread_id:
|
|
type: integer
|
|
description: Identifier of the thread the message belongs to, for forum
|
|
topics.
|
|
date:
|
|
type: integer
|
|
description: Date the message was sent in Unix time.
|
|
chat:
|
|
type: object
|
|
description: Chat the message belongs to.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
from:
|
|
type: object
|
|
description: Sender of the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_chat:
|
|
type: object
|
|
description: Channel on behalf of which the message was sent.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup, or
|
|
channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
text:
|
|
type: string
|
|
description: Text of the message.
|
|
entities:
|
|
type: array
|
|
description: Special entities that appear in message text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
invoice:
|
|
type: object
|
|
description: Invoice issued by the bot.
|
|
additionalProperties: false
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Product name.
|
|
description:
|
|
type: string
|
|
description: Product description.
|
|
start_parameter:
|
|
type: string
|
|
description: Unique bot deep-linking parameter for this invoice.
|
|
currency:
|
|
type: string
|
|
description: Three-letter ISO 4217 currency code.
|
|
total_amount:
|
|
type: integer
|
|
description: Total price in the smallest units of the currency.
|
|
successful_payment:
|
|
type: object
|
|
description: Information about a successful payment.
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
type: string
|
|
description: Three-letter ISO 4217 currency code.
|
|
total_amount:
|
|
type: integer
|
|
description: Total price in the smallest units of the currency.
|
|
invoice_payload:
|
|
type: string
|
|
description: Bot specified invoice payload.
|
|
shipping_option_id:
|
|
type: string
|
|
description: Identifier of the shipping option chosen by the user.
|
|
order_info:
|
|
type: object
|
|
description: Order info provided by the user.
|
|
additionalProperties: false
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: User name.
|
|
phone_number:
|
|
type: string
|
|
description: User phone number.
|
|
email:
|
|
type: string
|
|
description: User email address.
|
|
shipping_address:
|
|
type: object
|
|
description: Shipping address for the order.
|
|
additionalProperties: false
|
|
properties:
|
|
country_code:
|
|
type: string
|
|
description: ISO 3166-1 alpha-2 country code.
|
|
state:
|
|
type: string
|
|
description: State or region.
|
|
city:
|
|
type: string
|
|
description: City.
|
|
street_line1:
|
|
type: string
|
|
description: First line for the address.
|
|
street_line2:
|
|
type: string
|
|
description: Second line for the address.
|
|
post_code:
|
|
type: string
|
|
description: Postcode of the address.
|
|
telegram_payment_charge_id:
|
|
type: string
|
|
description: Telegram payment identifier.
|
|
provider_payment_charge_id:
|
|
type: string
|
|
description: Provider payment identifier.
|
|
subscription_period:
|
|
type: integer
|
|
description: Subscription period in seconds for recurring payments.
|
|
refunded_payment:
|
|
type: object
|
|
description: Information about a refunded payment.
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
type: string
|
|
description: Three-letter ISO 4217 currency code.
|
|
total_amount:
|
|
type: integer
|
|
description: Total refunded amount in the smallest currency units.
|
|
invoice_payload:
|
|
type: string
|
|
description: Bot specified invoice payload.
|
|
telegram_payment_charge_id:
|
|
type: string
|
|
description: Telegram payment identifier.
|
|
provider_payment_charge_id:
|
|
type: string
|
|
description: Provider payment identifier.
|
|
users_shared:
|
|
type: object
|
|
description: Information about users shared with the bot.
|
|
additionalProperties: false
|
|
properties:
|
|
request_id:
|
|
type: integer
|
|
description: Identifier of the request that triggered the share.
|
|
users:
|
|
type: array
|
|
description: List of shared users.
|
|
items:
|
|
type: object
|
|
description: User shared with the bot.
|
|
additionalProperties: false
|
|
properties:
|
|
user_id:
|
|
type: integer
|
|
description: Identifier of the shared user.
|
|
first_name:
|
|
type: string
|
|
description: First name of the shared user.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the shared user.
|
|
username:
|
|
type: string
|
|
description: Username of the shared user.
|
|
photo:
|
|
type: array
|
|
description: Available sizes of the user photo.
|
|
items:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
chat_shared:
|
|
type: object
|
|
description: Information about a chat shared with the bot.
|
|
additionalProperties: false
|
|
properties:
|
|
request_id:
|
|
type: integer
|
|
description: Identifier of the request that triggered the share.
|
|
chat_id:
|
|
type: integer
|
|
description: Identifier of the shared chat.
|
|
title:
|
|
type: string
|
|
description: Title of the shared chat.
|
|
username:
|
|
type: string
|
|
description: Username of the shared chat, if available.
|
|
photo:
|
|
type: array
|
|
description: Available sizes of the chat photo.
|
|
items:
|
|
type: object
|
|
description: Size of a photo or a file / sticker thumbnail.
|
|
additionalProperties: true
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
width:
|
|
type: integer
|
|
description: Photo width.
|
|
height:
|
|
type: integer
|
|
description: Photo height.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
connected_website:
|
|
type: string
|
|
description: The domain name of the website on which the user has logged
|
|
in.
|
|
write_access_allowed:
|
|
type: object
|
|
description: Service message about the bot being granted write access.
|
|
additionalProperties: false
|
|
properties:
|
|
from_request:
|
|
type: boolean
|
|
description: True if granted after the user pressed an allow write access
|
|
button.
|
|
from_attachment_menu:
|
|
type: boolean
|
|
description: True if the bot was added to the attachment menu.
|
|
web_app_name:
|
|
type: string
|
|
description: Name of the Web App that was launched to grant access.
|
|
passport_data:
|
|
type: object
|
|
description: Telegram Passport data provided by the user.
|
|
additionalProperties: false
|
|
properties:
|
|
data:
|
|
type: array
|
|
description: Encrypted Telegram Passport elements.
|
|
items:
|
|
type: object
|
|
description: Single encrypted passport element.
|
|
additionalProperties: false
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the element.
|
|
data:
|
|
type: string
|
|
description: Base64-encoded encrypted data.
|
|
phone_number:
|
|
type: string
|
|
description: User phone number.
|
|
email:
|
|
type: string
|
|
description: User email address.
|
|
files:
|
|
type: array
|
|
description: Encrypted files with the document scans.
|
|
items:
|
|
type: object
|
|
description: Encrypted passport file.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
front_side:
|
|
type: object
|
|
description: Document front side.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
reverse_side:
|
|
type: object
|
|
description: Document reverse side.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
selfie:
|
|
type: object
|
|
description: Selfie with the document.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
translation:
|
|
type: array
|
|
description: Translated document files.
|
|
items:
|
|
type: object
|
|
description: Translated document file.
|
|
additionalProperties: false
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
description: Identifier for this file.
|
|
file_unique_id:
|
|
type: string
|
|
description: Unique identifier for this file.
|
|
file_size:
|
|
type: integer
|
|
description: File size in bytes.
|
|
hash:
|
|
type: string
|
|
description: Base64-encoded element hash for verification.
|
|
credentials:
|
|
type: object
|
|
description: Encrypted credentials required to decrypt Telegram Passport
|
|
data.
|
|
additionalProperties: false
|
|
properties:
|
|
data:
|
|
type: string
|
|
description: Base64-encoded encrypted JSON-serialized data.
|
|
hash:
|
|
type: string
|
|
description: Base64-encoded data hash for verification.
|
|
secret:
|
|
type: string
|
|
description: Base64-encoded secret used for data decryption.
|
|
proximity_alert_triggered:
|
|
type: object
|
|
description: Service message for proximity alert triggers.
|
|
additionalProperties: false
|
|
properties:
|
|
traveler:
|
|
type: object
|
|
description: User that triggered the alert.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
watcher:
|
|
type: object
|
|
description: User set to receive the alert.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
distance:
|
|
type: integer
|
|
description: Distance between the users in meters.
|
|
boost_added:
|
|
type: object
|
|
description: Service message about a boost added to the chat.
|
|
additionalProperties: false
|
|
properties:
|
|
boost_count:
|
|
type: integer
|
|
description: Number of boosts added by the user.
|
|
chat_background_set:
|
|
type: object
|
|
description: Chat background configuration.
|
|
additionalProperties: false
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of background, such as fill or wallpaper.
|
|
dark_theme_dimming:
|
|
type: integer
|
|
description: Dark theme dimming level applied to the background (0-100).
|
|
document: *id001
|
|
forum_topic_created:
|
|
type: object
|
|
description: Service message about a forum topic created.
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of the topic.
|
|
icon_color:
|
|
type: integer
|
|
description: Color of the topic icon in RGB format.
|
|
icon_custom_emoji_id:
|
|
type: string
|
|
description: Identifier of the custom emoji shown as the topic icon.
|
|
additionalProperties: false
|
|
forum_topic_edited:
|
|
type: object
|
|
description: Service message about a forum topic edited.
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: New name of the topic.
|
|
icon_custom_emoji_id:
|
|
type: string
|
|
description: Identifier of the new custom emoji shown as the topic icon.
|
|
additionalProperties: false
|
|
forum_topic_closed:
|
|
type: object
|
|
description: Service message about a forum topic closed.
|
|
properties: {}
|
|
additionalProperties: false
|
|
forum_topic_reopened:
|
|
type: object
|
|
description: Service message about a forum topic reopened.
|
|
properties: {}
|
|
additionalProperties: false
|
|
general_forum_topic_hidden:
|
|
type: object
|
|
description: Service message about the general forum topic hidden.
|
|
properties: {}
|
|
additionalProperties: false
|
|
general_forum_topic_unhidden:
|
|
type: object
|
|
description: Service message about the general forum topic unhidden.
|
|
properties: {}
|
|
additionalProperties: false
|
|
giveaway_created:
|
|
type: object
|
|
description: Service message about a giveaway that was created.
|
|
additionalProperties: false
|
|
properties:
|
|
start_date:
|
|
type: integer
|
|
description: Giveaway start date in Unix time.
|
|
end_date:
|
|
type: integer
|
|
description: Giveaway end date in Unix time.
|
|
winner_count:
|
|
type: integer
|
|
description: Number of winners that will be selected.
|
|
prize_star_count:
|
|
type: integer
|
|
description: Number of Telegram Stars granted to each winner, if applicable.
|
|
prize_description:
|
|
type: string
|
|
description: Description of the prize.
|
|
giveaway:
|
|
type: object
|
|
description: Active giveaway details.
|
|
additionalProperties: false
|
|
properties:
|
|
prize_star_count:
|
|
type: integer
|
|
description: Number of Telegram Stars awarded to each winner, if any.
|
|
prize_description:
|
|
type: string
|
|
description: Custom prize description shown to participants.
|
|
country_codes:
|
|
type: array
|
|
description: ISO 3166-1 alpha-2 country codes allowed to participate.
|
|
items:
|
|
type: string
|
|
start_date:
|
|
type: integer
|
|
description: Giveaway start date as Unix time.
|
|
end_date:
|
|
type: integer
|
|
description: Giveaway end date as Unix time.
|
|
winner_count:
|
|
type: integer
|
|
description: Number of winners that will be selected.
|
|
premium_subscription_month_count:
|
|
type: integer
|
|
description: Number of Telegram Premium months granted as a prize.
|
|
giveaway_winners:
|
|
type: object
|
|
description: Information about giveaway winners.
|
|
additionalProperties: false
|
|
properties:
|
|
giveaway_message:
|
|
type: object
|
|
description: Original giveaway message.
|
|
additionalProperties: false
|
|
properties:
|
|
message_id:
|
|
type: integer
|
|
description: Unique message identifier inside the chat.
|
|
message_thread_id:
|
|
type: integer
|
|
description: Identifier of the thread the message belongs to, for
|
|
forum topics.
|
|
date:
|
|
type: integer
|
|
description: Date the message was sent in Unix time.
|
|
chat:
|
|
type: object
|
|
description: Chat the message belongs to.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
from:
|
|
type: object
|
|
description: Sender of the message.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
sender_chat:
|
|
type: object
|
|
description: Channel on behalf of which the message was sent.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this chat.
|
|
type:
|
|
type: string
|
|
description: Type of chat, such as private, group, supergroup,
|
|
or channel.
|
|
title:
|
|
type: string
|
|
description: Chat title for supergroups, channels, and group
|
|
chats.
|
|
username:
|
|
type: string
|
|
description: Username of the chat if available.
|
|
first_name:
|
|
type: string
|
|
description: First name of the other party in a private chat.
|
|
last_name:
|
|
type: string
|
|
description: Last name of the other party in a private chat.
|
|
text:
|
|
type: string
|
|
description: Text of the message.
|
|
entities:
|
|
type: array
|
|
description: Special entities that appear in message text.
|
|
items:
|
|
type: object
|
|
description: Special entity in a text message.
|
|
additionalProperties: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the entity.
|
|
offset:
|
|
type: integer
|
|
description: Offset in UTF-16 code units to the start of the
|
|
entity.
|
|
length:
|
|
type: integer
|
|
description: Length of the entity in UTF-16 code units.
|
|
url:
|
|
type: string
|
|
description: URL for "text_link" entity.
|
|
user:
|
|
type: object
|
|
description: Telegram User object as defined in the Bot API.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the
|
|
bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline
|
|
mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
language:
|
|
type: string
|
|
description: Programming language of the entity text for "pre".
|
|
custom_emoji_id:
|
|
type: string
|
|
description: Identifier of a custom emoji.
|
|
winners:
|
|
type: array
|
|
description: Users who won the giveaway.
|
|
items:
|
|
type: object
|
|
description: Winner information.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
additional_chat_count:
|
|
type: integer
|
|
description: Number of additional chats the user had to join to participate.
|
|
prize_star_count:
|
|
type: integer
|
|
description: Number of Telegram Stars awarded to each winner, if applicable.
|
|
premium_subscription_month_count:
|
|
type: integer
|
|
description: Telegram Premium subscription duration granted, in months.
|
|
unclaimed_prize_count:
|
|
type: integer
|
|
description: Number of prizes that were not claimed by winners.
|
|
giveaway_completed:
|
|
type: object
|
|
description: Summary of a completed giveaway.
|
|
additionalProperties: false
|
|
properties:
|
|
winner_count:
|
|
type: integer
|
|
description: Number of winners selected.
|
|
unclaimed_prize_count:
|
|
type: integer
|
|
description: Number of prizes that remained unclaimed.
|
|
prize_star_count:
|
|
type: integer
|
|
description: Telegram Star prize for each winner, if applicable.
|
|
premium_subscription_month_count:
|
|
type: integer
|
|
description: Premium subscription duration for each winner, in months.
|
|
video_chat_scheduled:
|
|
type: object
|
|
description: Information about a scheduled video chat.
|
|
additionalProperties: false
|
|
properties:
|
|
start_date:
|
|
type: integer
|
|
description: Point in time (Unix) when the video chat is supposed to
|
|
start.
|
|
video_chat_started:
|
|
type: object
|
|
description: Service message about a started video chat.
|
|
additionalProperties: false
|
|
properties:
|
|
date:
|
|
type: integer
|
|
description: Start date of the video chat in Unix time.
|
|
video_chat_ended:
|
|
type: object
|
|
description: Service message about an ended video chat.
|
|
additionalProperties: false
|
|
properties:
|
|
duration:
|
|
type: integer
|
|
description: Video chat duration in seconds.
|
|
video_chat_participants_invited:
|
|
type: object
|
|
description: Service message about invited video chat participants.
|
|
additionalProperties: false
|
|
properties:
|
|
users:
|
|
type: array
|
|
description: Users that were invited to the video chat.
|
|
items:
|
|
type: object
|
|
description: Invited user information.
|
|
additionalProperties: true
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for this user or bot.
|
|
is_bot:
|
|
type: boolean
|
|
description: True if this user is a bot.
|
|
first_name:
|
|
type: string
|
|
description: User first name.
|
|
last_name:
|
|
type: string
|
|
description: User last name.
|
|
username:
|
|
type: string
|
|
description: Username of the user, if any.
|
|
language_code:
|
|
type: string
|
|
description: IETF language tag of the user's language.
|
|
is_premium:
|
|
type: boolean
|
|
description: True if the user is a Telegram Premium subscriber.
|
|
added_to_attachment_menu:
|
|
type: boolean
|
|
description: True if the user added the bot to the attachment
|
|
menu.
|
|
can_join_groups:
|
|
type: boolean
|
|
description: True if the bot can join groups.
|
|
can_read_all_group_messages:
|
|
type: boolean
|
|
description: True if privacy mode is disabled for the bot.
|
|
supports_inline_queries:
|
|
type: boolean
|
|
description: True if the bot can be invited to inline mode.
|
|
can_connect_to_business:
|
|
type: boolean
|
|
description: True if the bot can connect to Telegram Business
|
|
accounts.
|
|
has_main_web_app:
|
|
type: boolean
|
|
description: True if the bot has a main Web App.
|
|
web_app_data:
|
|
type: object
|
|
description: Data sent from a Web App.
|
|
additionalProperties: false
|
|
properties:
|
|
data:
|
|
type: string
|
|
description: The data sent from the Web App.
|
|
button_text:
|
|
type: string
|
|
description: Text of the web_app keyboard button pressed by the user.
|
|
reply_markup:
|
|
type: object
|
|
description: Inline keyboard attached to the message.
|
|
additionalProperties: false
|
|
properties:
|
|
inline_keyboard:
|
|
type: array
|
|
description: Rows of inline keyboard buttons.
|
|
items:
|
|
type: array
|
|
description: Single row of inline keyboard buttons.
|
|
items:
|
|
type: object
|
|
description: Inline keyboard button definition.
|
|
additionalProperties: false
|
|
properties:
|
|
text:
|
|
type: string
|
|
description: Label text on the button.
|
|
url:
|
|
type: string
|
|
description: HTTP URL opened when the button is pressed.
|
|
callback_data:
|
|
type: string
|
|
description: Data sent in a callback query to the bot when button
|
|
pressed.
|
|
web_app:
|
|
type: object
|
|
description: Description of the Web App launched when the button
|
|
is pressed.
|
|
additionalProperties: false
|
|
properties:
|
|
url:
|
|
type: string
|
|
description: HTTPS URL of the Web App to open.
|
|
login_url:
|
|
type: object
|
|
description: Login URL for authorization.
|
|
additionalProperties: false
|
|
properties:
|
|
url:
|
|
type: string
|
|
description: HTTP URL used for user authorization.
|
|
forward_text:
|
|
type: string
|
|
description: New text of the button in forwarded messages.
|
|
bot_username:
|
|
type: string
|
|
description: Username of a bot for user authorization.
|
|
request_write_access:
|
|
type: boolean
|
|
description: True if the bot may send messages to the user.
|
|
switch_inline_query:
|
|
type: string
|
|
description: Inline query inserted in the input field when the
|
|
button is pressed.
|
|
switch_inline_query_current_chat:
|
|
type: string
|
|
description: Inline query inserted in the current chat when
|
|
the button is pressed.
|
|
switch_inline_query_chosen_chat:
|
|
type: object
|
|
description: Inline query switching to a chosen chat.
|
|
additionalProperties: false
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Default inline query to use.
|
|
allow_user_chats:
|
|
type: boolean
|
|
description: True to allow selection of private chats.
|
|
allow_bot_chats:
|
|
type: boolean
|
|
description: True to allow selection of bot chats.
|
|
allow_group_chats:
|
|
type: boolean
|
|
description: True to allow selection of group chats.
|
|
allow_channel_chats:
|
|
type: boolean
|
|
description: True to allow selection of channel chats.
|
|
callback_game:
|
|
type: object
|
|
description: Description of a game launched when the user presses
|
|
the button.
|
|
additionalProperties: false
|
|
properties: {}
|
|
pay:
|
|
type: boolean
|
|
description: True if a Pay button that displays the invoice
|
|
is pressed.
|
|
extra:
|
|
python:
|
|
source: events/messages/message_edited.py
|